...
With this service, the calling apps can do KYC with the customer's account number. This service will return maximum KYC information. Apps will forward the account number they will like to obtain information on and forward it to OnePipe. If authorisation authorization details are required by a provider, apps will have to provide this. OnePipe will in turn forward to the provider’s dedicated implementation.
...
| 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_currency": "NGN",
"account_number": "1020123456",
"account_name": "BOLA SALAMI",
"last_name": "SALAMI",
"middle_name": "-",
"first_name": "BOLA",
"gender": "Male",
"dob": "1971-03-12T00:00:00",
"account_branch": "101",
"scheme_code": "SAV",
"bvn": "22211055555",
"account_status": "ACCOUNT OPEN",
"ledger_balance": 2524.59,
"available_balance": 2524.59,
"kyc_level": "3",
"name_enquiry_id": "0000028301",
"address1": "9 LIGALI STREET",
"address2": ".",
"address3": "IBADAN",
"email": "BOLASALAMI@yahoo.com",
"mobile_number": "080913333333",
}
}
} |
Request (validate with otp)
| Code Block | ||
|---|---|---|
| ||
{ "responserequest_coderef": "00"{{request_ref}}", "response_message"request_type": "Successlookup_account_max", "auth": { "user_message": "Success" } } } |
Request (validate with otp)
| Code Block | ||
|---|---|---|
| ||
{
"request_ref":"{{request_ref}}",
"request_type":"lookup_account_max",
"auth": {
"secure": "{{encrypted_otp}}",
"auth_provider": "Beeceptor"
},
"transaction": {
"transaction_ref": "70713093460718"
}
} |
...
Field | Type | Requirement | Description |
|---|---|---|---|
request_ref | string | compulsory | Takes unique value for every request made to OnePipe |
request_type | string | compulsory | This should be set to the service |
auth.type | string | N/A | This can be set to |
auth.secure | string | N/A | This can be set to |
auth.provider | string | compulsory | This should be set to the name of the Provider |
auth.route_mode | string | N/A | This can be set to |
transaction.mock_mode | string | optional | This can be set to either |
transaction.transaction_desc | string | optional | Description of your transaction |
transaction.transaction_ref_parent | string | optional | Takes the value of a (parent) transaction reference |
transaction.customer.customer_ref | string | compulsory | Identifier for customer |
transaction.customer.firstname | string | optional | First name of customer |
transaction.customer.surname | string | optional | Surname of customer |
transaction.customer.email | string | optional | Email The email address of the customer |
transaction.customer.mobile_no | string | optional | Phone number of customer |
transaction.amount | big int | compulsory | This can be set to |
transaction.transaction_ref | string | compulsory | Takes unique value for every transaction call to OnePipe. |
transaction.meta | object | optional | Json JSON object of your arbitrary transaction parameters |
transaction.details | object | compulsory | Holds defined fields peculiar to this service |
...
Field | Type | Requirement | Description |
|---|---|---|---|
account_number | string | compulsory | Customer account number to look uplookup |
otp_override | boolean | optional | Defaults to |
...
| Code Block |
|---|
{
"status": "Successful",
"message": "Transaction processed successfully",
"data": {
"provider_response_code": "00",
"provider": "Beeceptor",
"errors": null,
"error": null,
"provider_response": {
"customer_id": "007935125", "errors": null,
"account_currencyerror": "NGN",
null,
"accountprovider_numberresponse": "1020123456",{
"accountcustomer_nameid": "BOLA SALAMI007935125",
"lastaccount_namecurrency": "SALAMINGN",
"middleaccount_namenumber": "-1020123456",
"firstaccount_name": "BOLA SALAMI",
"genderlast_name": "MaleSALAMI",
"dobmiddle_name": "1971-03-12T00:00:00",
"accountfirst_branchname": "101BOLA",
"scheme_codegender": "SAVMale",
"bvndob": "222110555551971-03-12T00:00:00",
"account_statusbranch": "ACCOUNT OPEN101",
"ledgerscheme_balancecode": 2524.59"SAV",
"available_balancebvn": 2524.59"22211055555",
"kycaccount_levelstatus": "3ACCOUNT OPEN",
"nameledger_enquiry_idbalance": "0000028301"2524.59,
"address1available_balance": "9 LIGALI STREET"2524.59,
"address2kyc_level": ".3",
"address3name_enquiry_id": "IBADAN0000028301",
"emailaddress1": "BOLASALAMI@yahoo.com9 LIGALI STREET",
"mobile_numberaddress2": "080913333333.",
"response_codeaddress3": "00IBADAN",
"response_messageemail": "SuccessBOLASALAMI@yahoo.com",
"usermobile_messagenumber": "Success080913333333"
}
}
} |
Request (validate with otp)
...
Whenever a request is to be validated by OTP, the provider microservice should first call the provider, store response info in the database, then respond with WaitingForOTP.
On the OTP validation leg, if user OTP is valid, the provider should retrieve info from the database, then respond with a Successful response.
NB: Data should be erased from the DB.
...