Sign in

v1

latestOpenAPI 3.0.02026-07-2482421001.1 KB
File Commands

Cancel document verification

Abort verification of an uploaded <glossary:Document>.

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

You cannot cancel the verification of a <glossary:Document> that is in the REJECTED or VERIFICATION_COMPLETE state. You can stop the verification at any time while the file is in the VERIFYING state, but you may still be charged for its processing depending on the timing of your cancelation.

post/v1/document/cancel

Request body

doc_pkstring

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"
}