v1

latestOpenAPI 3.1.02026-07-263644911022.4 KB
Ingestion

Get a single AI extraction review

Returns one extraction review with its candidates, provenance, and lifecycle. Tenant from the JWT, context from the path.

get/v1/imports/contexts/{contextId}/extraction-reviews/{reviewId}

Path parameters

contextIdstring uuid required

Context ID

Context ID

reviewIdstring uuid required

Review ID

Review ID

Response

OK

contextIdstring uuid required

Reconciliation context the candidates belong to

createdAtstring date-time required

Creation timestamp (RFC 3339, UTC)

idstring uuid required

Review identifier

ingestionJobIdstring uuid

Downstream ingestion job linked on approval; null until linked

rejectReasonstring

Free-text reason captured on rejection; empty otherwise

reviewerIdstring

Principal id of the human who adjudicated the review; empty until decided

sourceIdstring uuid required

Reconciliation source the candidates belong to

statusstring required

Review lifecycle: PENDING_REVIEW (awaiting decision), APPROVED (candidates ingested), REJECTED (discarded)

updatedAtstring date-time required

Last-update timestamp (RFC 3339, UTC)

versioninteger required

Optimistic-concurrency version, incremented on each state change

Example response

{
  "candidates": [
    {
      "fields": [
        {
          "canonicalKey": "amount",
          "confidence": 0.95,
          "page": 1,
          "value": "100.50"
        }
      ],
      "source": "text_layer"
    }
  ],
  "contextId": "550e8400-e29b-41d4-a716-446655440000",
  "createdAt": "2025-01-15T10:30:00Z",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "ingestionJobId": "550e8400-e29b-41d4-a716-446655440000",
  "sourceId": "550e8400-e29b-41d4-a716-446655440000",
  "status": "PENDING_REVIEW",
  "updatedAt": "2025-01-15T10:35:00Z",
  "version": 1
}