Request
[GET]
Header
| 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 parameter
| Parameter | Type | Description | Required |
|---|---|---|---|
| id * | string | The national ID number | required |
Sample response
Response
Response Fields
| Field | Type | Description |
|---|---|---|
| entity | object | Contains the verification response data |
| entity.date_of_birth | string | Date of birth of the individual (yyyy-MM-dd) |
| entity.first_name | string | First name of the individual |
| entity.gender | string | Gender of the individual |
| entity.id | string | National ID number |
| entity.is_date_of_birth_match | boolean | Whether the provided date of birth matches the record |
| entity.is_first_name_match | boolean | Whether the provided first name matches the record |
| entity.is_gender_match | boolean | Whether the provided gender matches the record |
| entity.is_last_name_match | boolean | Whether the provided last name matches the record |
| entity.is_middle_name_match | boolean | Whether the provided middle name matches the record |
| entity.last_name | string | Last name of the individual |
| entity.middle_name | string | Middle name of the individual |