For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
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
