---
title: "Add person information"
method: POST
path: "/v2/person"
tags: ["Person"]
---

# Add person information

`POST /v2/person`

Endpoint for adding new person information

## Request body

- Person[]
  - `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
  - `address` Address — Legal/contact address for the entity
    - `city` string
    - `country` string
    - `county` string
    - `lines` string[]
    - `postal_code` string
    - `state` string
  - `date_of_birth` string, date
  - `email` string — Contact email for the person
  - `first_name` string — The provided first name of the person
  - `first_transaction_completed_at` string, date-time — Original timestamp of when the person completed their first transaction
  - `is_account_owner` boolean — 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_owner` boolean — 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_director` boolean — 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_customer` boolean, 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_shareholder` boolean — 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_person` boolean — If the person has significant control of the related company, this should be set to true
  - `is_sole_prop` boolean — If the related company is a sole proprietorship (or sole trader if in the UK), this should be set to true.
  - `is_test_user` boolean, required — If the person is a test user, this should be set to true
  - `last_name` string — The provided last name of the person
  - `name` string — The provided full name of the person
  - `national_identification_number` object
    - `type` string, required — Type of national identification number
    - `value` string, required — National identification number
  - `nationality` string — 2 or 3 Character ISO 3166 Country Code (https://w.wiki/4rY)
  - `occupation` string — Primary occupation of the individual
  - `ownership_percentage` number — 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_id` string, required — Unique external identifier of the person entity, ID stored in your database / back-office
  - `phone_number` string — Contact telephone number for the person
  - `product_type` string
  - `related_company_id` string — Unique external identifier of the related company entity
  - `timestamp` string, 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.

## Response `201`

Person added successfully

- WriteOperationResponse
  - `message` string, required — Provides additional information about the operation result.
  - `organization_id` string, required — The organization ID for which the operation was performed.
  - `success` boolean, required — Indicates if the write operation was successful.
  - `write_count` integer, required — The number of records written to the database.

## Other responses

- `400` — Invalid person data
- `401` — Unauthorized request
- `409` — Person already exists
- `429` — Rate limit exceeded
- `500` — Server error
- `default` — General error

---

[API](https://skmtc.net/cable/apis/cable-api.md) · [All operations](https://skmtc.net/cable/apis/cable-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cable/cable-api/versions/3222cd28dba5/schema)
