type: "individual" for personal customers and type: "business" for company accounts.email must be unique โ a 409 is returned if it already existsdate_of_birth and gender are required for individual customersbusiness_name should be provided for business customerscountry uses ISO 3166-1 alpha-2 codes (e.g., "GB", "US", "AE")external_reference lets you store your own system's customer ID for cross-referencing| Field | Type | Description | Constraints |
|---|---|---|---|
type | string | Customer type. Must be individual or business. Example: individual | Pattern: `^(individual |
first_name | string | Customer's first name. Example: Jane | Max length: 100 |
last_name | string | Customer's last name. Example: Doe | Max length: 100 |
email | string (email) | Unique email address. Cannot be updated after creation. Example: jane.doe@example.com | - |
phone_code | string | International dialling code (e.g., +44, +1). Example: +44 | - |
phone_number | string | Phone number without country code. Example: 7700900000 | - |
country | string | Customer's country of residence. ISO 3166-1 alpha-2 code (e.g., GB, US, AE). Example: GB | Min length: 2 ยท Max length: 2 |
| Field | Type | Description | Constraints |
|---|---|---|---|
business_name | string | Business name (provide for business customers). Example: Acme Corp Ltd | Nullable |
date_of_birth | string (date-time) | Required for individual customers. ISO 8601 format. Example: 1990-06-15T00:00:00Z | Nullable |
gender | string | Required for individual customers. Common values: male, female, other. Example: female | Nullable |
state | string | State or region (optional). Example: England | Nullable |
external_reference | string | Your internal customer ID for cross-referencing. Example: usr_12345 | Max length: 200 ยท Nullable |
| 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 POST '{{baseUrl}}/api/v1/Customers' \
--header 'X-API-Key;' \
--header 'X-Signature;' \
--header 'X-Timestamp;' \
--header 'X-Nonce;' \
--header 'X-Body-Hash;' \
--header 'Content-Type: application/json' \
--data-raw '{
"type": "individual",
"first_name": "Jane",
"last_name": "Doe",
"email": "jane.doe@example.com",
"phone_code": "+44",
"phone_number": "7700900000",
"date_of_birth": "1990-06-15T00:00:00Z",
"gender": "female",
"country": "GB",
"state": "England",
"external_reference": "usr_12345"
}'{
"data": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"type": "individual",
"first_name": "Jane",
"last_name": "Doe",
"email": "jane.doe@example.com",
"phone_code": "+44",
"phone_number": "7700900000",
"country": "GB",
"status": "active",
"kyc_state": "not_submitted",
"created_at": "2024-01-15T10:30:00Z"
},
"request_id": "req_abc123",
"timestamp": "2024-01-15T10:30:00Z"
}