BVN Full Details IGREE 🇳🇬

Overview

Introducing iGree, a consent management system developed with the collaboration of the Central Bank of Nigeria (CBN) and NIBSS. This system empowers customers to grant BVN data access when needed, ensuring data security and compliance.

🚧
Important!
Before you proceed, ensure you review the prerequisites for integrating to our APIs for a more detailed guide.

API Endpoint

https://api.verified.africa/sfx-verify/v3/id-service/

Initiate BVN Lookup

Headers

Our initiate BVN Lookup service accepts headers for authentication. See below the headers to pass to the API

Header	Type	Description
userId	String	This is your user id retrieved from the portal. Check the getting started article to understand how to retrieve your userId
ApiKey	String	This is your apikey retrieved from the portal. Check the getting started article to understand how to retrieve your apiKey

Request

Request Parameter	Status	Description	Test Data
verificationType	Required	This field is used to identify the service being called. Ensure to use the value provided exactly as provided	BVN-FULL-DETAILS-IGREE
searchParameter	Required	The BVN will be passed into this field	11223344556

{
    "verificationType": "BVN-FULL-DETAILS-IGREE",
    "searchParameter": "11223344556"
}

Response

responseParameter	Type	Description
responseCode	String	Please reference Response Codes page for details on all possible responses
Description	String	This is a description of the response received.
verificationType	String	The same verificationType passed in request will be returned here
verificationStatus	String	This field lets you know if the identity verification was successful. Options are: VERIFIED: This means that the initiate BVN Lookup is valid. NOT VERIFIED This means that the initiate BVN Lookup is invalid PENDING** This status means that the verification could not be completed. Refer to the responseCode for the specific failure reason
transactionStatus	String	This indicates the wallet debit status. The options are successful or failed.
transactionReference	String	If you supplied a transactionReference, the same will be returned here. Else, we would generate a reference and return that to you in this field.
transactionDate	String	Date the transaction was done
searchParameter	String	BVN used for the verification
response	Json	This is a json containing the BVN number passed and the various methods to be used to receive otp.

{
    "responseCode": "00",
    "description": "Successful",
    "verificationType": "BVN-FULL-DETAILS-IGREE",
    "verificationStatus": "VERIFIED",
    "transactionStatus": "SUCCESSFUL",
    "transactionReference": "1630321373727-1692390277346-48d6f635-2ce9-4a84-95fa-6a49c90f661b",
    "transactionDate": "1692387400392",
    "searchParameter": "11223344556",
    "callBackUrl": null,
    "livenessScore": 0.0,
    "paymentRef": null,
    "response": {
        "bvn": "11223344556",
        "methods": [
            {
                "method": "email",
                "hint": "An email with a verification code will be sent to test**[email protected]"
            },
            {
                "method": "phone",
                "hint": "Sms with a verification code will be sent to phone 088***8888"
            }
        ]
    },
    "faceMatch": null
}

Verify BVN OTP

Headers

Our service accepts headers for authentication. See below the headers to pass to the API

Header	Type	Description
userId	String	This is your user id retrieved from the portal. Check the getting started article to understand how to retrieve your userId
ApiKey	String	This is your apikey retrieved from the portal. Check the getting started article to understand how to retrieve your apiKey

Request

Request Parameter	Status	Description	Test Data
verificationType	required	This field is used to identify the service being called. Ensure to use the value provided exactly as provided	BVN-FULL-DETAILS-IGREE
transactionReference	required	This is a field that uniquely identifies your transaction. You are to pass the transactionReference gotten from the responseBody of Initiate BVN OTP service.	1630321373727-1692390277346-48d6f635-2ce9-4a84-95fa-6a49c90f661b
otpMethod	required	The method the user receives the OTP sent	phone, phone_1

{
    "verificationType": "BVN-FULL-DETAILS-IGREE",
    "transactionReference": "1630321373727-1692390277346-48d6f635-2ce9-4a84-95fa-6a49c90f661b",
    "otpMethod": "phone"
    }

Response

Response Parameter	Type	Description
responseCode	String	Please reference Response Codes page for details on all possible responses.
Description	String	This is a description of the response received.
verificationType	String	The same verificationType passed in request will be returned here.
verificationStatus	String	This field lets you know if the identity verification was successful. Options are: VERIFIED: This means that the OTP has been sent. NOT VERIFIED This means that the OTP has not been sent PENDING** This status means that the verification could not be completed. Refer to the responseCode for the specific failure reason
transactionStatus	String	This indicates the wallet debit status. The options are successful or failed.
transactionReference	String	If you supplied a transactionReference, the same will be returned here. Else, we would generate a reference and return that to you in this field.
transactionDate	String	Date the transaction was done
searchParameter	String	BVN used for the verification
response	Json	This is a json containing the status and the message.

{
    "responseCode": "00",
    "description": "Successful",
    "verificationType": "BVN-FULL-DETAILS-IGREE",
    "verificationStatus": "VERIFIED",
    "transactionStatus": "SUCCESSFUL",
    "transactionReference": "1630321373727-1692387497746-3a4f8748-15ad-403b-8e4f-881c83479dad",
    "transactionDate": "1692387501832",
    "searchParameter": "11223344556",
    "callBackUrl": null,
    "livenessScore": 0.0,
    "paymentRef": null,
    "response": {
        "status": "successful",
        "message": "Otp has been successfully sent to 088***8888"
    },
    "faceMatch": null
}

Fetch BVN Details

Header

Our initiate BVN Lookup service accepts headers for authentication. See below the headers to pass to the API

Header	Type	Description
userId	String	This is your user id retrieved from the portal. Check the getting started article to understand how to retrieve your userId
ApiKey	String	This is your apikey retrieved from the portal. Check the getting started article to understand how to retrieve your apiKey

Request

Request Parameter	Status	Description	Test Data
verificationType	Required	This field is used to identify the service being called. Ensure to use the value provided exactly as provided	BVN-FULL-DETAILS-IGREE
transactionReference	Required	This is a field that uniquely identifies your transaction. We generate this field if you leave it empty; however, we encourage you to generate it for proper reconciliation	1630321373727-1692390277346-48d6f635-2ce9-4a84-95fa-6a49c90f661b
otp	Required	The OTP sent to the user	123456

{
    "verificationType": "BVN-FULL-DETAILS-IGREE",
    "transactionReference": "1630321373727-1692390277346-48d6f635-2ce9-4a84-95fa-6a49c90f661b",
    "otp": "123456"
}

Response

Response Parameter	Type	Description
responseCode	String	Please reference Response Codes page for details on all possible responses
Description	String	This is a description of the response received.
verificationType	String	The same verificationType passed in request will be returned here
verificationStatus	String	This field lets you know if the identity verification was successful. Options are: VERIFIED: The BVN details is valid. NOT VERIFIED This means that the BVN details is not is invalid PENDING** This status means that the verification could not be completed. Refer to the responseCode for the specific failure reason
transactionStatus	String	This indicates the wallet debit status. The options are successful or failed.
transactionDate	String	Date the transaction was done
transactionReference	String	If you supplied a transactionReference, the same will be returned here. Else, we would generate a reference and return that to you in this field.
searchParameter	String	BVN used for the verification
response	json	This is a json containing all the actual BVN data as retrieved from the service provider.

{
    "responseCode": "00",
    "description": "Successful",
    "verificationType": "BVN-FULL-DETAILS-IGREE",
    "verificationStatus": "VERIFIED",
    "transactionStatus": "SUCCESSFUL",
    "transactionReference": "1630321373727-1692390304649-a0ae2dbb-d982-4805-8228-7eee8834bdd9",
    "transactionDate": "1692390309575",
    "searchParameter": "11223344556",
    "callBackUrl": null,
    "livenessScore": 0.0,
    "paymentRef": null,
    "response": {
        "firstName": "Foo",
        "middleName": "",
        "lastName": "Bar",
        "dob": "1906-09-05",
        "phoneNumber1": "08057438543",
        "registrationDate": "2018-03-26",
        "email": "[email protected]",
        "gender": "male",
        "lgaOforigin": "Abeokuta South",
        "lgaOfResidence": "Ikeja",
        "maritalStatus": "single",
        "nin": "0000000000",
        "stateOfOrigin": "Ogun State",
        "stateOfResidence": "Lagos State",
        "watchListed": false,
        "photoId": "/JC4nICIIyMjIyMjIyMjL/wAARCAGQASwDASIAAhEBAxEB/8QAHwAAAQUBAQEBAQEAAAAAAAAAAAECAwQFBgcICQoL/8QAtRAAAgEDAwIEAwUFBAQAAAF9AQIDAAQRBRIhMUEGE1FhByJxFDKBkaEII0KxwRVS0fAkM2JyggkKFhcYGRolJicoKSo0NTY3ODk6Q0RFRkdISUpTVFVWV1hZWmNkZWZnaGlqc3R1dnd4eXqDhIWGh4iJipKTlJWWl5iZmqKjpKWmp6ipqrKztLW2t7i5usLDxMXGx8jJytLT1NXW19jZ2uHi4//2Q=="
    },
    "faceMatch": null
}

Overview

🚧Important!

API Endpoint

Initiate BVN Lookup

Headers

Request

Response

Verify BVN OTP

Headers

Request

Response

Fetch BVN Details

Header

Request

Response

🚧
Important!