Skip to main content
POST
cURL

Create Customer

Error Codes and Messages

Authorizations

X-API-KEY
string
header
required

API Key for authentication

X-TIMESTAMP
string
header
required

Current timestamp in seconds since epoch

X-SIGNATURE
string
header
required

HMAC SHA256 signature of the request encoded in Base64

Body

application/json
client_reference_id
string
required

Your unique reference for this customer. Required. Re-sending an existing client_reference_id returns the existing customer.

Example:

"test123"

alpha_3_country_code
string
required

ISO 3166-1 alpha-3 country code. Must be enabled for your organization, otherwise the request fails with REQ_INVALID_COUNTRY.

Example:

"IND"

full_name
string

Customer's full name. Required unless you send both first_name and last_name.

Example:

"John Doe"

first_name
string

First name. Send together with last_name as an alternative to full_name.

Example:

"John"

last_name
string

Last name. Send together with first_name.

Example:

"Doe"

email
string

Customer email. Required only when email verification is enabled for your organization.

Example:

"john@example.com"

phone
string

National mobile number without country code (8–15 characters, validated per country). Required only when phone verification is enabled for your organization.

Example:

"9911002211"

dob
string<date>

Date of birth (YYYY-MM-DD). Required when alpha_3_country_code is USA.

Example:

"1990-01-15"

Response

Customer created successfully

status
boolean
Example:

true

message
string
Example:

"Success"

data
object