Skip to main content
POST
Reject an AI extraction review (discard the candidates)

Authorizations

Authorization
string
header
required

Bearer token authentication (format: "Bearer {token}")

Path Parameters

contextId
string<uuid>
required

Context ID

reviewId
string<uuid>
required

Review ID

Body

application/json
reason
string

Optional free-text reason for the rejection

Example:

"poor scan quality, re-upload"

Response

OK

candidates
object[] | null
required

Proposed transaction candidates awaiting review

contextId
string<uuid>
required

Reconciliation context the candidates belong to

Example:

"550e8400-e29b-41d4-a716-446655440000"

createdAt
string<date-time>
required

Creation timestamp (RFC 3339, UTC)

Example:

"2025-01-15T10:30:00Z"

id
string<uuid>
required

Review identifier

Example:

"550e8400-e29b-41d4-a716-446655440000"

sourceId
string<uuid>
required

Reconciliation source the candidates belong to

Example:

"550e8400-e29b-41d4-a716-446655440000"

status
string
required

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

Example:

"PENDING_REVIEW"

updatedAt
string<date-time>
required

Last-update timestamp (RFC 3339, UTC)

Example:

"2025-01-15T10:35:00Z"

version
integer<int64>
required

Optimistic-concurrency version, incremented on each state change

Example:

1

ingestionJobId
string<uuid>

Downstream ingestion job linked on approval; null until linked

Example:

"550e8400-e29b-41d4-a716-446655440000"

rejectReason
string

Free-text reason captured on rejection; empty otherwise

reviewerId
string

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