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.

All file links (e.g. selfie URLs, document URLs) returned in the response expire within one hour. We strongly recommend transferring these documents and images to your own infrastructure as soon as you receive them. If a link expires before you are able to download the file, call the Fetch Address Verification Data endpoint to generate a new link β€” which will also expire in one hour.

Request

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

Body parameter

ParameterTypeDescriptionRequired
first_namestringFirst name of Individualrequired
last_namestringLast name of Individualrequired
middle_namestringMiddle name of Individualoptional
dobstringDate of Birth of Individual in this format (yyyy-mm-dd)optional
genderstringGender of Individualoptional
mobilestringActive Mobile Number of Individualrequired
streetstringHouse number, Street namerequired
landmarkstringClosest landmark to the streetoptional
lgastringLGArequired
statestringStaterequired

Sample response

Response
{
    "entity": {
        "status":"pending" ,
        "reference_id": "69e10264-4b90-64fe-b4b7-c9dddafd0241"
    }
}

Response Fields

FieldTypeDescription
entityobjectContains the response data
entity.statusstringVerification request status. Values: pending (verification in progress), completed (verification finished), failed (verification could not be completed)
entity.reference_idstringUnique reference ID for tracking this verification request. Use this ID to fetch verification results later