Skip to main content
GET
List customers

Authorizations

API-KEY
string
header
required

Your partner API key. The key must carry the customers permission.

Headers

Api-Version
string
default:2026-09.1
required

The API version this request targets. Required on every /api/v0/* call. Format YYYY-MM.<release>; 2026-09.1 is the latest. The version that served the request is echoed back on the response. Missing, malformed or unsupported values are rejected with 400.

Pattern: ^\d{4}-\d{2}\.\d+$

Query Parameters

page
integer
default:0

Zero-based page index, default 0. A negative value is treated as 0.

size
integer
default:20

Default 20, max 100. Values above 100 become 100; 0 or negative values fall back to 20. Never rejected.

Required range: x <= 100
status
enum<string>

Filter by KYC status. An unsupported value — active, for instance — is 400 ERRCUS_1503, field status: Invalid status 'active'. Supported KYC statuses: ….

Available options:
NOT_INITIATED,
INITIATED,
SUBMITTED,
IN_REVIEW,
PENDING,
COMPLETED,
REJECTED,
RESUBMISSION_REQUIRED

Response

A page of customers.

customers
object[]

The customers on this page.

page
integer

Zero-based page number.

size
integer

Page size.

totalElements
integer

Total matching customers. It may include one internal account that isn't returned in customers, so a page can hold fewer than size items.

totalPages
integer

Total pages available.