List Customers

Returns a paginated list of all customers. Supports filtering by KYC status, customer type, and creation date range. Use search to find customers by name, email, or phone number.

📤 Response Fields (per item)

Field	Type	Description	Notes
`id`	`string (uuid)`	- Example: `3fa85f64-5717-4562-b3fc-2c963f66afa6`	-
`type`	`string`	`individual` or `business`. Example: `individual`	-
`first_name`	`string`	- Example: `Jane`	-
`middle_name`	`string`	-	nullable
`last_name`	`string`	- Example: `Doe`	-
`email`	`string`	- Example: `jane.doe@example.com`	-
`phone_code`	`string`	- Example: `+44`	-
`phone_number`	`string`	- Example: `7700900000`	-
`country`	`string`	- Example: `GB`	-
`state`	`string`	-	nullable
`status`	`string`	Account status: `active`, `suspended`, `closed`. Example: `active`	-
`kyc_state`	`string`	KYC verification state: `not_submitted`, `pending`, `approved`, `rejected`. Example: `approved`	-
`date_of_birth`	`string (date-time)`	-	nullable
`gender`	`string`	-	nullable
`external_reference`	`string`	-	nullable
`business`	`object`	-	nullable
`address`	`object`	-	nullable
`created_at`	`string (date-time)`	-	-
`updated_at`	`string (date-time)`	-	nullable

curl --location -g --request GET '{{baseUrl}}/api/v1/Customers?limit=20&offset=0&status=approved&type&search=jane.doe&created_from=2024-01-01T00:00:00Z&created_to=2024-12-31T23:59:59Z' \ --header 'X-API-Key;' \ --header 'X-Signature;' \ --header 'X-Timestamp;' \ --header 'X-Nonce;' \ --header 'X-Body-Hash;'

📤 Response Fields (per item)

Request

Responses

List Customers

📤 Response Fields (per item)#

Request

Responses

📤 Response Fields (per item)