Passport

Verify a Kenyan passport via POST /api/v1/passport/ke. Send passport_number and/or id_number (at least one required). HTTP 200 and 404 are billable; validation 400 is not. Other country codes are not supported yet.

Request

POST/api/v1/passport/ke

{{baseUrl}}/api/v1/passport/ke

Header

Header	Type	Description
Authorization	string	`Bearer YOUR_ACCESS_TOKEN` from the OAuth client-credentials flow
Content-Type	string	application/json

Body Parameters

Parameter	Type	Description	Required
passport_number	string	Passport number (4–40 chars, must include both letters and numbers)	optional*
id_number	string	National ID linked to the passport (6–10 digits)	optional*
consent	boolean	Must be true — confirms data-subject consent to perform this verification	required
customer_number	string	Optional reference for your own tracking (max 255 characters)	optional

Sample request body

All verification APIs require consent: true in the JSON body.

Sample dataSample request body

{
  "passport_number": "A1234567",
  "id_number": "12345678",
  "consent": true
}

Response

200 OKSample dataExample response

{
  "success": true,
  "response_code": 200,
  "message": "Passport Details Fetched Successfully",
  "country": "ke",
  "data": {
    "first_name": "JAMES",
    "surname": "KAMAU",
    "other_name": "OTIENO",
    "name": "JAMES OTIENO KAMAU",
    "gender": "Male",
    "dob": "1985-05-15",
    "citizenship": "Kenyan",
    "id_number": "1028845317",
    "passport_number": "A1234567",
    "clan": "SAMPLE CLAN",
    "ethnic_group": "SAMPLE ETHNIC GROUP",
    "family": "SAMPLE FAMILY",
    "occupation": "Engineer",
    "pin": "A123456789Z",
    "place_of_birth": "Nairobi, Kenya",
    "place_of_live": "Nairobi, Kenya",
    "reg_office": "Nairobi",
    "date_of_issue": "2015-06-18",
    "date_of_expiry": "2025-06-18",
    "valid": true,
    "fingerprint_path": null,
    "photo_path": "https://cdn.example.com/passport_images/photo_xxx.jpeg",
    "signature_path": null
  },
  "request_id": "550e8400-e29b-41d4-a716-446655440000"
}

Response Fields

Field	Type	Description
success	boolean	Whether the request succeeded
response_code	number	Application response code (typically mirrors HTTP)
message	string	Human-readable status message
data	object	Payload for the verified resource
request_id	string	UUID for support and audit trails
country	string	Country code — always "ke" for this route
data.first_name	string	Given name(s)
data.surname	string	Surname
data.other_name	string	Other / middle name
data.name	string	Full display name
data.gender	string	Gender
data.dob	string	Date of birth (YYYY-MM-DD)
data.citizenship	string	Citizenship
data.id_number	string	Linked national ID number
data.passport_number	string	Passport number
data.date_of_issue	string	Issue date when available
data.date_of_expiry	string	Expiry date when available
data.valid	boolean	Whether the passport is valid
data.photo_path	string	CDN photo URL when available
data.fingerprint_path	string	CDN fingerprint URL when available
data.signature_path	string	CDN signature URL when available
request_id	string	UUID for support and audit trails

Error codes

Standard Peleza HTTP / response_code values (same across all API calls). Validation message text is endpoint-specific. Full reference: Error Codes.

Code	When	Billed?
200	Passport details returned successfully	Yes
400	Validation — need id_number and/or passport_number; id_number 6–10 digits; passport_number 4–40 with letters and numbers	No
401	Missing or invalid Bearer token	No
402	Insufficient wallet balance or credit limit	No
403	No active wallet or billing profile (or service not enabled)	No
404	Passport not found	Yes
408	Upstream timeout / service error	No
429	Rate limited	No
502	Upstream bad or unreadable response	No
503	Upstream connection unavailable	No

400 — validation

400Sample data400 — validation

{
  "success": false,
  "response_code": 400,
  "message": "Either ID number or passport number is required in the request body",
  "errors": {
    "id_number": "Either ID number or passport number is required in the request body"
  },
  "data": null,
  "request_id": "550e8400-e29b-41d4-a716-446655440030"
}

404 — not found

404Sample data404 — not found

{
  "success": false,
  "response_code": 404,
  "message": "Passport Not Found",
  "description": "There is no information for requested search parameters",
  "data": null,
  "request_id": "550e8400-e29b-41d4-a716-446655440031"
}

Set {{baseUrl}} to https://api.peleza.com (production) or https://sandbox.peleza.com (sandbox). Authenticated calls need a Bearer token from POST /api/v1/oauth/token.