curl -X POST https://sandbox.core.linkio.world/api/customers/onboard \
-H "X-BRIDGE-API-Key: $BRIDGE_API_KEY" \
-H "API-Version: 2026-10-29-atlas" \
-H "Content-Type: application/json" \
-d '{
"type": "retail",
"details": {
"first_name": "Ada",
"last_name": "Obi",
"email": "ada@example.com",
"phone": "+2348012345678"
}
}'
{
"id": "cus_4hT9pL2mQx8VnR3tY7wZ1cB5dE",
"type": "retail",
"name": "Ada Obi",
"email": "ada@example.com",
"phone": "+2348012345678",
"address": null,
"country": null,
"metadata": {}
}
{
"error": {
"type": "validation_error",
"code": "validation_failed",
"message": "Request validation failed",
"request_id": "req_3VnR7tY1wZ4cB6dE8fK2mQ9xLp",
"status": 422,
"errors": [
{ "field": "details.last_name", "message": "last_name is required" }
]
}
}
Customers
Add a customer
Create a person or company that can make payments.
POST
/
customers
/
onboard
curl -X POST https://sandbox.core.linkio.world/api/customers/onboard \
-H "X-BRIDGE-API-Key: $BRIDGE_API_KEY" \
-H "API-Version: 2026-10-29-atlas" \
-H "Content-Type: application/json" \
-d '{
"type": "retail",
"details": {
"first_name": "Ada",
"last_name": "Obi",
"email": "ada@example.com",
"phone": "+2348012345678"
}
}'
{
"id": "cus_4hT9pL2mQx8VnR3tY7wZ1cB5dE",
"type": "retail",
"name": "Ada Obi",
"email": "ada@example.com",
"phone": "+2348012345678",
"address": null,
"country": null,
"metadata": {}
}
{
"error": {
"type": "validation_error",
"code": "validation_failed",
"message": "Request validation failed",
"request_id": "req_3VnR7tY1wZ4cB6dE8fK2mQ9xLp",
"status": 422,
"errors": [
{ "field": "details.last_name", "message": "last_name is required" }
]
}
}
Requires the Customers scope (write). See Onboard a customer for a walkthrough.
Headers
string
default:"2026-10-29-atlas"
required
Your account’s API version.
Body
string
required
retail for a person, business for a company.object
required
Show retail fields
Show retail fields
Response
201 Created. The customer is returned at the top level.
string
Customer ID, starting with
cus_.string
retail or business.string
Full name or company name.
string
Email address.
string | null
Phone number.
string | null
Address.
string | null
Country.
object
Extra information.
Errors
| Status | Code | Why |
|---|---|---|
422 | validation_failed | A field is missing or invalid. errors lists each one. |
curl -X POST https://sandbox.core.linkio.world/api/customers/onboard \
-H "X-BRIDGE-API-Key: $BRIDGE_API_KEY" \
-H "API-Version: 2026-10-29-atlas" \
-H "Content-Type: application/json" \
-d '{
"type": "retail",
"details": {
"first_name": "Ada",
"last_name": "Obi",
"email": "ada@example.com",
"phone": "+2348012345678"
}
}'
{
"id": "cus_4hT9pL2mQx8VnR3tY7wZ1cB5dE",
"type": "retail",
"name": "Ada Obi",
"email": "ada@example.com",
"phone": "+2348012345678",
"address": null,
"country": null,
"metadata": {}
}
{
"error": {
"type": "validation_error",
"code": "validation_failed",
"message": "Request validation failed",
"request_id": "req_3VnR7tY1wZ4cB6dE8fK2mQ9xLp",
"status": 422,
"errors": [
{ "field": "details.last_name", "message": "last_name is required" }
]
}
}
Last modified on October 29, 2026
Was this page helpful?