Update sensitive client

Use this endpoint to update the details of a client profile on your sensitivity list.

Instructions:
1. Make a Get sensitive client request.
2. In this Update sensitive client request, update the relevant data, and then re-enter the unchanged data for all other parameters.
3. Submit the request.

Caution Caution: If you do not re-enter the unchanged data, the existing data in the profile will be wiped.

Body Params
string
required

Our unique identifier for the sensitive client, returned in the Add sensitive client response.

Format: uuid string

Example: 790f325a-48c9-4b82-bb53-c0ea128236f0

string
required

The client’s last name.

Format: Alphabetical characters, spaces, hyphens, and apostrophes

Example: Smith

string

The client’s first name.

Format: Alphabetical characters, spaces, hyphens, and apostrophes

Example: John

string

Any other names the client is known by.

Format: Alphabetical characters, spaces, hyphens, and apostrophes

Example: Muscles

string

The sensitivity list category the client falls into.
You can define any categories that you want to track.

Format: Free text

string

The sensitivity list subcategory the client falls into.
You can define any subcategories that you want to track.

Format: Free text

string

The client’s date of birth.

Format: Date YYYY-MM-DD

Example: 1960-10-18= October 18, 1960

string

The city where the client was born.

Format: Alphabetical characters, spaces, hyphens, and apostrophes

Example: Sint-Agatha-Berchem

string

The document number of the client’s identity document(s).

string

The client’s TIN.

Example: 12.34.56-789.01

address
object
string

The country or countries where the client has citizenship

Format: Alphabetical characters, spaces, hyphens, and apostrophes

Example: Belgium, United States

string
enum

The client’s sex

Format: Case sensitive
Enum:
Female: Female in line with identity document
Male: Male in line with identity document
Other: identity document contains a value other than Male or Female
Unknown: identity document contains no gender field

Allowed:
string

The client’s mobile phone number.

Format: Must include the country code and begin with 00 or + without spaces

Example: 00324123456789 or +324123456789

string

Your reference number for the client.

Format: Free text

string

Any additional information.

Format: Free text

string

The client’s email address.

Format: Maximum 254 characters [_-a-zA-Z0-9.+]+@a-zA-Z0-9

Example: [email protected]

boolean
Defaults to true

true: This profile is active on your sensitivity list (default).

false: This profile isn’t active on your sensitivity list.

Responses

Language
Credentials
OAuth2
LoadingLoading…
Response
Choose an example:
application/json