API Reference

Identity and Credit Check

To ensure customer consent for identity verification, the process will require an explicit validation from the customer. This validation step confirms the customer's agreement to have their identity verified using specific identifiers such as NIN, vNIN, BVN, and vBVN, CAC, and CREDITCHECK which should all be processed through the designated verification endpoint.


Process for BVN and NIN Verification

  1. Initiate Verification Request:

    • Start by initiating a verification request via the Initiate Verification endpoint. This action triggers an OTP (One-Time Password) to be sent to the customer's registered phone number.
    • Make sure to capture the _id returned in the response body of this initial request. This ID is crucial for the next step in the verification process.

  2. Validate the Verification:

    • With the OTP received by the customer, proceed to call the validation endpoint.
    • Provide the following parameters in your request:
      • identityId: The _id you captured from the initial request.
      • type: Specify the type of verification (either BVN or NIN).
      • otp: The OTP that was sent to the customer’s phone number.

  3. Receive Verified Information:

    • Upon successful validation, the customer's verified information will be returned. This data includes details tied to the specified BVN or NIN, confirming the identity of the customer.

Process for vBVN (BVNUSSD) Verification

  1. Customer Interaction:

    • The customer initiates the process by dialing *565*3# on their phone that is registered under their BVN (Bank Verification Number).
    • They will be prompted to enter their BVN followed by the iGree Code. For your service, the iGree Code is 11113.

  2. OTP Reception:

    • During this USSD session, an OTP (One-Time Password) will be generated and sent to the customer’s phone. This OTP is needed for the next step in the verification process.

  3. Initiate Verification Request:

    • In this request, set the type parameter to BVNUSSD and include the OTP received by the customer in the previous step.
    • Capture the _id that is returned in the response body of this request; this _id represents the verification identifier.

  4. Receive Verified Information:

    • Upon successful validation, the customer's verified information related to their BVN will be returned. This includes details such as name, date of birth, and other relevant personal information.