Create a user
Create a user
POST https://sandbox-api.com/v1/users
Returns the user object if successful. Returns an error if create parameters are invalid (e.g. specifying an invalid phone number or date of birth). Date of birth and ID number are not included in the response as they are sensitive personal data.
Request Body
address*
object
The user's address. For the address schema, see The user object.
middle_name
string
The user's middle name. Must pass the regex ^([aA-zZ]+[,.]?[ ]?|[aA-zZ]+['’-]?)+$
first_name*
string
The user's first name. Must pass the regex ^([aA-zZ]+[,.]?[ ]?|[aA-zZ]+['’-]?)+$
email*
string
The user's email address.
dob*
string
The user's date of birth, formatted as YYYY/MM/DD. The minimum age accepted is 18 years old.
credit_report_xml_gzip
string
The user's credit report, gzipped with base64 encoding.
ID number*
string
The user's national ID or passport number IDN). The IDN must be AES encrypted In CBC Mode using your secret_key (see Creating and Managing Users for more detail)
phone*
string
The user's phone number. Must be a valid phone number.
last_name*
string
The user's last name. Must pass the regex ^([aA-zZ]+[,.]?[ ]?|[aA-zZ]+['’-]?)+$
{
"uuid": "2acf04c3-48d1-456f-a54e-1m4251814478",
"first_name": "Blair",
"middle_name": "Cassidy",
"last_name": "Dufresne",
"citizenship": "CM",
"dwolla_customer_url": null,
"email": "[email protected]",
"phone": "+237676723456",
"address": {
"line_1": "5161 Stansfield Dr",
"line_2": null,
"line_3": null,
"zip": "18092",
"city": "Douala",
"region": "LT",
"country": "CAMEROUN"
}
}Last updated