...
With this service, the calling apps can KYC a customer's account number or other authorization details like cards or wallets. This service will only return minimal KYC information. Apps will collect the account number they will like to obtain information on and forward it to OnePipe. If authorization details are required by a provider, apps will have to provide this. OnePipe will in turn forward to the provider’s dedicated implementation.
...
Special configuration notes
OTP override: All providers of this service should implement OTP, but support the configuration of otp_override such that based on this configuration, they could be instructed to bypass the OTP requirement for an app.
Settlement & fees model
Model | How it works |
|---|---|
Invoice | The host client will invoice the calling app periodically for all calls to the endpoint. |
...
| Code Block | ||
|---|---|---|
| ||
{
"request_ref":"{{request_ref}}",
"request_type":"lookup_account_min",
"auth": {
"type": "bank.account | card",
"secure": "{{encrypted_secure}}",
"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": {
"otp_override": true
}null
}
} |
Response (when otp_override = false)
...
| Code Block | ||
|---|---|---|
| ||
{
"status": "Successful",
"message": "Transaction processed successfully",
"data": {
"provider_response_code": "00",
"provider": "Beeceptor",
"errors": null,
"error": null,
"provider_response": {
"customer_id": "007935125",
"account_name": "BOLA SALAMI",
"account_number": "1780161243",
"last_name": "SALAMI",
"first_name": "BOLA",
"middle_name": "-",
"gender": "Female",
"account_currency": "NGN",
"dob": "1993-04-18T00:00:00yyyy-MM-dd-HH-mm-ss"
}
}
} |
Request (validate with otp)
...
| Code Block |
|---|
{
"status": "Successful",
"message": "Transaction processed successfully",
"data": {
"provider_response_code": "00",
"provider": "Beeceptor",
"errors": null,
"error": null,
"provider_response": {
"customer_id": "007935125",
"account_name": "BOLA SALAMI",
"account_number": "1780161243",
"last_name": "SALAMI",
"first_name": "BOLA",
"middle_name": "-",
"gender": "Female",
"account_currency": "NGN",
"dob": "1993-04-18T00:00:00yyyy-MM-dd-HH-mm-ss"
}
}
} |
Failed Response
In the case of failure or error, the provider should return failure message in this format (encrypted).
...
Dependencies
| Note |
|---|
This service will may use the send_otp and validate_otp services behind the scenes to handle the OTP authentication process. Alternatively, it may use the send_sms or send_email services. These services should be invoked by the provider using the API key of the calling app. As such, these services need to be enabled for the calling app as well, otherwise this request would fail. |
...