Quickstart

Get your first verification session running with the Nani API.

You need a sandbox API key from the Nani console. Send it as x-api-key on every server-side request.

Choose your client

Nani works with plain HTTP requests or your preferred language SDK pattern. Install or verify your client below.

# cURL is most likely already installed on your machine
curl --version

Create a session

POST

/v1/sessions

curl -X POST http://localhost:3002/v1/sessions \
  -H "x-api-key: sk_sandbox_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "country": "COD",
    "flow": "user",
    "tier": "tier2"
  }'

Response

{
  "session_id": "ses_01hzabc123",
  "verify_url": "http://localhost:3005/verify/tok_xyz",
  "status": "created",
  "required_steps": ["consent", "id_document", "liveness"],
  "expires_at": "2026-06-01T12:00:00Z"
}

Send the verify URL

Redirect or embed verify_url from the response. The hosted UI handles consent, document capture, and liveness.

Handle webhooks

Webhook payload

{
  "event": "session.approved",
  "session_id": "ses_01hzabc123",
  "identity_id": "idn_01hzdef456",
  "decision": "approved"
}

See the Webhooks guide for signature verification.

Fetch the identity

GET

/v1/identities/:id

curl http://localhost:3002/v1/identities/idn_01hzdef456 \
  -H "x-api-key: sk_sandbox_YOUR_KEY"