...
Model | How it works |
|---|---|
Invoice | The host client will invoice the calling app periodically for all calls to the endpoint. |
Acceptable values for auth.type
bvn
Process flows
Sequence of calls
...
| Code Block | ||
|---|---|---|
| ||
{
"request_ref":"{{request_ref}}",
"request_type":"lookup_bvn_min",
"auth": {
"type": "bvn",
"secure": "{{encrypted_bvn}}",
"auth_provider": "Beeceptor",
"route_mode": null
},
"transaction": {
"mock_mode": "live",
"transaction_ref": "{{transaction_ref}}",
"transaction_desc": "A random transaction",
"transaction_ref_parent": null,
"amount": 0,
"customer":{
"customer_ref": "{{customer_id}}",
"firstname": "Uju",
"surname": "Usmanu",
"email": "ujuusmanu@gmail.com",
"mobile_no": "234802343132"
},
"meta":{
"a_key":"a_meta_value_1",
"b_key":"a_meta_value_2"
},
"details": {
"dob": "1990-09-12"
}
}
} |
...
| Code Block | ||
|---|---|---|
| ||
{
"status": "Successful",
"message": "Transaction processed successfully",
"data": {
"provider_response_code": "00",
"provider": "Beeceptor",
"errors": null,
"error": null,
"provider_response": {
"bvn": "22333055555",
"first_name": true,
"last_name": true,
"dob": true,
"reference": "98776665556665",
"meta":{}
}
}
} |
Request (validate with otp)
...
Field | Type | Requirement | Description |
|---|---|---|---|
bvn | string | compulsory | Customer bvn to look up |
otp_override | boolean | optional | Defaults to |
dob | date | optional | The date of birth to match in |
...