Get Linked Client

Get a Linked Client by it UUID.

get/linkedClient/{id}

Request

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

Path parameters

idstring required

accountHolderId from the Create Linked Client request.

Response

200

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": "4324324234",
    "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.