master_status reaches SUCCESS or FAILED, the flow is complete and you can call GET /extracts to retrieve results.
Endpoint
Request headers
string
required
JWT access token obtained from POST /authtoken.
Query parameters
string
required
The UUID returned by POST /flow/init.
Response
string
Reflects whether Atlas has successfully ingested all uploaded files.Possible values:
NOT_STARTED | IN_PROGRESS | SUCCESS | FAILEDstring
Reflects the OCR extraction stage for each document.Possible values:
NOT_STARTED | IN_PROGRESS | SUCCESS | FAILED | PENDINGstring
Reflects pairwise cross-document validation (note: field name is spelled
crossheck_status in the API response).Possible values: NOT_STARTED | PENDING | COMPLETEDstring
The overall status of the flow. This is the primary field to watch when polling.Possible values:
NOT_STARTED | IN_PROGRESS | SUCCESS | FAILEDExample
Error responses
Poll this endpoint until
master_status is SUCCESS or FAILED. A reasonable polling interval is every 5–10 seconds. Once master_status is SUCCESS, call GET /extracts to retrieve the full OCR and cross-check results.
