Error
A valid request URL is required to generate request examples{
"status": "00",
"message": "The process was completed successully",
"data": {
"customer_id": "1234567890",
"first_name": "Ado",
"middle_name": "John",
"surname": "Sule",
"gender": "M",
"email": "adojohn@example.com",
"bvn": "22112345678",
"phone": "2347031234567",
"image": "{{base64String2}}",
"proof_of_id": {
"document_type": "Driver's licence",
"document": "{{base64String2}}"
},
"proof_of_address": {
"document_type": "Utility bill",
"document": "{{base64String2}}"
},
"address": {
"street": "456 Johnson Street",
"area": "Akobo",
"city": "Ilesa",
"local_government": "Ilesa West",
"country": "NG"
},
"next_of_kin": {
"first_name": "Ado",
"middle_name": "John",
"surname": "Sule",
"gender": "M",
"email": "adajoanne@example.com",
"phone": "+2347031234567",
"relationship": "Sibling",
"address": {
"street": "456 Johnson Street",
"area": "Akobo",
"city": "Ilesa",
"local_government": "Ilesa West",
"country": "NG"
}
},
"custom_properties": [
{
"id": "Some random ID",
"description": "Some random text",
"type": "Some random type",
"value": "Some value"
}
]
}
}{
"status": "01",
"error_code": "MISSING_FIELD",
"message": "The field is missing",
"data": {}
}{
"status": "02",
"message": "The authentication failed",
"data": {}
}{
"status": "03",
"message": "You are not allowed to perform this operation",
"data": {}
}{
"status": "04",
"message": "The resource you are looking for does not exist",
"data": {}
}{
"status": "05",
"message": "An unknown error occurred",
"data": {}
}Customers
Get customer details
Retrieve detailed information about a customer
GET
/
customers
Error
A valid request URL is required to generate request examples{
"status": "00",
"message": "The process was completed successully",
"data": {
"customer_id": "1234567890",
"first_name": "Ado",
"middle_name": "John",
"surname": "Sule",
"gender": "M",
"email": "adojohn@example.com",
"bvn": "22112345678",
"phone": "2347031234567",
"image": "{{base64String2}}",
"proof_of_id": {
"document_type": "Driver's licence",
"document": "{{base64String2}}"
},
"proof_of_address": {
"document_type": "Utility bill",
"document": "{{base64String2}}"
},
"address": {
"street": "456 Johnson Street",
"area": "Akobo",
"city": "Ilesa",
"local_government": "Ilesa West",
"country": "NG"
},
"next_of_kin": {
"first_name": "Ado",
"middle_name": "John",
"surname": "Sule",
"gender": "M",
"email": "adajoanne@example.com",
"phone": "+2347031234567",
"relationship": "Sibling",
"address": {
"street": "456 Johnson Street",
"area": "Akobo",
"city": "Ilesa",
"local_government": "Ilesa West",
"country": "NG"
}
},
"custom_properties": [
{
"id": "Some random ID",
"description": "Some random text",
"type": "Some random type",
"value": "Some value"
}
]
}
}{
"status": "01",
"error_code": "MISSING_FIELD",
"message": "The field is missing",
"data": {}
}{
"status": "02",
"message": "The authentication failed",
"data": {}
}{
"status": "03",
"message": "You are not allowed to perform this operation",
"data": {}
}{
"status": "04",
"message": "The resource you are looking for does not exist",
"data": {}
}{
"status": "05",
"message": "An unknown error occurred",
"data": {}
}Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Headers
Connection ID for the target bank
Unique key to ensure idempotency of the request
SHA-256 signature of client_secret + ";" + idempotency-key