Get Verification Details by Reference ID

Request

[GET]

{{baseUrl}}/api/v1/kyc/verification

Header	Type	Description
AppId	string	Create an app to get your app ID on dashboard here
Authorization	string	Private/secret key. Use `<key>` not `Bearer <key>`

Query parameters

Parameter	Type	Description	Required
reference_id	string	Reference ID of Verification on the Dashboard	required

All file links (e.g. selfie URLs, ID image 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 this endpoint again to generate a new link — which will also expire in one hour.

Response

{
    aml: {
        status: false
    },
    data: {
        id: {
            data: {
                id_url: "https://images.dojah.io/id_sample_id_1720624047.jpg",
                id_data: {
                    extras: "",
                    last_name: "Musa",
                    first_name: "John",
                    mrz_status: "",
                    date_issued: "2019-01-01",
                    expiry_date: "2020-01-01",
                    middle_name: "",
                    nationality: "Nigerian",
                    date_of_birth: "1990-01-01",
                    document_type: "National ID",
                    document_number: "123456789"
                },
                back_url: "https://images.dojah.io/id_sample_id_1720624047.jpg"
            },
            status: true,
            message: "Successfully verified your id"
        },
        email: {
            data: {
                email: "abc@gmail.com"
            },
            status: true,
            message: "abc@gmail.com validation Successful"
        },
        index: {
            data: {},
            status: true,
            message: "Successfully continued to the main checks."
        },
        selfie: {
            data: {
                selfie_url: "https://images.dojah.io/selfie_sample_image_1720624219.jpg"
            },
            status: true,
            message: "Successfully validated your liveness"
        },
        countries: {
            data: {
                country: "Nigeria"
            },
            status: true,
            message: "Successfully continued to the next step."
        },
        user_data: {
            data: {
                dob: "1990-12-03",
                last_name: "Musa",
                first_name: "John"
            },
            status: true,
            message: ""
        },
        business_id: {
            image_url: "https://images.dojah.io/selfie_sample_image_1720624219.jpg",
            business_name: "ABC Company LIMITED",
            business_type: "Business",
            business_number: "1237654",
            business_address: "",
            registration_date: ""
        },
        phone_number: {
            data: {
                phone: "234810123456"
            },
            status: true,
            message: "2348103817187 validation Successful"
        },
        business_data: {
            business_name: null,
            business_type: "BN",
            business_number: null,
            business_address: null,
            registration_date: null
        },
        government_data: {
            data: {
                bvn: {
                    entity: {
                        bvn: "222222222222",
                        nin: "",
                        email: "",
                        title: "",
                        gender: "Male",
                        customer: "6bb82c41-e15e-4308-b99d-e9640818eca9",
                        image_url: "https://images.dojah.io/id_John_Doe_1720615487.jpg",
                        last_name: "Musa",
                        first_name: "John",
                        middle_name: "Doe",
                        nationality: "",
                        name_on_card: "",
                        watch_listed: "",
                        date_of_birth: "01-Jun-1982",
                        lga_of_origin: "",
                        phone_number1: "08011111111",
                        phone_number2: "",
                        marital_status: "",
                        enrollment_bank: "",
                        state_of_origin: "",
                        level_of_account: "",
                        lga_of_residence: "",
                        enrollment_branch: "",
                        registration_date: "",
                        state_of_residence: "",
                        residential_address: ""
                    }
                },
               nin: {
                entity: {
                nin: "1234567891",
                firstname: "John",
                middlename: "Doe",
                surname: "Anon",
                maidenname: "",
                telephoneno: "0901234567",
                state: "",
                place: "",
                profession: "ZOOLOGY",
                title: "",
                height: "167",
                email: "",
                birthdate: "1960-01-01",
                birthstate: "",
                birthcountry: "Not Available",
                centralID: "",
                documentno: "",
                educationallevel: "tertiary",
                employmentstatus: "unemployed",
                othername: "",
                pfirstname: "",
                pmiddlename: "",
                psurname: "",
                nspokenlang: "YORUBA",
                ospokenlang: "",
                religion: "christianity",
                residence_Town: "",
                residence_lga: "Alimosho",
                residence_state: "Lagos",
                residencestatus: "birth",
                residence_AddressLine1: "No 2 Anon house, John does estate, Lagos state, Nigeria",
                residence_AddressLine2: "",
                self_origin_lga: "",
                self_origin_place: "",
                self_origin_state: "",
                signature: null,
                nationality: null,
                gender: "Female",
                trackingId: "",
                customer: "1234444y373737373737373737",
                image_url: "https://images.dojah.io/id_SANDBOX_1721830110.jpg"
              }
          }
            },
            status: true,
            message: ""
        },
        additional_document: [
            {
                document_url: "https://dojah-image.s3.amazonaws.com/66bcc73a4ff8e1003100454212aec768-3344-4df5-88f6-7e723c46cbb0.jpeg",
                document_type: "image"
            }
        ]
    },
    value: "123456",
    id_url: "https://images.dojah.io/id_sample_id_1720624047.jpg",
    status: true,
    id_type: "BVN",
    message: "Successfully completed the verification.",
    back_url: "https://images.dojah.io/id_sample_id_1720624047.jpg",
    metadata: {
        ipinfo: {
            as: "AS29465 MTN NIGERIA Communication limited",
            isp: "MTN NIGERIA Communication limited",
            lat: 6.4474,
            lon: 3.3903,
            org: "MTN Nigeria",
            zip: "",
            city: "Lagos",
            proxy: false,
            query: "102.89.34.49",
            mobile: true,
            status: "success",
            country: "Nigeria",
            hosting: true,
            district: "",
            timezone: "Africa/Lagos",
            region_name: "Lagos"
        },
        device_info: "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/118.0.0.0 Safari/537.36"
    },
    selfie_url: "https://images.dojah.io/selfie_sample_image_1720624219.jpg",
    reference_id: "DJ-31038041E0",
    verification_url: "https://app.dojah.io/verifications/bio-data/49fd74a4-8181-4ce8-a87a-0e63f7159257",
    verification_mode: "LIVENESS",
    verification_type: "RC-NUMBER",
    verification_value: "123456",
    verification_status: "Completed"
}

Response Fields

Field	Type	Description
aml	object	AML screening result for the verification
aml.status	boolean	Whether AML screening was triggered
data	object	Contains all verification step results
data.id	object	ID document verification result
data.id.data.id_url	string	URL of the uploaded ID document image
data.id.data.id_data	object	Extracted data from the ID document
data.id.data.id_data.last_name	string	Last name extracted from the ID
data.id.data.id_data.first_name	string	First name extracted from the ID
data.id.data.id_data.date_of_birth	string	Date of birth extracted from the ID (YYYY-MM-DD)
data.id.data.id_data.document_type	string	Type of document (e.g., “National ID”)
data.id.data.id_data.document_number	string	Document number extracted from the ID
data.id.data.back_url	string	URL of the back of the ID document
data.id.status	boolean	Whether ID verification succeeded
data.email	object	Email verification result
data.email.data.email	string	Verified email address
data.selfie	object	Selfie/liveness verification result
data.selfie.data.selfie_url	string	URL of the captured selfie image
data.selfie.status	boolean	Whether selfie verification succeeded
data.countries	object	Country selection step result
data.countries.data.country	string	Country selected during verification
data.user_data	object	User-provided biographical data
data.user_data.data.dob	string	Date of birth provided by the user (YYYY-MM-DD)
data.user_data.data.last_name	string	Last name provided by the user
data.user_data.data.first_name	string	First name provided by the user
data.business_id	object	Business ID verification result
data.business_id.business_name	string	Registered business name
data.business_id.business_type	string	Type of business
data.business_id.business_number	string	Business registration number
data.phone_number	object	Phone number verification result
data.phone_number.data.phone	string	Verified phone number
data.government_data	object	Government data lookup results (BVN, NIN, etc.)
data.government_data.data.bvn	object	BVN lookup result
data.government_data.data.nin	object	NIN lookup result
data.additional_document	array	Additional uploaded documents
data.additional_document[].document_url	string	URL of the uploaded document
data.additional_document[].document_type	string	Type of document (e.g., “image”)
value	string	Verification value submitted (e.g., BVN or NIN number)
id_url	string	URL of the front ID document image
status	boolean	Overall verification success status
id_type	string	Type of ID used (e.g., “BVN”)
message	string	Human-readable verification result message
back_url	string	URL of the back ID document image
metadata	object	Metadata about the verification session
metadata.ipinfo	object	IP geolocation data of the user
metadata.device_info	string	User-agent string of the device used
selfie_url	string	URL of the selfie captured during verification
reference_id	string	Unique Dojah reference ID for the verification
verification_url	string	Link to view the verification on the dashboard
verification_mode	string	Mode of verification (e.g., “LIVENESS”)
verification_type	string	Type of verification performed (e.g., “RC-NUMBER”)
verification_value	string	Value used for verification
verification_status	string	Final status of the verification (e.g., “Completed”)

Verification Statuses

These are the possible verification statuses for KYC Widget Webhook Notification Data:

Status	Description
Ongoing	The verification process is currently in progress.
Completed	The verification process has been successfully completed and passed all steps.
Pending	The verification process is awaiting further action.
Failed	The verification process was not successful.
Abandoned	The verification process was abandoned.

Documentation Index

​Request

​Header

​Query parameters

​Response

​Response Fields

​Verification Statuses

Request

Header

Query parameters

Response

Response Fields

Verification Statuses