Create Individual Linked Client

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.

post/linkedClient

Request

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

Headers

idempotency-keystring

Optional header for retrying requests without accidentally creating the same transaction twice.

Request body

clientTypestring 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.

friendlyNamestring

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

endToEndReferencestring

A unique reference you can assign to this request to support internal tracking, reconciliation, or audit purposes.

Response

201

idinteger

accountHolderIdstring

createdDateTimestring

statusstring

kycStatusstring

friendlyNamestring

clientTypestring

individualunknown

Example response

{
  "id": 783248,
  "accountHolderId": "4cba12e8-53ef-4b80-bb27-69755d7bc5ca",
  "createdDateTime": "2023-09-12T12:30:24.469714Z",
  "status": "ACTIVE",
  "kycStatus": "VERIFIED_BY_CLIENT",
  "friendlyName": "Kay Simonis",
  "metadata": {
    "userId": "ABC1234"
  },
  "clientType": "BUSINESS",
  "company": {
    "registeredAddress": {
      "addressLine1": "45680 Salvatore Port",
      "addressLine2": "St",
      "city": "Arnulfoton",
      "country": "SM",
      "postCode": "UK6 0JP",
      "state": "MN"
    },
    "tradingAddress": {
      "addressLine1": "93556 Barrows Corners",
      "addressLine2": "St",
      "city": "{{randomCity}}",
      "country": "SS",
      "postCode": "UK6 0JP",
      "state": "MN"
    },
    "registrationNumber": "23232423232",
    "industrySectorType": "TELECOMMUNICATION_SERVICES",
    "industrySectorValue": "1",
    "companyName": "Heathcote LLC",
    "companyType": "CHARITY",
    "contactName": "Gilbert Schneider",
    "phone": "441493966508",
    "email": "id-voluptas-mollitia@yopmail.com"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.