business object.| Field | Type | Description | Constraints |
|---|---|---|---|
first_name | string | - Example: Janet | Nullable |
middle_name | string | - | Nullable |
last_name | string | - | Nullable |
email | string (email) | - | Nullable |
phone_code | string | - | Nullable |
phone_number | string | - | Nullable |
country | string | - | Min length: 2 · Max length: 2 · Nullable |
state | string | - | Nullable |
date_of_birth | string (date-time) | - | Nullable |
gender | string | - | Nullable |
address | AddressRequest | - | - |
business | BusinessDetails | - | - |
| Optional Fields |
| Field | Type | Description | Constraints |
|---|---|---|---|
first_name | string | - Example: Janet | Nullable |
middle_name | string | - | Nullable |
last_name | string | - | Nullable |
email | string (email) | - | Nullable |
phone_code | string | - | Nullable |
phone_number | string | - | Nullable |
country | string | - | Min length: 2 · Max length: 2 · Nullable |
state | string | - | Nullable |
date_of_birth | string (date-time) | - | Nullable |
gender | string | - | Nullable |
address | AddressRequest | - | - |
business | BusinessDetails | - | - |
| 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 PATCH '{{baseUrl}}/api/v1/Customers/3fa85f64-5717-4562-b3fc-2c963f66afa6' \
--header 'X-API-Key;' \
--header 'X-Signature;' \
--header 'X-Timestamp;' \
--header 'X-Nonce;' \
--header 'X-Body-Hash;' \
--header 'Content-Type: application/json' \
--data-raw '{
"first_name": "Janet",
"phone_number": "7700999888",
"address": {
"address_line_1": "10 Downing Street",
"city": "London",
"postal_code": "SW1A 2AA",
"country": "GB"
}
}'{}