Sign in

v1

latestOpenAPI 3.0.02026-07-2667172347.6 KB
Sensitivity list

Update sensitive client

Use this endpoint to update the details of a client profile on your sensitivity list. <br /><br />Instructions: <br /> 1. Make a <a href="ref:get-sensitive-client">Get sensitive client</a> request. <br />2. In this Update sensitive client request, update the relevant data, and then re-enter the unchanged data for all other parameters. <br />3. Submit the request. <br /><br /><img src="https://files.readme.io/310d4d3-Inline_Caution.svg" align="left" alt="Caution" /> Caution: If you <strong>do not</strong> re-enter the unchanged data, the existing data in the profile will be wiped.

put/v1/sensitivityList

Headers

Authorizationstring required

The access_token returned in your most recent Create access token response.

Request body

idstring required

Our unique identifier for the sensitive client, returned in the Add sensitive client response. <br /><br />Format: uuid string <br /><br />Example: 790f325a-48c9-4b82-bb53-c0ea128236f0

lastNamestring required

The client’s last name. <br /><br />Format: Alphabetical characters, spaces, hyphens, and apostrophes <br /><br />Example: Smith

firstNamestring

The client’s first name. <br /><br />Format: Alphabetical characters, spaces, hyphens, and apostrophes <br /><br />Example: John

aliasesstring

Any other names the client is known by. <br /><br />Format: Alphabetical characters, spaces, hyphens, and apostrophes <br /><br />Example: Muscles

categorystring

The sensitivity list category the client falls into. <br />You can define any categories that you want to track. <br /><br />Format: Free text

subcategorystring

The sensitivity list subcategory the client falls into. <br />You can define any subcategories that you want to track. <br /><br />Format: Free text

dateOfBirthstring

The client’s date of birth. <br /><br />Format: Date YYYY-MM-DD <br /><br />Example: 1960-10-18= October 18, 1960

placeOfBirthstring

The city where the client was born. <br /><br />Format: Alphabetical characters, spaces, hyphens, and apostrophes <br /><br />Example: Sint-Agatha-Berchem

identificationDocumentNumbersstring

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

taxIdentificationNumberstring

The client’s <Glossary>TIN</Glossary>. <br /><br />Example: 12.34.56-789.01

citizenshipstring

The country or countries where the client has citizenship <br /><br />Format: Alphabetical characters, spaces, hyphens, and apostrophes <br /><br />Example: Belgium, United States

sex'Male' | 'Female' | 'Other' | 'Unknown'

The client’s sex <br /><br />Format: Case sensitive <br />Enum: <br />• Female: Female in line with ID document <br />• Male: Male in line with ID document <br />• Other: ID document contains a value other than Male or Female <br />• Unknown: ID document contains no gender field

mobilePhoneNumberstring

The client’s mobile phone number. <br /><br />Format: Must include the country code and begin with 00 or + without spaces <br /><br />Example: 00324123456789 or +324123456789

referencestring

Your reference number for the client. <br /><br />Format: Free text

furtherInformationstring

Any additional information. <br /><br />Format: Free text

emailstring

The client’s email address. <br /><br />Format: Maximum 254 characters [_-a-zA-Z0-9.+]+@a-zA-Z0-9 <br /><br />Example: j.smith@example.com

enabledboolean

• true: This profile is active on your sensitivity list (default). <br /><br />• false: This profile isn’t active on your sensitivity list.

Response

Sensitive client updated

idstring

Our unique identifier for the sensitive client, returned in the Add sensitive client response. <br /><br />Format: uuid string <br /><br />Example: 790f325a-48c9-4b82-bb53-c0ea128236f0

urlstring

The URL where you can retrieve the sensitive client profile.