Sign in
ClientListApiAgentResource

Create a client list

Creates an empty client list. When name is omitted it is derived from title; pass name explicitly when the title has letters outside the Latin alphabet. name, type and entryType cannot be changed after creation. A list of entryType key can only be of type custom. A list of entryType deviceId requires Device Intelligence to be enabled.

post/resources/api/agent/clientLists

Request body

descstring

Free-text description of the list.

entryTypestring required

Kind of key the list holds: key, applicant, email, phone, deviceId or ipRange. deviceId requires Device Intelligence to be enabled. Cannot be changed later.

namestring

Name that rules reference the list by. Lowercase letters, digits and underscores only. Omit it to derive it from title. Cannot be changed later.

titlestring required

Display title of the list.

typestring required

Purpose of the list: custom, blocklist or whitelist. A key list can only be custom. Cannot be changed later.

Example request

{
  "entryType": "key",
  "name": "high_risk_countries",
  "title": "High risk countries",
  "type": "custom"
}

Response

default response

createdAtstring date-time

When the list was created.

descstring

Free-text description of the list.

entryTypestring

Kind of key the list holds.

idstring
namestring

Name that rules reference the list by, as clientLists.<name>.

titlestring

Display title of the list.

typestring

Purpose of the list: custom, blocklist, whitelist, or system for lists that Sumsub maintains.

Example response

{
  "name": "high_risk_countries",
  "title": "High risk countries"
}

Changes

Changed in 1 of the 39 revisions of this API.1