Account Creation - Address Verification

Create customized accounts for customers. These accounts are upgraded upon successful validation of BVN and NIN.

How does it work?

The Account Creation API allows clients request the creation of accounts, which can be upgraded to higher tiers upon successful physical verification of the home addresses of the customers. These accounts can only be managed and operated using the channel or application of choice by the requesting client.

The client makes a request on behalf of the customer to generate an account.
The client gets a PENDING status of while awaiting account generation.
Client receives a notification of account details via a callback URL.
Generated accounts are upgraded to higher tiers upon successful verification of customer's home address. Verification of addresses is managed independently by the bank.

Subscribe to Product

Go Live

Step 1 - Generate Account

Request URL

POST - {baseURL}/partnership-address-verification/api/CustomerAccount/GeneratePartnershipAccount

Try it out !

Client initiates request on behalf of customer using the request model below.
Client is required to pass a valid x-api-key value in the header of their request. This value would be provided by the bank.
Customer's NIN, BVN and address are mandatory.
A successful call to this endpoint would
- check validity of NIN and BVN provided. Note, failed validation of NIN and BVN would terminate the process.
- send SMS OTP to the phone number on NIN to ascertain customer's consent.
- a trackingId is returned to the client to be used for validation of NIN in step 2 below.
Client proceeds to step 2, in order to validate NIN.

Step 2 - Validate NIN

Request URL

POST - {baseURL}/partnership-address-verification/api/CustomerAccount/ValidateOtpAndGeneratePartnershipAccount

Try it out !

Client provides a medium/interface for customer to input OTP received from step 1.
Client initiates request on behalf of customer by sending otp, trackingIdandphoneNumber used in step 1 above.
Client is required to pass a valid x-api-key value in the header of their request. Same as in step 1
A successful call to this endpoint would return a PENDING status of wallet generation. The wait time for wallet generation is a maximum of 10 minutes.
Client receives a callback once account generation process is completed. The callback model can be seen below.

Note

A tier 1 account would be opened immediately OTP validation is done.
Account would remain operational as tier 1 pending upgrade.
Upgrade to higher tiers would take place after successful physical verification of the customer's address by the bank.
Failed address verification would require the client to resubmit address details using step 4.

Step 3 - Get Partnership Account Details

Request URL

POST - {baseURL}/partnership-address-verification/api/CustomerAccount/GetPartnershipAccountDetails[?phoneNumber]

Try it out !

This is a GET endpoint that helps client retrieve details of the generated account for customers.
It accepts the customer's phoneNumber as query parameter.
Expected response model can be seen below.