Skip to main content
POST
/
api
/
v1
/
customer
Create a new customer
curl --request POST \
  --url https://staging.afx-server.com/api/v1/customer \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "fullName": "John Doe",
  "email": "john.doe@example.com",
  "phone": "+2348192837465",
  "countryCode": "NG",
  "kyc": {},
  "meta": {}
}
'
{
  "data": {
    "customerId": "<string>",
    "fullName": "<string>",
    "email": "jsmith@example.com",
    "phone": "<string>",
    "countryCode": "<string>",
    "kyc": {},
    "meta": {}
  }
}
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 from the dashboard

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"

​
kyc
object

Optional KYC document details.

​
meta
object

Optional meta data you can attach to the customer.

Response

Customer created successfully. Returns the newly created customer object.

​
data
object