OCR failed

Implement the documents.ocr_failed webhook to know when OCR fails for a scanned document.

The documents.ocr_failed webhook notifies your system when data retrieval through OCR has failed for a document scanned by Argyle from a connected account.

If OCR fails, the scanned document’s metadata field returns an ocr_data.error object with the specific type of error. Consult the OCR data fields page for more information about possible error types.




accountstring uuidID of the account for which OCR was attempted on a document.
userstring uuidID of the user the account belongs to.
documentstring uuidID of the document for which OCR has failed.


curl -X POST https://api.argyle.com/v1/webhooks \
  -u api_key_id:api_key_secret \
  -H "Content-Type: application/json" \
  -d '{"events": ["documents.ocr_failed"],
       "secret": "<secret for signature verification>",
         "name": "OCR has failed",
          "url": "https://webhook.site/url"}'
    "event": "documents.ocr_failed",
    "name": "OCR has failed",
    "data": {
        "account": "ada143be-3c90-4534-b7ea-9899674dc6e0",
        "user": "3823026e-a964-45f6-b201-6b8c096b30d3",
        "document": "4334r6e-a964-45eef6-b201-64464"