...

With this service, the calling apps can do KYC with the customer's BVNbvn. This services will only return minimal KYC information. Apps will collect authorisation details will forward the account number they will like to obtain information on and forward to OnePipe to execute a lookup; . 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.

Commercial model

N/A

Special configuration notes

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 appAt agreed settlement cycles, the host will debit the configured beneficiary account of the app for the use of this API and share that fee with all participants. Fees will be determined by the provider. Parties that share the fees are:

1. OnePipe

2. Host client

3. Provider

4. ISO

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.

• SMS handler: All providers that need to do OTP validation need to have otp_api_key, and otp_api_secret configured. They will use this to call the Send SMS and Send Email service on OnePipe to send their OTP.

Settlement & fees model

Depending on the provider implementation, this service supports any of the 3 models.

...

INTERFACE SPECIFICATION (APP → ONEPIPE)

Request

{
  "request_ref":"{{request_ref}}", 
  "request_type":"lookup_bvn_min",
  "auth": {
    "type": null, 
    "secure": null,
    "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": {
    	"bvn":"23632626327",
    	"otp_override": true
    }
  }
}

...