Skip to main content
The Lists API lets you manage typed lists for your application. System blocklists are automatically created and checked during verification and transaction screening. You can also create allowlists and custom lists for workflow conditions.

​
Concepts

TypeDescription
BlocklistSystem-created, one per entry type. Items in a blocklist cause automatic decline during verification or transaction screening.
AllowlistUser-created. Used in workflow conditions to approve or fast-track matching items.
CustomUser-created. Flexible lists for workflow branching, monitoring rules, or manual review.

​
Entry types

Entry typeChecked duringOn match
faceLiveness verificationSession declined
documentID verification (OCR)Session declined
phonePhone verificationSession declined
emailEmail verificationSession declined
ip_addressIP analysis (supports CIDR ranges)Session declined
device_fingerprintIP analysisSession declined
wallet_addressTransaction screeningTransaction declined
bank_accountTransaction screeningTransaction declined
userTransaction screeningUser blocked
businessTransaction screeningBusiness blocked
countryWorkflow conditionsConfigurable
keyCustom useConfigurable

​
System blocklists

Every application automatically gets 10 system blocklists (one per supported entry type). These cannot be deleted or renamed. You can add entries to them via the API or from the console.

​
Traceability

Every blocklist entry can be linked back to its source entity so you can navigate from the list to the original record:
  • From a session — pass reference_session_id when creating an entry. Didit auto-extracts the value (face, document, phone, email, IP, or device), marks the underlying model as blocklisted, and links the entry back to the session. If the session has multiple instances of the same type, also pass value to disambiguate.
  • From a transaction, user, or business — pass reference_object_uuid with the entity’s UUID and include metadata.reference_type ("transaction", "vendor_user", or "vendor_business") so the console can link back to the original record.

​
Endpoints

List all lists

Retrieve all lists for an application.

List entries

Retrieve entries in a list.

Create entry

Add a value to a blocklist — by value, session reference, or transaction reference.

Delete entry

Remove an entry and unblock the underlying entity.

Upload face

Upload a face image directly to a face blocklist.