Skip to main content
POST
Create a customer

Authorizations

X-Api-Key
string
header
required

An API key: lsk_<test|live>_<public_id>.. The key also has to be used from an address on its allowlist.

Headers

Idempotency-Key
string
required

A unique value per create (a UUID works). Retrying with the same key and body returns the first result with Idempotent-Replayed: true; the same key with a different body is 409 (code 53).

Body

application/json
first_name
string | null
required
Example:

"Adaeze"

last_name
string | null
required
Example:

"Okafor"

phone_number
string | null
required
Example:

"+2348012345678"

date_of_birth
string<date>
required
Example:

"1994-03-21"

middle_name
string | null
Example:

"Chioma"

email
string | null
Example:

"adaeze.okafor@example.com"

customer_type
string | null
Example:

"individual"

address
object
alias
string | null
Example:

"Mama Ada"

Response

Created

success
boolean
required
message
string | null
required
request_id
string | null
required
Example:

"01a1775167aa7693a7acd8df7b596118"

data
object
code
string | null

Failures only: the numeric code a client branches on (see ErrorCodeNumbers).

Example:

"13"