Create Customer

Creates a new customer record and automatically provisions a default wallet. The default wallet channel is WALLET unless overridden by channel. The wallet currency is derived from the customer's country unless overridden by currency.

Each customer email is unique per builder account and environment. A customer created in sandbox does not exist in live.

Body

firstName

*String

Customer's first name.

lastName

*String

Customer's last name.

email

*String

Customer's email address. Must be unique per builder account.

phone

String

Optional phone number.

country

String

2-letter ISO country code (e.g. NG, KE, GH). Used to derive the default wallet currency.

address

String

Customer's residential or business address.

channel

String

Channel for the default wallet. One of: "WALLET", "ACCOUNT", "STABLECOIN". Defaults to "WALLET".

currency

String

3-letter ISO currency code for the default wallet (e.g. NGN, KES, USD). Derived from country if omitted.

provider

String

Back the default wallet with this specific provider. Must be a provider you already hold an active wallet with. Case-insensitive.

metadata

Object

Arbitrary key-value pairs stored against the customer for your own reference.

POST
/ v2/customers
Endpoint URL(TEXT)
Request Body
Response(JSON)
// Click 'Try now' to see the response