Get a session

GET /v1/sessions/

GET https://api.uip.digital/v1/sessions/{id} · Auth: Bearer API key

Returns a session’s status, progress, and the derived per-step results already produced — the same verdicts delivered by webhook. The underlying identity PII is never returned here; it stays sealed in the audit. Webhooks remain the push delivery mechanism — use GET for one-off reconciliation, not as a polling loop.

Path parameters

id · string · required

The session id.

Response

id · string

The session id.

status · string

created · in_progress · awaiting_decision · completed · stopped · failed · expired.

current_step · integer

Zero-based index of the active step.

step_count · integer

Total steps in the session.

results · object[]

The derived verdicts produced so far, one per completed step — the same payloads delivered by webhook. Results expose only derived verdicts; the underlying PII is never returned, it stays sealed in the audit.

Show result

step · integer

Zero-based index of the step this verdict belongs to.

primitive · string

The step’s primitive (identify · age_verify · sign · light_sign).

verified_at · string

ISO 8601 time the verdict was produced.

audit_id · string

Id of the append-only audit record. Fetch the redacted proof via GET /v1/audits/{id}.

satisfied · boolean

age_verify only — whether age >= min_age.

min_age · integer

age_verify only — the threshold checked.

claims · object

identify only — the disclosed attribute blocks.

document_hash · string

sign / light_sign only — the hash the wallet device-signed.

signature · string

sign / light_sign only — the wallet signature over the hash.

outcome · string

Terminal reason — completed · stopped · failed · expired. Empty while the session is still in progress.

client_reference_id · string

Optional — echoed back if you supplied it at create.

metadata · object

Optional — echoed back if you supplied it at create.

updated_at · string

ISO 8601 last update.

200 OK

{
  "id": "sess_abc123",
  "status": "awaiting_decision",
  "current_step": 1,
  "step_count": 2,
  "results": [
    {
      "step": 0,
      "primitive": "identify",
      "verified_at": "2026-06-07T12:01:30Z",
      "audit_id": "aud_9f2c1e",
      "claims": {
        "first_name": "Ada",
        "last_name": "Lovelace",
        "dob": "1815-12-10",
        "country": "US"
      }
    }
  ],
  "outcome": "",
  "client_reference_id": "order_4417",
  "metadata": { "checkout": "abc" },
  "updated_at": "2026-06-07T12:01:30Z"
}

404 if the session doesn’t exist or isn’t owned by your business.