curl -X POST 'https://api.yativo.com/api/v1/customer' \
-H 'X-Api-Key: YOUR_API_KEY' \
-H 'X-Api-Secret: YOUR_API_SECRET' \
-H 'Content-Type: application/json' \
-H 'Idempotency-Key: create-customer-alex-smith-001' \
-d '{
"customer_name": "Alex Smith",
"customer_email": "alex.smith@example.com",
"customer_phone": "+15551234567",
"customer_country": "USA",
"customer_type": "individual"
}'
{
"status": "success",
"status_code": 201,
"message": "Customer created successfully",
"data": {
"id": 1,
"customer_id": "c586066b-0f29-468f-b775-15483871a202",
"customer_name": "Alex Smith",
"customer_email": "alex.smith@example.com",
"customer_phone": "+15551234567",
"customer_country": "USA",
"customer_type": "individual",
"customer_status": "active",
"created_at": "2026-04-02T10:00:00.000000Z",
"updated_at": "2026-04-02T10:00:00.000000Z"
}
}
{
"status": "failed",
"status_code": 422,
"message": "Request failed.",
"data": {
"customer_email": ["The customer email has already been taken."]
}
}
Customers
Create Customer
Create a new customer profile for an individual or business
POST
/
customer
curl -X POST 'https://api.yativo.com/api/v1/customer' \
-H 'X-Api-Key: YOUR_API_KEY' \
-H 'X-Api-Secret: YOUR_API_SECRET' \
-H 'Content-Type: application/json' \
-H 'Idempotency-Key: create-customer-alex-smith-001' \
-d '{
"customer_name": "Alex Smith",
"customer_email": "alex.smith@example.com",
"customer_phone": "+15551234567",
"customer_country": "USA",
"customer_type": "individual"
}'
{
"status": "success",
"status_code": 201,
"message": "Customer created successfully",
"data": {
"id": 1,
"customer_id": "c586066b-0f29-468f-b775-15483871a202",
"customer_name": "Alex Smith",
"customer_email": "alex.smith@example.com",
"customer_phone": "+15551234567",
"customer_country": "USA",
"customer_type": "individual",
"customer_status": "active",
"created_at": "2026-04-02T10:00:00.000000Z",
"updated_at": "2026-04-02T10:00:00.000000Z"
}
}
{
"status": "failed",
"status_code": 422,
"message": "Request failed.",
"data": {
"customer_email": ["The customer email has already been taken."]
}
}
Create a customer record before initiating any KYC verification or payments for that customer.
POST /customer
Requires an
Idempotency-Key header.curl -X POST 'https://api.yativo.com/api/v1/customer' \
-H 'X-Api-Key: YOUR_API_KEY' \
-H 'X-Api-Secret: YOUR_API_SECRET' \
-H 'Content-Type: application/json' \
-H 'Idempotency-Key: create-customer-alex-smith-001' \
-d '{
"customer_name": "Alex Smith",
"customer_email": "alex.smith@example.com",
"customer_phone": "+15551234567",
"customer_country": "USA",
"customer_type": "individual"
}'
{
"status": "success",
"status_code": 201,
"message": "Customer created successfully",
"data": {
"id": 1,
"customer_id": "c586066b-0f29-468f-b775-15483871a202",
"customer_name": "Alex Smith",
"customer_email": "alex.smith@example.com",
"customer_phone": "+15551234567",
"customer_country": "USA",
"customer_type": "individual",
"customer_status": "active",
"created_at": "2026-04-02T10:00:00.000000Z",
"updated_at": "2026-04-02T10:00:00.000000Z"
}
}
{
"status": "failed",
"status_code": 422,
"message": "Request failed.",
"data": {
"customer_email": ["The customer email has already been taken."]
}
}
Authorizations
Your API key (yativo_pk_...) from Developers → API Keys. Send together with X-Api-Secret.
Your API secret (yativo_sk_...), shown once when the key is created.
Headers
A unique string per request to ensure idempotent processing.
Body
application/json
Full name of the customer (individual) or legal business name (business).
Example:
"Alex Smith"
Customer's email address. Must be unique per account.
Example:
"alex.smith@example.com"
Customer's phone number in E.164 format (e.g. +15551234567).
Example:
"+15551234567"
Customer's country of residence in ISO 3166-1 alpha-3 format (e.g. USA, BRA, MEX).
Example:
"USA"
Customer type: "individual" or "business".
Available options:
individual, business