National Id Basic

Verify National Identity Number

The National Identity Basic endpoint serves as a seamless gateway to access fundamental information linked with a given national identity number. This endpoint offers a user-friendly approach for effortlessly retrieving key details that pertain to an individual's national identity.

This endpoint empowers various applications and services with a swift and reliable mechanism to verify and exhibit fundamental particulars associated with a specific national identity number. It acts as a robust foundation for enabling seamless validation processes, facilitating quick identity checks, and providing accurate data display.

πŸ‘

TEST DATA

first_name: john

last_name: doe

national_id: 12345678

πŸ“˜

POST

{{URL}}/identitypass/verification/ke/national_id/basic

Request Header

KeyDescription
x-api-keyYour Secret Key
app-idYour app id

Request Body

KeyDescription
first_nameFirst name of the customer
last_nameLast name of the customer
national_idNational Identity number of the customer

Sample Response

{
    "status": true,
    "response_code": "00",
    "data": {
        "national_id": "12345678",
        "full_name": "JOHN DOE",
        "gender": "",
        "surname": "JOHN",
        "date_of_birth": "01-01-1990",
        "transunion_log": null,
        "other_names": "DOE"
    },
    "verification": {
        "reference": "5f0bfc64-57a5-4eed-b050-83a251a7830f"
    },
    "session": {}
}

Response Description

ResponseDescription
statusIndicates that the request was successful.
response_codeRepresents the response code.
dataIt is a string that contains some encrypted or encoded data related to the verification.
national_idThe national identification number of the individual.
full_nameThe full name of the individual.
genderThe gender of the individual.
surnameThe surname or last name of the individual.
date_of_birthThe date of birth of the individual.
transunion_logInformation related to TransUnion log.
other_namesAny other names associated with the individual.
verificationInformation related to verification.
referenceUnique reference code associated with the verification.
sessionSession-related information.