Skip to main content

​
Request

[GET]
{{baseUrl}}/api/v1/ug/kyc/voter
HeaderTypeDescription
AppIdstringCreate an app to get your app ID on dashboard here
AuthorizationstringPrivate/secret key. Use <key> not Bearer <key>

​
Query parameter

ParameterTypeDescriptionRequired
id *stringThe Voter Number, Application ID, or National ID Number (NIN)required
first_name *stringThe first name of the document holderrequired
last_name *stringThe last name of the document holderrequired

​
Sample response

Response
{
    "entity": {
   			 "voter_number": "12345678",
   			 "first_name": "JOHN",
    		 "last_name": "DOE",
    		 "gender": "M",
    		 "village": "BIROBOKA",
    		 "district": "KYANKWANZI",
    		 "constituency": "BIROBOKA - KAYANJA PRIMARY SCHOOL",
    		 "sub_county": "BUTEMBA COUNTY",
    		 "parish": "KYANKWANZI TOWN COUNCIL",
    		 "polling_station": "BIROBOKA WARD",
    		 "is_first_name_match": true,
    		 "is_last_name_match": true

    }
  
}

​
Response Fields

FieldTypeDescription
entityobjectContains the verification response data
entity.voter_numberstringUnique voter registration number
entity.first_namestringFirst name of the voter
entity.last_namestringLast name of the voter
entity.genderstringGender of the voter (e.g., M or F)
entity.villagestringVillage where the voter is registered
entity.districtstringDistrict where the voter is registered
entity.constituencystringElectoral constituency and polling location
entity.sub_countystringSub-county of the voter’s registration
entity.parishstringParish of the voter’s registration
entity.polling_stationstringAssigned polling station ward
entity.is_first_name_matchbooleanWhether the provided first name matches the registered name
entity.is_last_name_matchbooleanWhether the provided last name matches the registered name