Customer Data APIBusiness

Add person information

Business endpoint for adding new person information

Headers

x-api-keystringRequired
x-internal-api-keystringRequired

Request

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

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

timestampdatetimeRequired

Original timestamp relating to this person entity creation/change

is_beneficial_ownerbooleanRequired

If the person is a beneficial owner of the parent entity, this should be set to true

is_directorbooleanRequired

If the person is a director of the parent entity, this should be set to true

is_account_ownerbooleanRequired

If the person is an account owner of the parent entity, this should be set to true

is_shareholderbooleanRequired

If the person is a shareholder of the parent entity, this should be set to true

is_test_userbooleanRequired

If the person is a test user, this should be set to true

dataobjectRequired
is_significant_control_personbooleanOptionalDefaults to false

If the person is a has significant control of the parent entity, this should be set to true

ownership_percentagedoubleOptional

If the person is a shareholder of the parent entity, this should be set to their ownership percentage, as a value between 0 and 1

parentobjectOptional

Response

Operation success

successboolean

You probably did something wrong if you set this to false