OCR completed

Implement the forms.ocr_completed webhook to know when OCR is completed for uploaded documents.

The forms.ocr_completed webhook notifies your system when data retrieval through OCR is completed for documents manually uploaded by your user through the Document upload flow.

📘

This webhook triggers when OCR is successful for at least one out of all documents within an upload form. If OCR fails for one or more of the remaining documents, the metadata field of each failed document 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.

Event

forms.ocr_completed

Payload


account string uuid

ID of the account for which OCR was completed on a form.


user string uuid

ID of the user the account belongs to.


form string uuid

ID of the form for which OCR was completed.


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

📘

The payload provided by this webhook does not include the actual meta-data contents of the document. You can request these through the forms endpoint, by calling GET /forms/:form with the form ID received in the forms.ocr_completed webhook.

The ocr_data object is part of the forms.data.form_1099.metadata or forms.data.form_w2.metadata objects, depending on the type of the form. You can find more details in the OCR API Reference page.