BVN Full Details🇳🇬

Overview

The BVN Full details service accepts the BVN and returns detailed information on the BVN verification. This article will guide you on how to integrate to the BVN Full Details Service.

🚧
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/

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
searchParameter	Required	The BVN will be passed into this field	12345678901
verificationType	Required	This field is used to identify the service being called. Ensure to use the value provided exactly as provided	BVN-FULL-DETAILS

{
    "searchParameter": "12345678901",
    "verificationType":"BVN-FULL-DETAILS"
}

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 BVN is valid. NOT VERIFIED This means that the BVN 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 all the actual BVN data as retrieved from the service provider.

{
    "responseCode": "00",
    "description": "Successful",
    "verificationType": "BVN-FULL-DETAILS",
    "verificationStatus": "VERIFIED",
    "transactionStatus": "SUCCESSFUL",
    "transactionReference": "1630321373727-1696857775364-905d8b67-57cb-4a4b-9458-2f84da5d590f",
    "transactionDate": "1696857779251",
    "searchParameter": "12345678901",
    "callBackUrl": null,
    "livenessScore": 0.0,
    "paymentRef": null,
    "response": {
        "email": "",
        "gender": "male",
        "dob": "04-09-1970",
        "phone": "23490123456",
        "country": "nigeria",
        "nin": "00000000000",
        "bvn": "12345678901",
        "nationality": "Nigeria",
        "watchlisted": false,
        "avatar": "",
        "full_name": "ABDULHAKEEM CHIBUZOR IDOWU",
        "first_name": "ABDULHAKEEM",
        "middle_name": "CHIBUZOR",
        "last_name": "IDOWU",
        "alternate_phone": "23490123456",
        "state_of_origin": "Ogun State",
        "state_of_residence": "Lagos State",
        "lga_of_origin": "Ekiti, Kwara State",
        "lga_of_residence": "Ilorin West",
        "address_line_2": "Ogun State",
        "address_line_3": "nigeria",
        "marital_status": "married",
        "enrollment_bank": "000",
        "enrollment_branch": "ILORIN 23",
        "account_level": "Level 1"
    },
    "faceMatch": null
}