Customers
Create customer
Requires api:write scope and Idempotency-Key.
POST
/
customers
Create customer
curl --request POST \
--url http://localhost:4000/v1/customers \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"name": "<string>",
"email": "jsmith@example.com"
}
'const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({name: '<string>', email: 'jsmith@example.com'})
};
fetch('http://localhost:4000/v1/customers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "http://localhost:4000/v1/customers"
payload = {
"name": "<string>",
"email": "jsmith@example.com"
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"status": "success",
"message": "Customer created",
"data": {
"id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
"name": "Jane Supplier",
"email": "jane@supplier.co.ke",
"type": "individual",
"isPrimary": false,
"createdAt": "2026-06-26T12:00:00.000Z",
"updatedAt": "2026-06-26T12:00:00.000Z"
}
}Authorizations
API key created in the Remitflex Dashboard at dashboard.remitflex.io (rmf_live_... or rmf_test_...).
Key management endpoints require a dashboard JWT and are not part of this reference.
Headers
Unique key for safe retries on mutating API-key requests. Cached for 24 hours per org, method, and path.
Maximum string length:
255Example:
"7f3c2a1b-4e5d-6c7b-8a9f-0e1d2c3b4a5f"
Body
application/json
Full legal name (at least first and last). Required shape for cNGN BVN identity matching — single given names are rejected.
Required string length:
2 - 120Maximum string length:
255Available options:
individual, business ⌘I
Create customer
curl --request POST \
--url http://localhost:4000/v1/customers \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"name": "<string>",
"email": "jsmith@example.com"
}
'const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({name: '<string>', email: 'jsmith@example.com'})
};
fetch('http://localhost:4000/v1/customers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "http://localhost:4000/v1/customers"
payload = {
"name": "<string>",
"email": "jsmith@example.com"
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"status": "success",
"message": "Customer created",
"data": {
"id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
"name": "Jane Supplier",
"email": "jane@supplier.co.ke",
"type": "individual",
"isPrimary": false,
"createdAt": "2026-06-26T12:00:00.000Z",
"updatedAt": "2026-06-26T12:00:00.000Z"
}
}