Create Customer

POST

/{{baseurl}}/api/v1/Customers

Creates a new customer record.

⚠️ Required Fields

Field	Type	Description	Constraints
`type`	`string`	`individual` or `business`	Pattern: `^(individual
`email`	`string (email)`	Unique email address	-
`phoneCode`	`string`	International dialling code (e.g. `+44`)	-
`phoneNumber`	`string`	Phone number without country code	-
`country`	`string`	Country of residence	-

Optional Fields

Field	Type	Description	Constraints
`firstName`	`string`	Customer's first name	Max: 100 · Nullable
`lastName`	`string`	Customer's last name	Max: 100 · Nullable
`businessName`	`string`	Required for business customers	Nullable
`dateOfBirth`	`string (date)`	Required for individual customers (YYYY-MM-DD)	Nullable
`gender`	`string`	`male`, `female`, `other`	Nullable
`externalReference`	`string`	Your internal customer ID	Max: 200 · Nullable

Request

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢201

application/json

Customer created successfully.

Body

🟠401

🟠409

🟠422

Request Example

Shell

JavaScript

Java

Swift

cURL

Individual customerBusiness customer

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",
    "firstName": "Jane",
    "lastName": "Doe",
    "email": "jane.doe@example.com",
    "phoneCode": "+44",
    "phoneNumber": "7700900000",
    "dateOfBirth": "1990-06-15",
    "gender": "female",
    "country": "GB",
    "externalReference": "usr_12345"
}'

Response Example

{
    "data": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "type": "individual",
        "firstName": "Jane",
        "lastName": "Doe",
        "email": "jane.doe@example.com",
        "phoneCode": "+44",
        "phoneNumber": "7700900000",
        "country": "GB",
        "status": "active",
        "kycState": "not_submitted",
        "createdAt": "2024-01-15T10:30:00Z"
    },
    "request_id": "req_abc123",
    "timestamp": "2024-01-15T10:30:00Z"
}

Modified at 2026-02-19 17:53:55

API Setup Guide

List Customers