v1

latestOpenAPI 3.0.02026-07-263365159.1 KB
Documents

Update Document Review Status

Change the review status of a document. Use this endpoint to start a review, mark a review as complete (end), or skip the review process entirely.

post/api/v1/pik/review/{doc_id}/{actions}/

Path parameters

doc_idstring required

The unique identifier for the user document.

actions'start' | 'end' | 'skip' required

The review action to perform on the document.

Query parameters

forcedboolean

If true, forces the status change even if the document has validation errors.

strictboolean

If true, the operation will fail if there are any validation errors in the document's data fields. This is only applicable when the action is end.

Headers

apikeystring

Your personal API key for authentication. You can find it on your Docsumo settings page.

Response

OK

errorstring

A message describing any errors encountered during the request.

error_codestring

A code representing the specific error encountered during the request.

messagestring

A confirmation message for the successful operation.

statusstring

The status of the request.

status_codeinteger

The HTTP status code of the response.

Example response

{
  "status": "success",
  "status_code": 200
}