Skip to main content
POST

Authorizations

​
X-Auth-Client
string
header
required

Your workspace client id.

All calls must include four headers:

  • X-Auth-Client — your workspace client id
  • X-Auth-Timestamp — Unix seconds
  • X-Auth-Nonce — 16-byte random hex
  • X-Auth-Signature — hex(HMAC-SHA256( {client_id}:{timestamp}:{nonce}:{raw_body}, client_secret))

The playground computes the timestamp, nonce and signature for you.

​
X-Playground-Client-Secret
string
header
required

Your sandbox client secret. The playground uses it to sign the request in your browser and removes it before the request is sent. Never send your client secret as a header in your own integration.

Body

application/json
​
customer_type
enum<string>
required
Available options:
individual,
business,
team_member
​
email
string<email>
required

Email address.

Maximum string length: 255
​
city
string

City.

Maximum string length: 100
​
company_name
string

Company name.

Maximum string length: 200
​
country
string

ISO 3166-1 alpha-3 country code.

Required string length: 3
​
date_of_birth
string<date>

YYYY-MM-DD.

​
dial_code
string

International dial code, for example +234.

Maximum string length: 5
Example:

"+234"

​
first_name
string

First name.

Maximum string length: 100
​
id_number
string

Number on the identity document.

Maximum string length: 50
​
id_type
enum<string>
Available options:
passport,
drivers_license,
national_id,
bvn,
nin,
vnin,
voters_card,
ghana_card
​
last_name
string

Last name.

Maximum string length: 100
​
line1
string

Address line 1.

Maximum string length: 200
​
metadata
string

A JSON object encoded as a string. Stored but never returned.

​
phone_number
string

Phone number without the dial code.

Maximum string length: 20
​
postal_code
string

Postal code.

Maximum string length: 20
​
registration_number
string

Business registration (RC) number; required for business customers, 4 to 50 characters.

Maximum string length: 50
​
state
string

State.

Maximum string length: 100

Response

Created, or the existing customer that matches the details.

Successful responses are wrapped in this envelope, and so are errors a handler answers itself (request body and field validation, some not-found and conflict cases, ORG_NOT_ACTIVE): success is false and error carries a code and message. Errors raised by authentication and by the services behind a handler are a Problem instead.

​
success
boolean
required

true on success

​
timestamp
string<date-time>
required

When the response was written.

​
data
object

The payload; its shape is given per operation. Omitted when there is none.

​
error
object
​
message
string

Human-readable summary; omitted when empty.

​
metadata
object

List metadata. Page lists set page, per_page, total and total_pages; offset and cursor lists set limit, offset, has_more and next_cursor. Zero and empty fields are omitted, and metadata is absent when nothing is set.

​
request_id
string

Set on error envelopes: the request's correlation id (req_ followed by a UUID), the same value as the X-Correlation-ID response header. Quote it to support.