Sign in
ClientListValuesApiAgentResource

Add one value to a client list

Adds one key to the list. A key the list already holds is refused with 400, unless overwrite is true: then the stored value is replaced. The key must match the list's entryType: an applicant id for applicant, an email address for email, a phone number in international format such as +49 30 123456 for phone (stored in E.164, +4930123456), a CIDR block such as 192.0.2.0/24 for ipRange. Lists that Sumsub maintains cannot be changed. At most 2 values per second and 300 per hour can be added.

post/resources/api/agent/clientLists/{listId}/values

Path parameters

listIdstring required

Id of the list.

Query parameters

overwriteboolean

Replace the stored value when the list already holds the key.

Request body

descstring

Free-text description of the value.

keystring required

The key to add. Its format depends on the list's entryType: an applicant id for applicant, an email address for email, a phone number in international format such as +49 30 123456 for phone (stored in E.164), a CIDR block such as 192.0.2.0/24 for ipRange. At most 64 characters.

Example request

{
  "desc": "Germany",
  "key": "DEU"
}

Response

default response

createdAtstring date-time

When the value was added.

createdBystring

Who added the value.

descstring

Free-text description of the value.

idstring
keystring

The key that rules match against.

slugstring

Full name of the applicant, set only when the applicant was blocklisted from their profile.

Example response

{
  "desc": "Germany",
  "key": "DEU"
}

Changes

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