Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.dojah.io/llms.txt

Use this file to discover all available pages before exploring further.

To ensure that your customer is who they say they are, you can allow them take a selfie photo which you can pass on to the Dojah for verification process This helps to significantly reduce the possibility of fraud by confirming the person inputting the BVN is who they say they really are

​
Request

[POST]
{{baseUrl}}/api/v1/kyc/bvn/verify
HeaderTypeDescription
AppIdstringCreate an app to get your app ID on dashboard here
AuthorizationstringPrivate/secret key. Use <key> not Bearer <key>

​
Body parameters

ParameterTypeDescriptionRequired
selfie_imagestringBase64 value of the selfie image NB: Kindly truncate data:image/jpeg;base64, from the selfie_image object and pass only the buffer starting with /9.required
bvnstringA Valid BVN Numberrequired
Confidence Values range from 0% to 100%
  • 0% - 90% denote match value is false
  • 90% - 100% denote match value is true

​
Response

Response
 {
    "entity": {
        "bvn": "1234567890",
        "first_name": "JOHN",
        "middle_name": "DOE",
        "last_name": "MUSA",
        "date_of_birth": "01-January-1907",
        "phone_number1": "08103817187",
        "phone_number2": "",
        "gender": "Male",
        "image": "/9j/4AAQSkZJRgABAgAAAQABAAD/2wBDAAgGBgcGBQgHBwcJCQgKD...",
        "selfie_verification": {
            "confidence_value": 99.99620056152344,
            "match": true
        },
        "selfie_image_url": "https://image-rekognitions.s3.amazonaws.com/bvn_n_selfie_172.jpg"
    }
}

​
Response Fields

FieldTypeDescription
entityobjectContains the BVN verification response data
entity.bvnstringThe Bank Verification Number
entity.first_namestringFirst name of the BVN holder
entity.middle_namestringMiddle name of the BVN holder
entity.last_namestringLast name of the BVN holder
entity.date_of_birthstringDate of birth of the BVN holder (DD-MMMM-YYYY, e.g., 01-January-1907)
entity.phone_number1stringPrimary phone number associated with the BVN
entity.phone_number2stringSecondary phone number associated with the BVN (may be empty)
entity.genderstringGender of the BVN holder
entity.imagestringBase64-encoded photo from the BVN record
entity.selfie_verificationobjectSelfie verification result comparing the submitted selfie to the BVN photo
entity.selfie_verification.confidence_valuenumberConfidence score of the selfie match (0–100). Values below 90 indicate no match
entity.selfie_verification.matchbooleanWhether the selfie matches the BVN photo (true if confidence ≥ 90)
entity.selfie_image_urlstringURL of the uploaded selfie image stored on S3

​
Test Credentials for Sandbox

Kindly use this Test BVN in sandbox Environment bvn = 22222222222