Skip to main content
POST
Afriex SDK
You send the customer’s name as fullName, and responses return it as name. The same applies to Update Customer.

Authorizations

x-api-key
string
header
required

Static business API key issued from the dashboard. A business can provision multiple API keys, each scoped to a configurable set of permissions (e.g. read transactions, create deposits, etc). Permissions are chosen per key at creation time in the dashboard and may be revoked by deleting the key. Manage your keys and their permissions under Developer → API keys in the dashboard.

A request whose key does not carry the permission the target endpoint requires is rejected with 401 Unauthorized, the same response an unrecognised, malformed, revoked or disabled key returns. The API does not distinguish the two cases on the wire.

See the Permissions reference for the permission each endpoint requires.

Headers

x-api-signature
string

Signature of the request payload, used for request authentication where payload signing is enabled for your business.

x-api-version
string

API version in ISO 8601 format. The only supported version is 2026-05-18, which is also the default when the header is omitted. Any other value is rejected with a 400 Bad Request.

Body

application/json
fullName
string
required

The full name of the customer. Must not be empty.

Minimum string length: 1
Example:

"John Doe"

email
string<email>
required

The email address of the customer.

Example:

"john.doe@example.com"

phone
string
required

The phone number of the customer. It must be valid for countryCode; it is normalised to E.164 on save.

Example:

"+2348192837465"

countryCode
string
required

The ISO 3166-1 alpha-2 country code of the customer (e.g., 'NG', 'US'). Must be a supported country, otherwise the request fails with 400 INVALID_BUSINESS_CUSTOMER_REQUEST.

Example:

"NG"

meta
object

Optional meta data you can attach to the customer.

Response

Customer created successfully. Returns the newly created customer object.

data
object