API Documentation

Central Gateway Integration

Connect your portal to the national verification gateway

Authentication

API Key Security

Never expose your API keys in client-side code or public repositories. Always store them securely in environment variables on your server.

All API requests require authentication using API keys provided during institution registration.

API Endpoints

GET
/health

Check API health status (no authentication required)

Scope: None

POST
/documents/verify

Verify a document's authenticity

Scope: documents:verify

GET
/registries/{registry}/search

Search for records within a registry

Scope: registries:read

POST
/requests

Submit a new service request

Scope: requests:write

GET
/requests/{id}/status

Get request status

Scope: requests:read