Skip to main content
POST
curl
Blocklist what one verification session collected: its face, identity document, phone number or email address. Didit flags each selected record as blocklisted and adds it to the matching system blocklist, linked to the session. New sessions with a matching face, document number, phone number or email address are declined from then on.
The call is all-or-nothing: if the session has no record of a selected type, or the document lacks its issuing state, document type, document number or full name, it returns 400 and nothing is blocklisted. Repeating the call for an item that is already blocklisted is safe.
To check what is blocked, use List blocklisted items. To lift a block, use Remove from blocklist. To block an IP address, device fingerprint, user, business or a value without a session, add an entry to the matching system blocklist with Create entry. See User blocklist for how blocklists are enforced.

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.

Body

application/json

At least one blocklist_* flag must be true.

session_id
string<uuid>
required

A person verification session of your application. Deleted sessions are refused.

blocklist_face
boolean
default:false

Blocklist the session's face.

blocklist_document
boolean
default:false

Blocklist the session's identity document. The document needs its issuing state, document type, document number and full name.

blocklist_phone
boolean
default:false

Blocklist the session's phone number.

blocklist_email
boolean
default:false

Blocklist the session's email address.

Response

The selected items were blocklisted.

message
string
required

Always Successfully updated blocklist.