> ## Documentation Index > Fetch the complete documentation index at: https://docs.get-rial.com/llms.txt > Use this file to discover all available pages before exploring further. # Report a funnel-progress snapshot (GET-87) > Best-effort telemetry from the hosted-capture screen — powers "know when/where someone abandons a verification". Same trust model as `/captures`/`/answers`: the path's token is the credential. Sent via `navigator.sendBeacon` (so it can fire from an unload handler) or `fetch` with `keepalive`; beacons default to `Content-Type: text/plain`, which the server parses as JSON regardless. **Semantics:** each call is the LATEST snapshot of the funnel — it OVERWRITES the previous one (not an event log). When `kind: 'abandoned'`, the server additionally attempts to flip status to `abandoned`; the transition only applies from `pending`/`partially_captured` — on any other current status (including expired) the snapshot still lands and the call still succeeds, the transition is just silently skipped. A later capture on an `abandoned` verification resurrects it to `partially_captured` like any other. **Privacy:** only the declared fields are ever stored; unknown extra keys are dropped silently, never a 400. **Returns:** `204` — no body. ## OpenAPI ````yaml /api-reference/openapi.json post /v1/verifications/{token}/progress openapi: 3.1.0 info: title: rial-platform — Verifications API version: 0.1.0 description: |- # rial-platform — Verifications API HTTP control plane for the rial-platform verifications-service: creating verifications, capturing media against them, finalising cases for batch analysis, and the operator-facing dashboard. ## Audience - **Tenants** integrating rial into a claims / verification flow — use the operator-issued API key and call `POST /v1/verifications`, then send the returned `capture_url` to your end-user. - **The dashboard SPA** (`app.get-rial.com`) — same surface, authenticated via the `rial_session` cookie. - **The WhatsApp bot (rialclaw)** — signs requests with HMAC (`X-Bot-Auth`), carries the target tenant in the body. - **End-user browsers** capturing photos against a fresh verification — authenticated by possession of the path `:token` alone (the token IS the credential, see ADR-0002). ## Auth modes - `cookieSession` — `rial_session` cookie set by Google OAuth at `/v1/auth/google/callback`. Dashboard browsers. - `bearerApiKey` — `Authorization: Bearer pk_live_<…>` API key, tenant-scoped. Server-to-server integrations. - `captureToken` — possession of the verification id (`vfy_…`) in the URL path authenticates the SPA capture flow. Same trust model as Stripe payment intent client_secret. - `botHmac` — `X-Bot-Auth: ` from the WhatsApp bot. ## State machine A verification's status: `pending` → `partially_captured` → `completed` | `expired` | `failed`. State transitions emit domain events on the internal EventBridge bus; webhook events are translated from those and delivered to the tenant's configured `webhook_url` (HMAC-signed via the per-tenant `webhook-signing` secret). `pending`/`partially_captured` can also side-branch to `abandoned` — reported by the capture screen via `POST /v1/verifications/:token/progress` when the end user leaves before finishing. It is not terminal: a later capture resurrects the row to `partially_captured` like any other, and no webhook event fires for the transition. ## Conventions - Wire format is **snake_case JSON** in both directions; the service maps to camelCase internally. - Errors are `{error: {code, message, fields?}}` — `code` is the stable string SDKs branch on; `message` is human-readable English; `fields` is present only on `invalid_request` validation failures. - IDs are ULIDs with type prefixes: `vfy_`, `cap_`, `tnt_`, `walotp_`, `mlk_`. - Pagination is opaque-cursor: client passes back whatever `next_cursor` the previous page returned; absent means done. ## Out of scope here - Webhook payloads delivered to tenant URLs — those are documented separately under `docs/webhook-events.md`. This spec covers only the inbound HTTP surface, not the outbound HTTP rial → tenant calls. - Internal EventBridge events on the `rial-platform-events` bus (`verification.created`, `verification.case.completed`, …) — consumer-internal, not part of the public contract. contact: name: rial-platform team url: https://github.com/Rial-ventures-Inc/rial-platform license: name: UNLICENSED — proprietary, internal use only servers: - url: https://platform-staging.get-rial.com description: Staging (safe to hit; ANALYSIS=stub, CASE_ANALYSIS=gemini-case) - url: https://platform.get-rial.com description: Production (live tenant traffic; do not test against) security: [] tags: - name: Verifications description: >- Create, fetch, list, and finalize verifications. The core of the API — every tenant integration starts here. - name: Captures description: >- Upload media against an existing verification. Two-stage flow: mint a presigned S3 URL → PUT bytes direct to S3 → POST submit-capture with the resulting key. Hardware attestation (Cloudflare Turnstile / Apple PAT) is verified per-capture. - name: Case Analysis description: >- Batch multi-image case analysis (GET-59). Finalize a verification with a claimant narrative; the worker runs Gemini multi-image cross-reasoning and emits a structured CaseAnalysisReport. Staging-only today per ADR-002 sibling deferral. - name: Public Trial description: >- Unauthenticated trial endpoint behind `get-rial.com/trial`. Each call mints a fresh verification under the rial. tenant tagged `originChannel="wa"`, so the WA-completion worker delivers the verdict to the configured trial number. - name: Templates description: >- Publish, update, revoke and inspect link templates — the reusable capture links behind `/l/{org}/{slug}`. Callable with a secret key; each publish snapshots a versioned capture spec (GET-83). paths: /v1/verifications/{token}/progress: post: tags: - Captures summary: Report a funnel-progress snapshot (GET-87) description: >- Best-effort telemetry from the hosted-capture screen — powers "know when/where someone abandons a verification". Same trust model as `/captures`/`/answers`: the path's token is the credential. Sent via `navigator.sendBeacon` (so it can fire from an unload handler) or `fetch` with `keepalive`; beacons default to `Content-Type: text/plain`, which the server parses as JSON regardless. **Semantics:** each call is the LATEST snapshot of the funnel — it OVERWRITES the previous one (not an event log). When `kind: 'abandoned'`, the server additionally attempts to flip status to `abandoned`; the transition only applies from `pending`/`partially_captured` — on any other current status (including expired) the snapshot still lands and the call still succeeds, the transition is just silently skipped. A later capture on an `abandoned` verification resurrects it to `partially_captured` like any other. **Privacy:** only the declared fields are ever stored; unknown extra keys are dropped silently, never a 400. **Returns:** `204` — no body. parameters: - schema: type: string pattern: ^vfy_[0-9A-HJKMNP-TV-Z]{26}$ example: vfy_01HXYZABCDEFGHJKMNPQRSTVWX required: true name: token in: path requestBody: required: true content: application/json: schema: type: object properties: schema_version: type: number enum: - 1 kind: type: string enum: - step_reached - camera_permission - abandoned step: type: string enum: - landing - ready - capturing - reviewing - uploading - camera_blocked - success step_index: type: integer minimum: 0 camera_permission: type: string enum: - granted - denied - unavailable - unknown elapsed_ms: type: integer minimum: 0 required: - schema_version - kind - step - elapsed_ms example: schema_version: 1 kind: abandoned step: capturing camera_permission: granted elapsed_ms: 8423 responses: '204': description: >- Snapshot stored (and, when applicable, status flipped to `abandoned`). '400': description: Malformed body (missing/invalid required field). content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: code: invalid_request message: Request body failed validation '404': description: Unknown verification id. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: code: not_found message: Resource not found '410': description: >- Verification expired (`expires_at` < now) — only for `kind` other than `abandoned`; an abandoned-kind call on an expired token still returns `204`. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: code: expired message: Verification has expired security: - captureToken: [] components: schemas: ErrorResponse: type: object properties: error: type: object properties: code: type: string message: type: string fields: type: array items: type: object properties: path: type: string message: type: string required: - path - message required: - code - message required: - error description: >- Uniform error envelope. `code` is the stable string SDKs branch on (`invalid_request`, `unauthorized`, `not_found`, `expired`, `step_full`, `unknown_step`, `steps_incomplete`, `already_finalized`, `too_many_requests`, `storage_unavailable`, `internal_error`). `fields` is only present on `invalid_request` validation failures. securitySchemes: captureToken: type: apiKey in: query name: token description: >- Possession of the verification id in the URL path (`/v1/verifications/:token/...`) authenticates the SPA capture flow. No header — the id is the credential. ULIDs are large enough that existence-by-id is not a meaningful leak. Used for `POST /captures/upload-url`, `POST /captures`, `GET /v1/verify/:token`. ````