Overview

Integrate with the Xaqiiji verification API using API keys, REST endpoints, webhooks, and idempotency.

What is Xaqiiji?

Xaqiiji provides a REST API for enterprise citizen identity verification. Your backend sends a national ID, receives a verified result, and optionally listens for webhook events.

This documentation covers only the live API today. Platform marketing and product overview live on the main xaqiiji.so site.

Live API today

npm SDK

Install xaqiiji-sdk for Node.js / TypeScript — verify citizens in a few lines.

Verify Citizen

POST /api/v1/verify/citizen — verify by 11-digit national ID.

List Verifications

GET /api/v1/verifications — list previous requests for your business.

Webhooks

Receive verification_completed, credits_low, and other events via HTTPS.

API Keys

Use xq_test_* keys in development and xq_live_* keys in production.

Popular endpoints

POST/api/v1/verify/citizen

Verify Citizen

Verify a citizen by 11-digit national ID (enterprise API key).

GET/api/v1/verifications

List Verifications

List previous verification requests for your business.

Integration flow

Create API key in portalPOST /verify/citizenHandle JSON responseConfigure webhook URLVerify HMAC signature

Next steps

Follow Quick Start to make your first request, then read Authentication, Webhooks, and Error Handling before going live.

Quick Start

Edit this page

Was this page helpful?