---
title: "Create Individual Linked Client"
method: POST
path: "/linkedClient"
---

# Create Individual Linked Client

`POST /linkedClient`

## Request

- Base URL: `https://sandbox.openpayd.com/api`
- URL: `https://sandbox.openpayd.com/api/linkedClient`
- Auth: API key in header `Authorization`

Creates a new individual linked client, representing a natural person associated with your organisation. This object contains the client’s identifying and contact information, which must correspond to official identity documentation.

## Headers

- `idempotency-key` string

## Request body

- object
  - `clientType` string, required: Defines the type of linked client being created. Defaults to `INDIVIDUAL` for natural persons. Used to distinguish between individual and business client records within your environment.
  - `individual` object, required
    - `address` object: The registered residential address of the individual.
      - `addressLine1` string, required: The first line of the client’s residential address, typically containing the building number, street name, or property name.
      - `addressLine2` string
      - `city` string, required: The city or locality portion of the client’s residential address.
      - `state` string
      - `postCode` string: The postal or ZIP code associated with the client’s residential address.
      - `country` string, required: The country portion of the client’s residential address, represented by a valid [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). Must match the country where the client currently resides.
    - `dateOfBirth` string: The individual’s date of birth in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).
    - `email` string, required: The client’s primary email address for communication, verification, and notifications.
    - `identificationType` string: Specifies the type of identification document provided e.g. `PASSPORT`. Used to determine how the identifierValue should be validated.
    - `identificationValue` string: Optional identification value of the Individual Linked Client, required if `identificationType` is specified e.g., `PASSPORT`, `DRIVER_LICENSE`.
    - `firstName` string, required: The legal first name of the individual as it appears on official identification documents. Used for client verification and account ownership records.
    - `lastName` string, required: The legal surname or family name of the individual. Ensure this matches official documentation to avoid compliance issues.
    - `middleName` string
    - `phone` string: A valid phone number where the client can be contacted for verification or communication purposes. Should include the international dialing code e.g. `+44…`.
  - `friendlyName` string: User friendly name of the Linked Client for ease of identification or display purposes.
  - `endToEndReference` string: A unique reference you can assign to this request to support internal tracking, reconciliation, or audit purposes.

## Response `201`

201

- object
  - `id` integer
  - `accountHolderId` string
  - `createdDateTime` string
  - `status` string
  - `kycStatus` string
  - `friendlyName` string
  - `metadata` object
    - `userId` string
  - `clientType` string
  - `individual` unknown
  - `company` object
    - `registeredAddress` object
      - `addressLine1` string
      - `addressLine2` string
      - `city` string
      - `country` string
      - `postCode` string
      - `state` string
    - `tradingAddress` object
      - `addressLine1` string
      - `addressLine2` string
      - `city` string
      - `country` string
      - `postCode` string
      - `state` string
    - `registrationNumber` string
    - `industrySectorType` string
    - `industrySectorValue` string
    - `companyName` string
    - `companyType` string
    - `contactName` string
    - `phone` string
    - `email` string

## Other responses

- `400`: 400

---

[API](https://skmtc.dev/openpayd/apis/openpayd-api.md) - [All operations](https://skmtc.dev/openpayd/apis/openpayd-api/llms.txt) - [OpenAPI document](https://skmtc.dev/openpayd/apis/openpayd-api/revisions/0f820ef79fab?raw)
