---
title: "Update Linked Client"
method: PUT
path: "/linkedClient/{id}"
---

# Update Linked Client

`PUT /linkedClient/{id}`

## Request

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

Update an existing Individual or Business Linked Client

## Path parameters

- `id` string, required

## Request body

- object
  - `friendlyName` string: User friendly name of the Linked Client for ease of identification or display purposes.
  - `email` string: Email of the Individual Linked Client.
  - `phone` string: Phone Number of the Individual Linked Client.
  - `firstName` string: First Name of an Individual Linked Client
  - `middleName` string: Middle Name of an Individual Linked Client
  - `lastName` string: Last Name of an Individual Linked Client
  - `dateOfBirth` string: Date of Birth of the Individual Linked Client.<br>YYYY-MM-DD e.g. `1986-04-29`
  - `individualAddress` object: Address of an Individual Linked Client.
    - `address` object: Address of the Individual.
      - `addressLine1` string
      - `addressLine2` string
      - `city` string
      - `state` string
      - `postCode` string
      - `country` string: Two-letter [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code e.g. `GB`
  - `identificationType` string: Type of Identification provided for the Individual.<br>`PASSPORT`, `DRIVERS_LICENSE`, `NATIONAL_ID`, `OTHER`
  - `identificationValue` string: Number or further details about the Identification provided for the Individual Linked Client.
  - `metadata` object: Set of key-value pairs that you can attach to the Linked Client Object. Useful for storing additional, structured information on the Linked Client. e.g your internal ID of your user etc.<br> e.g `"userId":"ABC1234, "userName":"Boris Johnson"

## Response `200`

200

- object
  - `id` integer
  - `accountHolderId` string
  - `createdDateTime` string
  - `status` string
  - `kycStatus` string
  - `friendlyName` string
  - `metadata` object
    - `userId` string
  - `clientType` string
  - `individual` object
    - `address` object
      - `addressLine1` string
      - `addressLine2` string
      - `city` string
      - `country` string
      - `postCode` string
      - `state` string
    - `firstName` string
    - `middleName` string
    - `lastName` string
    - `dateOfBirth` string
    - `email` string
    - `phone` string
    - `identificationType` string
    - `identificationValue` 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)