Lookup Ghana Passport

Verify a Ghanaian international passport and fetch holder details from the immigration database.

Request

[GET]

{{baseUrl}}/api/v1/gh/kyc/passport

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 Number, Application ID, or National ID Number (NIN)	required

Sample response

Response

{
    "entity": {
        "date_of_birth": "1990-04-05",
        "expiry_date": "2022-10-03",
        "first_name": "John",
        "gender": "MALE",
        "id": "G0000000",
        "is_date_of_birth_match": true,
        "is_first_name_match": false,
        "is_last_name_match": true,
        "is_middle_name_match": true,
        "issue_date": "2017-11-03",
        "last_name": "Doe",
        "middle_name": "Jack",
        "picture": "/9j/4AAQSkZJRgABAQAAAQAB",
        "place_of_birth": "TEMA",
        "place_of_issue": "ACCRA"
    }
}

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.expiry_date	string	Expiry date of the passport (yyyy-MM-dd)
entity.first_name	string	First name of the passport holder
entity.gender	string	Gender of the individual
entity.id	string	Passport 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_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.issue_date	string	Date the passport was issued (yyyy-MM-dd)
entity.last_name	string	Last name of the passport holder
entity.middle_name	string	Middle name of the passport holder
entity.picture	string	Base64-encoded photo of the individual
entity.place_of_birth	string	Place of birth of the individual
entity.place_of_issue	string	Location where the passport was issued