v1

latestOpenAPI 3.1.02026-07-26290133.2 KB

Update Linked Client

Update an existing Individual or Business Linked Client

put/linkedClient/{id}

Path parameters

idstring required

accountHolderId from the Create Linked Client request.

Request body

friendlyNamestring

User friendly name of the Linked Client for ease of identification or display purposes.

emailstring

Email of the Individual Linked Client.

phonestring

Phone Number of the Individual Linked Client.

firstNamestring

First Name of an Individual Linked Client

middleNamestring

Middle Name of an Individual Linked Client

lastNamestring

Last Name of an Individual Linked Client

dateOfBirthstring

Date of Birth of the Individual Linked Client.<br>YYYY-MM-DD e.g. 1986-04-29

identificationTypestring

Type of Identification provided for the Individual.<br>PASSPORT, DRIVERS_LICENSE, NATIONAL_ID, OTHER

identificationValuestring

Number or further details about the Identification provided for the Individual Linked Client.

metadataobject

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

idinteger

accountHolderIdstring

createdDateTimestring

statusstring

kycStatusstring

friendlyNamestring

clientTypestring

Example response

{
  "id": 1234,
  "accountHolderId": "cf24fc85-5ce7-495c-ae96-dee484304170",
  "createdDateTime": "1986-04-29T07:09:04.985325Z",
  "status": "ACTIVE",
  "kycStatus": "VERIFIED",
  "friendlyName": "John Doe",
  "metadata": {
    "userId": "ABC1234"
  },
  "clientType": "INDIVIDUAL",
  "individual": {
    "address": {
      "addressLine1": "10 Downing Street",
      "addressLine2": "Westminster",
      "city": "London",
      "country": "GB",
      "postCode": "SW1A 2AA",
      "state": "Greater London"
    },
    "firstName": "Boris",
    "middleName": "de Pfeffel",
    "lastName": "Johnson",
    "dateOfBirth": "1964-06-96",
    "email": "boris@london.gov.uk",
    "phone": "442072194682",
    "identificationType": "PASSPORT",
    "identificationValue": "GB123345678"
  }
}