Skip to main content

Review Action

Approve or reject a review item with POST /v1/review/:id/action. Include an optional reason that is stored on the record as an audit trail comment.

POST /v1/review/:id/action records a Record Review decision — a record-level human judgment — on a review item: approve advances the record toward delivery, reject returns it for re-extraction or manual correction. These are the only two accepted actions. Include an optional reason for audit trail purposes; it is stored on the record as review_comment.

Review actions are final. Once a record is approved or rejected, it cannot be reverted to pending status through the API.
POST/v1/review/:id/action

Body parameters

action*stringAction to take: `approve` or `reject`. No other values are accepted.
reasonstringOptional comment explaining the decision. Stored on the record as `review_comment`.

Response

Response fields

idstringReview record UUID.
run_idstringUUID of the run (Job or Pipeline run).
document_idstringUUID of the associated document.
schema_idstring | nullUUID of the schema used.
statusstringUpdated record status: approved or rejected.
overall_confidencenumber | nullAggregate confidence score (0–1).
assigned_tostring | nullUUID of the assigned reviewer.
reviewed_bystring | nullUUID of the team member who actioned the record.
reviewed_atstring | nullISO 8601 timestamp of the review action.
created_atstringISO 8601 creation timestamp.
linksobjectRelated resource URLs (self, action).

Response

{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "run_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
  "document_id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
  "schema_id": "d4e5f6a7-b8c9-0123-defa-234567890123",
  "status": "approved",
  "overall_confidence": 0.72,
  "assigned_to": null,
  "reviewed_by": null,
  "reviewed_at": "2024-10-12T10:30:00.000Z",
  "created_at": "2024-10-12T09:00:00.000Z",
  "links": {
    "self": "/v1/review/a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "action": "/v1/review/a1b2c3d4-e5f6-7890-abcd-ef1234567890/action"
  }
}

Errors

Error responses

401unauthorizedMissing or invalid API key.
404not_foundReview record not found or does not belong to your organization.
429rate_limitedToo many requests. Retry after the period indicated in the Retry-After header.

After approval, the record's status changes to approved and a delivery signal is emitted into the outbox. Pair this with POST /v1/review/batch when you need to clear multiple items sharing similar characteristics, or call GET /v1/review/stats afterward to verify the pending count dropped as expected.

Related

Get Review Item Detail
Batch Review Actions
Review Queue Statistics