v1

latestOpenAPI 3.1.02026-07-26290133.2 KB

List Linked Clients

Get a list of all Linked Clients filtered by various params.

get/linkedClient

Query parameters

createdDateFromstring

Timestamp in the ISO 8601 standard. e.g. 2019-14-29T00:15:09Z for April 29, 2019 0:15:09 UTC

createdDateTostring

Timestamp in the ISO 8601 standard. e.g. 2019-14-29T00:15:09Z for April 29, 2019 0:15:09 UTC

namestring

emailstring

Email of the Linked Client

contactsstring

searches in "name/surname" for individual clients, searches in "company contact email / company contact name" for business clients

statusstring

PENDING, REVIEW, UNVERIFIED, ACTIVE, SUSPENDED

typestring

INDIVIDUAL, BUSINESS

pageinteger

sizeinteger

sortstring

e.g. createdDateTime,asc or createdDateTime,desc

offsetinteger

Response

200

totalPagesinteger

lastboolean

totalElementsinteger

firstboolean

numberOfElementsinteger

sizeinteger

numberinteger

emptyboolean

Example response

{
  "content": [
    {
      "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"
      }
    }
  ],
  "pageable": {
    "sort": {
      "unsorted": true,
      "empty": true
    },
    "pageSize": 1,
    "paged": true
  },
  "totalPages": 1,
  "last": true,
  "totalElements": 1,
  "first": true,
  "sort": {
    "unsorted": true,
    "empty": true
  },
  "numberOfElements": 1,
  "size": 1
}