Skip to main content
POST
Create a new customer account

Request

string
required
Active production API key belonging to the merchant that will own the customer.
string
required
Exactly one given name. Spaces and numbers are not accepted.
string
required
Exactly one family name. Spaces and numbers are not accepted.
string
Optional single middle name. Do not combine multiple names in this field.
string
required
Non-empty email address. It must be unique within the authenticated merchant.
string
required
Non-empty mobile number retained by FossaPay.
string
required
Date of birth in YYYY-MM-DD format (e.g., 1990-08-15)
string
required
Address of the customer
string
required
City of the customer
string
required
Country of the customer
string
required
Customer account type. The only accepted value is individual; other values return HTTP 422 before provider processing.

Request Example

Response

string
Response status: success or error
number
HTTP status code (201 for successful creation)
string
Human-readable response message
object

Response Example

Errors

Store data.id in your database. Customer wallet and transfer operations require this UUID.

Authorizations

x-api-key
string
header
required

Body

application/json
firstName
string
required
lastName
string
required
emailAddress
string<email>
required
mobileNumber
string
required
dateOfBirth
string<date>
required
address
string
required
city
string
required
country
string
required
type
enum<string>
required
Available options:
individual
middleName
string
metadata
object

Response

Customer created successfully

status
enum<string>
required
Available options:
success,
error
statusCode
integer
required
message
string
required
data
object
required