Welcome to the Gateway API

A unified gateway for Kenyan identity, document and biometric verification — one set of credentials, one consistent response envelope.

Getting started

  1. Register for a free sandbox key — issued instantly, scoped to a starter set of products.
  2. Pick an endpoint from the left sidebar to see request & response details.
  3. Use the Try it panel to upload a document and call the sandbox live.
  4. When ready, request live access from your dashboard.

Authentication

All requests require two headers:

  • X-API-Key — your public key (e.g. vfy_sandbox_abc123…)
  • X-API-Secret — your secret (shown once at issue time)

Response envelope

{
  "code": "200.001",
  "message": "Success",
  "data": { … }
}

Available endpoints

Identity Verification

Document Verification

Biometrics

OCR

KRA Live Validation