Skip to main content

Request

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

Query parameter

ParameterTypeDescriptionRequired
id_number*stringThe Passport Numberrequired

Sample response

Response
{
  "entity": {
    "address": "BOX 12345-67890 NAIROBI KAREN KAREN LOCATION",
    "citizenship": "",
    "date_of_birth": "2000-09-20",
    "date_of_birth_from_passport": "",
    "date_of_issue": "2019-02-14",
    "expiration_date": "2022-02-13",
    "first_name": "Joe",
    "gender": "M",
    "last_name": "Leo",
    "middle_name": "Doe",
    "occupation": "",
    "passport_number": "A00000000",
    "phone_number": "Not Available",
    "phone_number2": "Not Available",
    "photo": "/9j/4AAQSkZJRgABAQABLAEsAAD/2wBDAAYEBQYFBAYGB...",
    "photo_from_passport": "/9j/4AAQSkZJRgABAQABLAEsAAD/2w...",
    "place_of_birth": "NAIROBI"
  }
}

Response Fields

FieldTypeDescription
entityobjectContains the verification response data
entity.addressstringResidential address of the passport holder
entity.citizenshipstringCitizenship of the individual
entity.date_of_birthstringDate of birth from the national registry (yyyy-MM-dd)
entity.date_of_birth_from_passportstringDate of birth as recorded on the passport
entity.date_of_issuestringDate the passport was issued (yyyy-MM-dd)
entity.expiration_datestringExpiry date of the passport (yyyy-MM-dd)
entity.first_namestringFirst name of the passport holder
entity.genderstringGender of the individual
entity.last_namestringLast name of the passport holder
entity.middle_namestringMiddle name of the passport holder
entity.occupationstringOccupation of the individual
entity.passport_numberstringPassport number
entity.phone_numberstringPrimary phone number of the individual
entity.phone_number2stringSecondary phone number of the individual
entity.photostringBase64-encoded photo from the national registry
entity.photo_from_passportstringBase64-encoded photo from the passport
entity.place_of_birthstringPlace of birth of the individual

Test Credentials for Sandbox

Kindly use this Test Passport Number in sandbox Environment Passport Number = A00123456