Skip to main content
POST
/
customers
Register new customer
curl --request POST \
  --url https://api.cartevo.co/api/v1/customers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form [email protected] \
  --form first_name=John \
  --form last_name=Doe \
  --form country=Nigeria \
  --form 'street=123 Main Street' \
  --form city=Lagos \
  --form 'state=Lagos State' \
  --form postal_code=100001 \
  --form country_iso_code=CM \
  --form 'country_phone_code=+234' \
  --form phone_number=8012345678 \
  --form identification_number=12345678901 \
  --form id_document_type=NIN \
  --form date_of_birth=1990-01-15 \
  --form id_document_front='@example-file' \
  --form id_document_back='@example-file'
{
  "success": true,
  "statusCode": 200,
  "message": "Data retrieved successfully",
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "first_name": "<string>",
    "last_name": "<string>",
    "country": "<string>",
    "email": "[email protected]",
    "street": "<string>",
    "city": "<string>",
    "state": "<string>",
    "postal_code": "<string>",
    "phone_country_code": "<string>",
    "phone_number": "<string>",
    "identification_number": "<string>",
    "type": "<string>",
    "image": "<string>",
    "photo": "<string>",
    "number": "<string>",
    "date_of_birth": "2023-11-07T05:31:56Z",
    "is_active": true,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
enroll
string

Enroll customer on Provider

Example:

"true"

Body

multipart/form-data
​
email
string<email>
required
​
first_name
string
required
Required string length: 3 - 255
Example:

"John"

​
last_name
string
required
Required string length: 3 - 255
Example:

"Doe"

​
country
string
required
Required string length: 2 - 255
Example:

"Nigeria"

​
street
string
required
Required string length: 2 - 255
Example:

"123 Main Street"

​
city
string
required
Required string length: 2 - 255
Example:

"Lagos"

​
state
string
required
Required string length: 2 - 255
Example:

"Lagos State"

​
postal_code
string
required
Required string length: 3 - 255
Example:

"100001"

​
country_iso_code
string
required
Required string length: 1 - 255
Example:

"CM"

​
country_phone_code
string
required
Required string length: 1 - 255
Example:

"+234"

​
phone_number
string
required
Required string length: 3 - 255
Example:

"8012345678"

​
identification_number
string
required
Required string length: 1 - 255
Example:

"12345678901"

​
id_document_type
enum<string>
required
Available options:
NIN,
PASSPORT,
VOTERS_CARD,
DRIVERS_LICENSE
Example:

"NIN"

​
date_of_birth
string<date>
required
Example:

"1990-01-15"

​
id_document_front
file
required
​
id_document_back
file

Response

Customer registered successfully

​
success
boolean
Example:

true

​
statusCode
integer
Example:

200

​
message
string
Example:

"Data retrieved successfully"

​
data
object