curl -X POST "{{base_url}}/card/create-user" \
-H "x-api-key: YOUR_CONSUMER_KEY" \
-H "Content-Type: application/json" \
-d '{
"first_name": "Ada",
"last_name": "Lovelace",
"email": "ada@example.com",
"phone": "254712345678",
"country": "KE",
"state": "Nairobi",
"city": "Nairobi",
"address": "1 Market Street",
"zip_code": "00100",
"id_type": "National_ID",
"id_number": "A12345678"
}'
{
"code": 200,
"message": "Card user created.",
"data": {
"user_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"email": "ada@example.com",
"name": "Ada Lovelace"
}
}
Cards
Create card user
Register a cardholder and receive the user_id used by the other card endpoints.
POST
/
card
/
create-user
curl -X POST "{{base_url}}/card/create-user" \
-H "x-api-key: YOUR_CONSUMER_KEY" \
-H "Content-Type: application/json" \
-d '{
"first_name": "Ada",
"last_name": "Lovelace",
"email": "ada@example.com",
"phone": "254712345678",
"country": "KE",
"state": "Nairobi",
"city": "Nairobi",
"address": "1 Market Street",
"zip_code": "00100",
"id_type": "National_ID",
"id_number": "A12345678"
}'
{
"code": 200,
"message": "Card user created.",
"data": {
"user_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"email": "ada@example.com",
"name": "Ada Lovelace"
}
}
Creates a cardholder on your partner account. Email and ID number must not already be registered. Use
The response is a short card user:
data.user_id when you create a card.
string
required
Cardholder given name.
string
required
Cardholder family name.
string
required
Email address. Must be unique.
string
required
Phone number.
string
required
Country.
string
required
State or region.
string
required
City.
string
required
Street address.
string
required
Postal code.
string
required
National_ID, Passport, or Driving_License.string
required
Government ID number. Must be unique.
user_id, email, and name. Address and ID fields are stored and are not echoed back.
Errors
| Message | When |
|---|---|
| First validator error | A required field is missing, email is not an email, or id_type is not one of the allowed values |
The email has already been taken. | Email is already registered |
The id number has already been taken. | ID number is already registered |
An unexpected error occurred. Please try again. | The cardholder could not be created |
curl -X POST "{{base_url}}/card/create-user" \
-H "x-api-key: YOUR_CONSUMER_KEY" \
-H "Content-Type: application/json" \
-d '{
"first_name": "Ada",
"last_name": "Lovelace",
"email": "ada@example.com",
"phone": "254712345678",
"country": "KE",
"state": "Nairobi",
"city": "Nairobi",
"address": "1 Market Street",
"zip_code": "00100",
"id_type": "National_ID",
"id_number": "A12345678"
}'
{
"code": 200,
"message": "Card user created.",
"data": {
"user_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"email": "ada@example.com",
"name": "Ada Lovelace"
}
}