Skip to main content

Request

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

Query parameters

vinstringVoter’s identification numberoptional

Sample response

[200]
{
  "entity": {
    "full_name": "JOHN DOE",
    "voter_identification_number": "91F1234567890123",
    "gender": "Male",
    "occupation": "STUDENT",
    "time_of_registration": "2011-02-18 13:59:46",
    "state": "ONDO",
    "local_government": "IDANRE",
    "registration_area_ward": "",
    "polling_unit": "OJAJIGBOKIN, O/S IN FRONT OF ABANA I & II",
    "polling_unit_code": "12/03/04/005",
    "address": "NO 16 OWODE QTS KABBA",
    "phone": "0812345678",
    "date_of_birth": "1960-10-16"
  }
}

Response Fields

FieldTypeDescription
entityobjectContains the voter identity verification response data
entity.full_namestringFull name of the voter as registered
entity.voter_identification_numberstringVoter Identification Number (VIN)
entity.genderstringGender of the voter
entity.occupationstringRegistered occupation of the voter
entity.time_of_registrationstringDate and time of voter registration
entity.statestringState where the voter is registered
entity.local_governmentstringLocal government area of registration
entity.registration_area_wardstringRegistration area or ward
entity.polling_unitstringName and location of the assigned polling unit
entity.polling_unit_codestringUnique code identifying the polling unit
entity.addressstringResidential address of the voter
entity.phonestringPhone number of the voter
entity.date_of_birthstringDate of birth of the voter (YYYY-MM-DD)

Test Credentials for Sandbox

Kindly use this Test VIN in sandbox Environment VIN = 91F6B1F5BE29535558655586