This page requires JavaScript to display.

Claim a coordinate for a person

POST /identity/claims · Identity · version 2026-09-14

The first claim on a person. Liveness, the document read and the face match run as one call, at one price.

The reading happens on the person's device. What reaches this endpoint is a proof — never an image, never a template.

Billed once per person, for life. Recognising the same person later costs nothing, at any volume.

Base URL

https://api.sidaxis.com/v1 in production, https://sandbox.api.sidaxis.com/v1 in sandbox.

Parameters

NameInTypeRequiredDescription
AuthorizationheaderstringrequiredBearer sk_live_… in production, sk_test_… in sandbox.
Sidaxis-VersionheaderstringoptionalDated version. Omit and the account default applies; pin it in production.
Idempotency-KeyheaderstringoptionalReplaying a key returns the original response and never claims a person twice. Retained 24 hours.

Request body

FieldTypeRequiredDescription
proofstringrequiredZero-knowledge proof emitted by the SDK on the user's device.
sourceenumoptionalHow the legal identity is attached to the coordinate. Omit to claim the coordinate alone, with no legal identity bound to it.
metadataobjectoptionalYour own string key-value pairs, returned unchanged. Never included in a public receipt.

Example request

{
  "proof": "zkp_01J8Y3Q2VXK7",
  "source": "open_finance",
  "metadata": {
    "customer_ref": "acct_4471"
  }
}

Responses

201 — Coordinate claimed

Store the facetoken. It is the handle you keep in place of the person.

{
  "facetoken": "0xA1f3c9b27d04",
  "claimed_at": "2026-09-14T11:02:41Z",
  "source": "open_finance",
  "receipt": {
    "id": "rcpt_9f41c7b2",
    "anchor": "0x7c3d91a4f8e2",
    "url": "https://verify.sidaxis.com/r/9f41c7b2"
  }
}

Errors

already_claimed, allowance_exhausted, liveness_required, rate_limited. See errors and refusals.

Notes

A call that does not complete is never billed.

409 already_claimed is not a failure: it returns the facetoken you already hold. Call POST /identity/recognitions instead — recognition is free.

The public name of this endpoint describes the outcome, not the mechanism. The proof format is an implementation detail of the SDK and may change inside a version.

See also

Unpacking...