OCocrolus
File Commands

Cancel document verification

Aborts verification of an uploaded <glossary:Document>.

You cannot cancel the verification of a <glossary:Document> that is in the REJECTED, VERIFICATION_COMPLETE, DELETING, DELETED, COMPLETED, or FAILED state. Attempting to cancel a Document in any of these states returns the No Permission error (code 2104).

🚧 No turning back! Canceling verification of an uploaded <glossary:Document> will permanently delete all associated data.

post/v1/document/cancel

Request

  • Base URL
    https://api.ocrolus.com
  • URL
    https://api.ocrolus.com/v1/document/cancel
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://auth.ocrolus.com/oauth/token

Request body

doc_pkinteger

The <glossary:PK> of the <glossary:Document> that you no longer want to be verified. Mutually exclusive with doc_uuid.

doc_uuidstring

The unique identifier of the <glossary:Document> that you no longer want to be verified. Mutually exclusive with doc_pk.

accept_chargesboolean

Indicate whether you accept verification charges, if applicable.

Response

Success

statusinteger

A numerical code that indicates the status of the request.

responseobject

An object received from the server that potentially contains data.

messagestring

A textual description that indicates details about this response's status.

Example response

{
  "status": 200,
  "message": "OK"
}

Changes

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