Passport Check

Introduction

Used to verify a customer by passport number.

Request Parameters

The following parameters are expected:

Field	Description	Type
search_type	Must be PASSPORTCHECK	String
score_type	Must be PASSPORTCHECK	String
identifier	Passport number to verify	String
consent	Indicates whether the data owner has consented to identity verification 1 if yes 0 if no.	String
consent_collected_by	Name or identifier of the person who provided the data owner’s consent.	String

Please find sample implementation on the left

---

Response Parameters

The response returns passport verification details and a tracking request ID.

Field	Description	Type
success	Whether the request succeeded	Boolean
response_code	HTTP-style status code returned by the service	Number
message	Result message	String
data.first_name	Customer first name (mask in UI if required)	String
data.surname	Customer surname (mask in UI if required)	String
data.other_name	Customer other name	String
data.name	Full name	String
data.gender	Gender	String
data.dob	Date of birth	String
data.citizenship	Citizenship	String
data.id_number	ID number	String
data.passport_number	Passport number (mask in UI if required)	String
data.clan	Clan	String
data.ethnic_group	Ethnic group	String
data.family	Family	String
data.occupation	Occupation	String
data.pin	PIN	String
data.place_of_birth	Place of birth	String
data.place_of_live	Place of residence	String
data.reg_office	Registration office	String
data.date_of_issue	Passport issue date	String
data.date_of_expiry	Passport expiry date	String
data.valid	Whether the passport is still valid	Boolean
data.fingerprint_path	Path to fingerprint image	String
data.photo_path	Path to photo image	String
data.signature_path	Path to signature image	String
request_id	Request identifier for tracking	String

Below is a sample response. In UI displays, sensitive fields such as names and passport numbers may be masked.

{
  "success": true,
  "response_code": 200,
  "message": "Passport Details Fetched Successfully",
  "data": {
    "first_name": "C*****",
    "surname": "N*****",
    "other_name": "O*****",
    "name": "C***** O***** N*****",
    "gender": "M",
    "dob": "1998-01-13",
    "citizenship": "Kenyan",
    "id_number": "3691****",
    "passport_number": "BK7299**",
    "clan": "",
    "ethnic_group": "",
    "family": "",
    "occupation": "",
    "pin": "",
    "place_of_birth": "KAKAMEGA SOUTH\nDISTRICT - KAKAMEGA SOUTH\n",
    "place_of_live": "",
    "reg_office": "",
    "date_of_issue": "2024-06-07",
    "date_of_expiry": "2034-06-06",
    "valid": true,
    "fingerprint_path": null,
    "photo_path": null,
    "signature_path": null
  },
  "request_id": "112d94a8-d78a-451a-a48d-2e2ee33863ef"
}