Verify — Passport Photo

Check whether an uploaded photograph meets ICAO passport-photo requirements (face position, lighting, background).

Endpoint

POSThttps://gateway.startappz.co.ke/api/v1/sandbox/verify-passport-photo

Swap sandbox for live once you have production credentials.

Authentication

Send your credentials as headers:

HeaderValue
X-API-KeyYour public key
X-API-SecretYour secret (shown once at issue time)

Request parameters

ParameterTypeRequiredDescription
file File (multipart) required Image (JPEG / PNG) of the candidate passport photo.

Response parameters

All responses follow the standard envelope: { code, message, data }.

FieldTypeDescription
codeStringInternal status code (e.g. 200.001).
messageStringHuman-readable status / error description.
dataObjectEndpoint-specific payload (fields below).
data.verified Boolean True if the photo passes ICAO checks.
data.confidence Float Quality confidence score (0–1).

Sandbox masking

By default, sandbox responses mask PII (names, IDs, dates, phone numbers). You can grant unmasked consent per key from your dashboard.