Annotation

Approve annotation

Approve annotation, switch its status to exporting or confirmed, or it stays in in_workflow, depending on the evaluation of the current workflow step.

<Callout type="info"> Approving is allowed only for documents in states: `in_workflow`. See [Annotation Lifecycle](/guides/annotation-lifecycle) for more information about states. </Callout>

Only admin, organization group admin, or an assigned user with approver role can approve annotation in this state. A workflow activity record object will be created.

<Callout type="info"> Talk with a Rossum representative about enabling this feature. Read more about [workflows](/guides/workflow-guide). </Callout>
post/api/v1/annotations/{annotationID}/approve

Request body

object required

Response

OK

statusstring

New status of the annotation.

Example response

{
  "status": "confirmed"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.