Xaqiiji
API ReferenceList Verifications
API v1OpenAPI ready

List Verifications

List previous citizen verification requests for your business account.

Purpose

List previous citizen verification requests for your business account.

Endpoint group cards

Detailed endpoint

GET/api/v1/verifications

List verifications

List previous verification requests.

Real-time

Under 2 seconds

Requires API Key

Bearer token

Rate Limit

60 req/min

Credits

1 credit per request

Overview

List previous verification requests. This endpoint is designed for secure server-to-server integrations and returns structured JSON suitable for enterprise audit, reporting, and ERP reconciliation.

Requires API key authentication

Send requests from a trusted backend using Authorization: Bearer <api_key>. Never expose live API keys in frontend code.

Rate limit: 60 requests per minute

Use idempotency keys and exponential backoff. Retry only after the reset window or the Retry-After header.

Request

ParameterTypeRequiredDescriptionExample
pageintegeroptionalPage number (default 1).1
limitintegeroptionalPage size, max 100 (default 20).20
AuthorizationheaderrequiredBearer API key.Bearer xq_test_xxxxxxxxxxxxxx
application/json
// GET request — optional query: ?page=1&limit=20

Response

application/json
{  "message": "Verifications retrieved successfully",  "data": [    {      "id": "uuid",      "result": "verified",      "purpose": "pre_employment",      "channel": "api",      "createdAt": "2026-06-02T12:30:00.000Z"    }  ],  "pagination": {    "page": 1,    "limit": 20,    "total": 1  }}

Code Examples

cURL
curl -X GET "http://localhost:8080/api/v1/verifications" \  -H "Authorization: Bearer xq_test_xxxxxxxxxxxxxx" \  -H "Content-Type: application/json" \  -H "Idempotency-Key: verify-2026-06-02-001" \  -d '// GET request — optional query: ?page=1&limit=20'

Errors

application/json
{  "status": "failed",  "code": "BAD_REQUEST",  "message": "Validation failed",  "errors": [    {      "field": "nationalId",      "message": "National ID must be exactly 11 digits"    }  ]}
HTTP statusError codeDescription
400BAD_REQUESTMalformed request or validation failure.
401UNAUTHORIZEDMissing, invalid, revoked, or expired API key.
403FORBIDDENBusiness inactive or not on an enterprise plan.
404NOT_FOUNDResource not found.
409CONFLICTIdempotency-Key reused with a different payload.
429RATE_LIMITEDToo many requests — retry with backoff.
500INTERNAL_ERRORUnexpected server error.

Rate Limits

Rate limit: 60 requests per minute

Use idempotency keys and exponential backoff. Retry only after the reset window or the Retry-After header.

Best Practices

Production guidance

Send requests only from trusted backend services
Use Authorization and Idempotency-Key headers
Do not log National IDs, API keys, or biometric payloads
Store secrets in an encrypted vault
Monitor requestId and referenceId values for audit workflows
Use webhook signatures for event ingestion

Next steps

Next steps

Test the endpoint in sandbox using a test API key.
Add idempotency, error handling, and request logging.
Validate authorization, rate limits, and production approval before going live.
Edit this page
Was this page helpful?