List Customers

Returns a paginated list of customers, newest first, with optional filters for KYC status, customer type,
free-text search, and creation date range.

Filters

Parameter	Matches
`status`	The customer's KYC state
`type`	`individual` or `business`
`search`	Email, first name, last name, or phone number (partial match)
`createdFrom` / `createdTo`	Creation date range (inclusive)

Response Fields

Field	Type	Description
`data[]`	`array`	Customer objects
`data[].id`	`string (uuid)`	Customer identifier
`data[].type`	`string`	`individual` or `business`
`data[].firstName / middleName / lastName`	`string, nullable`	Individual name parts
`data[].businessName`	`string, nullable`	Business name
`data[].email`	`string`	Email address
`data[].phoneCode / phoneNumber`	`string`	Phone
`data[].country`	`string`	Country name
`data[].status`	`string`	Record status - `Active`, `Inactive`, `Disable`, `Rejected`, `Submitted`
`data[].dateOfBirth`	`string (date), nullable`	`YYYY-MM-DD`
`data[].gender`	`string, nullable`	Gender
`data[].externalReference`	`string, nullable`	Your reference, if supplied at creation
`data[].business`	`object, nullable`	`null` here - business details are returned by Get Customer
`data[].createdAt / updatedAt`	`string (date-time)`	Timestamps (UTC)
`pagination.total`	`integer`	Total matching customers
`pagination.limit / offset`	`integer`	Page window applied (`limit` is capped at 100)
`pagination.hasMore`	`boolean`	Whether further pages are available

List responses carry data and pagination only - no requestId / timestamp.

curl --location '/api/v1/customers?limit=20&offset=0&status=Approved&type=individual&search=jane&createdFrom=2026-01-01T00%3A00%3A00Z&createdTo=2026-12-31T23%3A59%3A59Z' \ --header 'X-API-Key;' \ --header 'X-Signature;' \ --header 'X-Timestamp;' \ --header 'X-Nonce;' \ --header 'X-Body-Hash;' \ --header 'X-Idempotency-Key;'

{ "data": [ { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "individual", "firstName": "Jane", "middleName": null, "lastName": "Doe", "businessName": null, "email": "jane.doe@example.com", "phoneCode": "+44", "phoneNumber": "7700900000", "country": "United Kingdom", "status": "Active", "dateOfBirth": "1990-06-15", "gender": "female", "externalReference": "usr_12345", "business": null, "createdAt": "2026-01-15T10:30:00Z", "updatedAt": "2026-01-15T10:30:00Z" }, { "id": "ed2baa83-a988-4b4a-93ee-fad379500bbd", "type": "business", "firstName": null, "middleName": null, "lastName": null, "businessName": "Acme Corp Ltd", "email": "contact@acmecorp.com", "phoneCode": "+44", "phoneNumber": "2071234567", "country": "United Kingdom", "status": "Active", "dateOfBirth": null, "gender": null, "externalReference": "biz_67890", "business": { "businessName": "Acme Corp Ltd", "registrationNumber": "12345678", "taxId": "GB123456789", "incorporationDate": "2018-04-02T00:00:00", "website": "https://acmecorp.com", "industry": "financial_services", "companyType": "limited_company", "description": "Fintech payment solutions provider" }, "createdAt": "2026-02-01T09:00:00Z", "updatedAt": "2026-02-03T14:22:00Z" } ], "pagination": { "total": 2, "limit": 20, "offset": 0, "hasMore": false } }

Request

Responses