Skip to main content
GET
curl
List the faces, identity documents, phone numbers and email addresses of your verification sessions that are currently blocklisted, newest first. Each item points to the session it came from, so you can open it in the console or fetch its decision. This feed shows what was blocklisted from a session: with Add to blocklist, from the console, or with a list entry created from reference_session_id. Values typed into a list, uploaded faces, faces taken from a document-capture selfie and the other entry types (IP address, device fingerprint, wallet, bank account, user, business) live only in the system blocklists: read them with List entries. See Blocklist users for how blocklisting works in the console.

Authorizations

x-api-key
string
header
required

Your application's API key, from Developers -> API keys in the Business Console. The primary key has full access. A named key can be scoped: none, read or write per resource, limited to some workflows or to approved sessions, to a list of IP addresses, and to an expiry date. 401 means the key is missing, wrong, revoked or expired; 403 means the key has no access to this resource or action, or the request came from an address outside its IP list; 404 on a session route means the session is outside the key's workflows or statuses. A key without media access receives image, video and PDF URLs as null, and a key without sessions write receives session links and tokens as null. See https://docs.didit.me/console/api-keys.

Query Parameters

item_type
enum<string>

Only items of this type. When omitted, every type is returned.

Available options:
face,
document,
phone,
email
limit
integer
default:50

Page size. Defaults to 50. A value above 1000000 returns 400; zero, a negative or a non-numeric value falls back to 50.

Required range: 1 <= x <= 1000000
offset
integer
default:0

Zero-based index of the first item to return. Prefer following next. A value above 1000000 returns 400; a negative or non-numeric value falls back to 0.

Required range: 0 <= x <= 1000000

Response

A page of blocklisted items, newest first.

count
integer
required

Total number of blocklisted items matching the filters.

Required range: x >= 0
next
string<uri> | null
required

Absolute URL of the next page, or null on the last page.

previous
string<uri> | null
required

Absolute URL of the previous page, or null on the first page.

results
object[]
required