Sign in
ClientListApiAgentResource

Get a client list by id

Returns one client list. Answers 404 when you have no list with this id.

get/resources/api/agent/clientLists/{id}

Path parameters

idstring required

Id of the list, as returned by the list endpoint.

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