KYC Consent(BVN-iGree)

POST: https://api.creditchek.africa/v1/identity/bvn-verifcation/igree

Sample request bvn: 12345678901 and 12345678902

This endpoint is designed to facilitate BVN validation, allowing customers to verify their Bank Verification Number (BVN) by providing specific information. In order to validate their BVN, merchants are required to enter the BVN number, indicate the type of call they wish to make, select a verification method that suits their preference, choosing between the available options of "email", "phone", or "all". Then they input a channel which includes a string of the contact to receive the One-Time Password (OTP), and enter the OTP sent to the chosen channel.

This new system is to enable the collection of consent directly from the BVN holder, ensuring that their personal information is protected and their banking transactions are secure. Overall, the endpoint serves as a valuable tool for ensuring the accuracy and security of banking information.

Request Parameters

Name	Position	Required	Description
token	Headers	True	app public key
bvn	body	True	user Bank Verification Number
verification_method	body	False	preferred medium for users to recieve otp, options are "email" or "phone" and default is "all"
mode	body	True	This is used to indicate the particular type of call you want to make and can be set to either of these; INITIATE, SET_CHANNEL, FINALIZE
channel	body	False	String of the contact to recieve OTP
otp	body	False	The One-Time-Password received via email or phone number as chosen

Example Request

---
curl --location 'https://dev.creditchek.africa/v1/identity/bvn-verifcation/igree' \
--header 'token: {{token}}' \
--header 'Content-Type: application/json' \
--data '{
    "bvn": "22339999601",
    "mode": "INITIATE",
    "channel": "0815***8883",
    "otp": "1234"
}'
---

Sample Responses

INITIATE Response

{
  "status": true,
  "data": {
    "detail": "These are the contact details tied to your BVN. Choose where you want the OTP delivered.",
    "contacts": ["0815***8883"]
  },
  "message": "successful",
  "error": false
}

SET_CHANNEL Response

{
  "status": true,
  "data": {},
  "message": "Please provide the OTP sent to 0815***8883",
  "error": false
}

Finalize Response

{
  "status": true,
  "data": {
    "_id": "62c557a2471f088c5dc9fd4d",
    "businessId": "6287757348cc6c0013f4d0a0",
    "bvn": "12345678901",
    "__v": 0,
    "createdAt": "2022-07-06T09:36:34.140Z",
    "dateOfBirth": "21-Mar-1991",
    "email": "[email protected]",
    "enrollmentBank": "033",
    "enrollmentBranch": "OAU",
    "firstName": "Ikechukwu",
    "gender": "Male",
    "lastName": "OJO",
    "lgaOfOrigin": "Ijebu East",
    "lgaOfResidence": "Ife Central",
    "maritalStatus": "Single",
    "middleName": "DAMILOLA",
    "nameOnCard": "OJO IKECHUKWU",
    "nationality": "Nigeria",
    "nin": "77382885585",
    "phones": ["07084827835", "08153623409"],
    "photo": "https://res.cloudinary.com/creditchek-africa/image/upload/v1657100485/bvnData/ymxxbthze0imwwzk3fqb.jpg",
    "registrationDate": "",
    "residentialAddress": "OAU STAFF QTRS RD 9 IFE ",
    "stateOfOrigin": "Ogun State",
    "stateOfResidence": "Osun State",
    "title": "",
    "updatedAt": "2022-07-06T09:41:25.667Z",
    "verification": {
      "status": "VERIFIED",
      "reference": "24d49e42-4237-4eab-835c-c7d0fd7a66ea"
    },
    "watchListed": "NO"
  },
  "message": "successful",
  "error": false
}