Customers

The Customers API allows you to retrieve customer records linked to your integration via two endpoints:

• One for retrieving details for a specific customer.

• One for retrieving a paginated list of customers.

You must include your Bearer token in the request header.

Retrieve a paginated list of customers

get

Returns a list of customers, paginated according to the 'per_page' and 'page' query parameters.

Authorizations

Query parameters

per_pageinteger · min: 1 · max: 100Optional

Number of items to return per page in a paginated response.

Default: 15

pageinteger · min: 1Optional

The current page number for paginated results.

Default: 1

Responses

200

A paginated array of customer resources

application/json

401

Unauthorized

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/customers HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*

[
  {
    "uuid": "123e4567-e89b-12d3-a456-426614174000",
    "identity_uuid": "123e4567-e89b-12d3-a456-426614174000",
    "type": "individual",
    "updated_at": 1744373843,
    "created_at": 1744373843,
    "name": "John Doe",
    "risk_country_code": null,
    "registration_country_code": "LT",
    "registration_address_line": "Business Street 1",
    "registration_address_index": "01109",
    "post_address_country_code": "LT",
    "post_address_line": "Main Street 123",
    "post_address_index": "90210",
    "related_persons": null
  }
]

Retrieve details for a specific customer

get

Returns comprehensive information about a customer identified by their unique UUID.

Authorizations

Path parameters

uuidstring · uuidRequired

Universally Unique Identifier (UUID) as defined by RFC 4122.

Example: e1f8a3b1-7d6c-4e9a-9b2e-3f8d1a9c5f2gPattern: ^[a-zA-Z0-9]{8}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{12}$

Responses

200

Detailed information about the requested customer.

application/json

401

Unauthorized

application/json

404

Not Found

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/customers/{uuid} HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*

{
  "uuid": "123e4567-e89b-12d3-a456-426614174000",
  "identity_uuid": "123e4567-e89b-12d3-a456-426614174000",
  "type": "individual",
  "updated_at": 1744373843,
  "created_at": 1744373843,
  "name": "John Doe",
  "risk_country_code": null,
  "registration_country_code": "LT",
  "registration_address_line": "Business Street 1",
  "registration_address_index": "01109",
  "post_address_country_code": "LT",
  "post_address_line": "Main Street 123",
  "post_address_index": "90210",
  "related_persons": null
}