Skip to main content
POST
/
api
/
v1
/
customer
curl --request POST \
  --url https://sandbox.api.afriex.com/api/v1/customer \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "fullName": "Jane Smith",
  "email": "jane.smith@example.com",
  "phone": "+2348192837465",
  "countryCode": "NG"
}
'
{
  "data": {
    "name": "Jane Smith",
    "email": "jane.smith@example.com",
    "phone": "+2348192837465",
    "customerId": "69d5ffe1ab82306f11b032f3",
    "countryCode": "NG",
    "createdAt": "2026-04-08T07:12:33.519Z",
    "updatedAt": "2026-04-08T07:12:33.519Z"
  }
}
Create a new customer for your business. Customers can be created with optional KYC (Know Your Customer) information for enhanced verification.

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. Requests made with a key that does not include the permission required by the target endpoint will be rejected with a 403 Forbidden response; an unrecognised, malformed or revoked key returns 401 Unauthorized. Manage your keys and their permissions under Developer → API keys in the dashboard.

Headers

​
x-api-version
string

API version in ISO 8601 format (e.g. 2025-12-28). Defaults to latest stable.

Body

application/json
​
fullName
string
required

The full name of the customer.

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.

Example:

"+2348192837465"

​
countryCode
string
required

The ISO 3166-1 alpha-2 country code of the customer (e.g., 'NG', 'US').

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