SDK v1.4Enterprise DX

Quick Start

REST-first integration guides aligned with the live Xaqiiji API contract.

Install

The official @xaqiiji/sdk TypeScript package is in development. Use REST from your backend today — examples below match the live API.

npm (coming soon)

# npm install @xaqiiji/sdk

First request (REST)

fetch

const response = await fetch("http://localhost:8080/api/v1/verify/citizen", {  method: "POST",  headers: {    Authorization: `Bearer ${process.env.XAQIIJI_API_KEY}`,    "Content-Type": "application/json",    "Idempotency-Key": "verify-2026-06-02-001",  },  body: JSON.stringify({    nationalId: "12345678901",    purpose: "pre_employment",  }),});const result = await response.json();

Verify Citizen Example

response fields

result.data.result      // verified | failedresult.citizen.fullName // when verifiedresult.cached           // true if idempotent replay

Language Tabs

cURL

curl -X POST http://localhost:8080/api/v1/verify/citizen -H "Authorization: Bearer xq_test_xxx" -H "Content-Type: application/json" -d '{"nationalId":"12345678901","purpose":"pre_employment"}'

SDK Overview

Authentication Guide

Edit this page

Was this page helpful?