API ReferencePerson

Add person information

Endpoint for adding new person information

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects a list of objects.
person_idstringRequired>=1 character

Unique external identifier of the person entity, ID stored in your database / back-office

timestampdatetimeRequired
When this person record was created or last modified in your system, in ISO 8601 format. For example, account opening date or KYC completion time.
is_test_userbooleanRequiredDefaults to false
If the person is a test user, this should be set to true
is_retail_customerbooleanRequired

Indicates if the person is in the context of retail companies. If the value is false, fields is_beneficial_owner, is_director, is_account_owner and is_shareholder are required.

related_company_idstringOptional>=1 character
Unique external identifier of the related company entity
is_beneficial_ownerbooleanOptional

If the person is a beneficial owner of the related company, this should be set to true. If is_retail_customer is false, this field is required.

is_directorbooleanOptional

If the person is a director of the related company, this should be set to true. If is_retail_customer is false, this field is required.

is_account_ownerbooleanOptional

If the person is an account owner of the related company, this should be set to true. If is_retail_customer is false, this field is required.

is_sole_propbooleanOptional

If the related company is a sole proprietorship (or sole trader if in the UK), this should be set to true.

is_shareholderbooleanOptional

If the person is a shareholder of the related company, this should be set to true. If is_retail_customer is false, this field is required.

is_significant_control_personbooleanOptional
If the person has significant control of the related company, this should be set to true
ownership_percentagedoubleOptional
If the person is a shareholder of the related company, this should be set to their ownership percentage, as a value between 0 and 1
account_statusenumOptional
The account status for the related person. Refer to the Developer Guide "Entity Account Statuses" to understand what account statuses mean at Cable, and how to use them
Allowed values:
namestringOptional
The provided full name of the person
first_namestringOptional
The provided first name of the person
last_namestringOptional
The provided last name of the person
emailstringOptional
Contact email for the person
addressobjectOptional

Legal/contact address for the entity

phone_numberstringOptional
Contact telephone number for the person
date_of_birthdateOptional
nationalitystringOptional

2 or 3 Character ISO 3166 Country Code (https://w.wiki/4rY)

occupationstringOptional
Primary occupation of the individual
first_transaction_completed_atdatetimeOptional
Original timestamp of when the person completed their first transaction
national_identification_numberobjectOptional
product_typestringOptional>=1 character

Response

Person added successfully
successboolean
Indicates if the write operation was successful.
write_countinteger
The number of records written to the database.
messagestring
Provides additional information about the operation result.
organization_idstring
The organization ID for which the operation was performed.

Errors

400
Bad Request Error
401
Unauthorized Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error