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
| Key | Description |
|---|---|
| x-api-key | Your Secret Key |
| app-id | Your app id |
Request Body
| Key | Description |
|---|---|
| first_name | First name of the customer |
| last_name | Last name of the customer |
| national_id | National 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
| Response | Description |
|---|---|
| status | Indicates that the request was successful. |
| response_code | Represents the response code. |
| data | It is a string that contains some encrypted or encoded data related to the verification. |
| national_id | The national identification number of the individual. |
| full_name | The full name of the individual. |
| gender | The gender of the individual. |
| surname | The surname or last name of the individual. |
| date_of_birth | The date of birth of the individual. |
| transunion_log | Information related to TransUnion log. |
| other_names | Any other names associated with the individual. |
| verification | Information related to verification. |
| reference | Unique reference code associated with the verification. |
| session | Session-related information. |
Updated 2 months ago