Overview
With this service, the calling apps can do KYC with the customer's bvn. This service will return maximum KYC information. Apps will collect the account number they will like to obtain information on and forward to OnePipe. If authorisation details are required by a provider, apps will have to provide this. OnePipe will in turn forward to the provider’s dedicated implementation.
...
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
Type | Description |
|---|---|
bvn | Specifies that encrypted value in |
Process flows
Sequence of calls
...
| Code Block | ||
|---|---|---|
| ||
{
"request_ref":"{{request_ref}}",
"request_type":"lookup_bvn_max",
"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",
"another_key":"a_meta_value_2"
},
"details": {
"include_image": true
}
}
} |
...
| Code Block | ||
|---|---|---|
| ||
{
"status": "Successful",
"message": "Transaction processed successfully",
"data": {
"provider_response_code": "00",
"provider": "Beeceptor",
"errors": null,
"error": null,
"provider_response": {
"reference": "98776665556665",
"bvn": "22333055555",
"first_name": "John",
"middle_name": "Jane",
"last_name": "Doe",
"dob": "1990-12-22",
"phone_number_1number1": "07037608648",
"phone_number_2number2": "",
"registration_date": "1990-12-22",
"enrollment_bank": "011",
"enrollment_branch": "MATORI",
"email": "john.doe@gmail.com",
"gender": "Male",
"level_of_account": "Level 2 - Medium Level Accounts",
"lga_of_origin": "Owerri West",
"lga_of_residence": "Ikeja",
"marital_status": "Single",
"nin": "77766492344",
"name_on_card": "John Jane Doe",
"nationality": "Nigeria",
"residential_address": "34, Banjo Street, Ikeja, Lagos",
"state_of_origin": "Imo State",
"state_of_residence": "Lagos State",
"title": "Mr",
"watchlisted": "NO",
"base64_image": "{{Base64Image}}",
"meta":{}
}
}
} |
Request (validate with otp)
| Code Block | ||
|---|---|---|
| ||
{
"request_ref":"{{request_ref}}",
"request_type":"lookup_bvn_max",
"auth": {
"secure": "{{encrypted_otp}}",
"auth_provider": "Beeceptor"
},
"transaction": {
"transaction_ref": "70713093460718"
}
} |
Acceptable values for auth.type
...
Type
...
Description
...
bvn
...
Breakdown of the details object
...