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

Autorizações

Authorization
string
header
obrigatório

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

Parâmetros de caminho

contextId
string<uuid>
obrigatório

Context ID

reviewId
string<uuid>
obrigatório

Review ID

Corpo

application/json
reason
string

Optional free-text reason for the rejection

Exemplo:

"poor scan quality, re-upload"

Resposta

OK

candidates
object[] | null
obrigatório

Proposed transaction candidates awaiting review

contextId
string<uuid>
obrigatório

Reconciliation context the candidates belong to

Exemplo:

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

createdAt
string<date-time>
obrigatório

Creation timestamp (RFC 3339, UTC)

Exemplo:

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

id
string<uuid>
obrigatório

Review identifier

Exemplo:

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

sourceId
string<uuid>
obrigatório

Reconciliation source the candidates belong to

Exemplo:

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

status
string
obrigatório

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

Exemplo:

"PENDING_REVIEW"

updatedAt
string<date-time>
obrigatório

Last-update timestamp (RFC 3339, UTC)

Exemplo:

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

version
integer<int64>
obrigatório

Optimistic-concurrency version, incremented on each state change

Exemplo:

1

ingestionJobId
string<uuid>

Downstream ingestion job linked on approval; null until linked

Exemplo:

"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