v1

latestOpenAPI 3.0.32026-08-04404186.8 KB

Person

Add person information

Endpoint for adding new person information

post/v2/person

Request body

account_status'APPROVED' | 'BLOCKED' | 'CLOSED' | 'PENDING' | 'REJECTED'

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

date_of_birthstring date

emailstring

Contact email for the person

first_namestring

The provided first name of the person

first_transaction_completed_atstring date-time

Original timestamp of when the person completed their first transaction

is_account_ownerboolean

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_beneficial_ownerboolean

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_directorboolean

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_retail_customerboolean required

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.

is_shareholderboolean

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_personboolean

If the person has significant control of the related company, this should be set to true

is_sole_propboolean

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

is_test_userboolean required

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

last_namestring

The provided last name of the person

namestring

The provided full name of the person

nationalitystring

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

occupationstring

Primary occupation of the individual

ownership_percentagenumber

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

person_idstring required

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

phone_numberstring

Contact telephone number for the person

product_typestring

related_company_idstring

Unique external identifier of the related company entity

timestampstring date-time required

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.

Example request

[
  {
    "address": {
      "city": "London",
      "country": "France",
      "county": "Buckinghamshire",
      "lines": [
        "160 Kemp House, City Road"
      ],
      "postal_code": "EC1V 2NX",
      "state": "New York"
    },
    "date_of_birth": "1945-03-22",
    "email": "contact@company.com",
    "first_name": "Alex",
    "is_account_owner": true,
    "is_beneficial_owner": true,
    "is_retail_customer": true,
    "last_name": "Nguyen",
    "name": "Alex Nguyen",
    "nationality": "NPL",
    "occupation": "Plumber",
    "ownership_percentage": 0.5,
    "phone_number": "+441234567899"
  }
]

Response

Person added successfully

messagestring required

Provides additional information about the operation result.

organization_idstring required

The organization ID for which the operation was performed.

successboolean required

Indicates if the write operation was successful.

write_countinteger required

The number of records written to the database.