[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 Voter ID number | required |
| is_new_id | boolean | Whether this is a 2020 issued voter ID or the older ID. This is by default false until 1 September 2021, then it would be true by default. | optional |
| full_name | string | The full name of the document holder as it appears on the ID | optional |
Sample response
Response
Response Fields
| Field | Type | Description |
|---|---|---|
| entity | object | Contains the verification response data |
| entity.id | string | Voter ID number |
| entity.full_name | string | Full name of the voter |
| entity.date_of_birth | string | Date of birth of the individual |
| entity.gender | string | Gender of the individual |
| entity.polling_station | string | Assigned polling station code |
| entity.registration_date | string | Date the voter was registered (yyyy-MM-dd) |
| entity.picture | string | Base64-encoded photo of the individual |
| entity.is_full_name_match | boolean | Whether the provided name matches the record |