igree

BVN verification

TEST DATA

number: 54651333604
channel: 0701***2345
otp: 123456

BVN information retrieval

POST {{BASE_URL}}/api/v2/biometrics/merchant/data/verification/bvn/igree

This endpoint allows you to get details of a BVN.

Headers

Name	Type	Description
x-api-key*	string	<your secret key>
app-id*	String	<your app id>

Request Body

Name	Type	Description
number*	string	bank verification number
mode*	String	INITIATE,SET_CHANNEL,FINALIZE
channel*	String	string of the contact to recieve OTP
otp*	String	the OTP sent to customer
verification_method	String	"email", "phone", "all"

200 "INITIATE" Response

{
    "status": true,
    "detail": "These are the contact details tied to your BVN. Choose where you want the OTP delivered.",
    "contacts": [
        "0810***7788"
    ]
}

200: OK "SET_CHANNEL" response

{
    "status": true,
    "detail": "Please provide the OTP sent to 0810***7788"
}

200: OK "FINALIZE" Response

{ "status":true,
 "response_code":"00",
 "data":
{
  "marital_status": "Divorcee",
  "gender": "Male",
  "surname": "Certifier", 
  "middle_name": "N",
  "first_name": "Nibby",
  "enroll_user_name": "Akinwale",
  "nationality": "Nigeria",
  "state_of_origin": "ebonyi state",
  "lga_of_origin": "Afikpo North",
  "nin": "920-466-4282",
  "phone_number2": "07089374787",
  "title": "Ms",
  "watchlisted": 901,
  "additional_info_1": "NC/",
  "DateOfBirth": "1976-11-30T00:00:00+01:00",
  "face_image": ""
}
}