Skip to main content
After uploading documents with POST /multiupload, poll this endpoint to track progress through each stage of the pipeline. When master_status reaches SUCCESS or FAILED, the flow is complete and you can call GET /extracts to retrieve results.

​
Endpoint

GET /v3/verification/status

​
Request headers

​
Token
string
required
JWT access token obtained from POST /authtoken.

​
Query parameters

​
flow_uuid
string
required
The UUID returned by POST /flow/init.

​
Response

​
upload_status
string
Reflects whether Atlas has successfully ingested all uploaded files.Possible values: NOT_STARTED | IN_PROGRESS | SUCCESS | FAILED
​
processing_status
string
Reflects the OCR extraction stage for each document.Possible values: NOT_STARTED | IN_PROGRESS | SUCCESS | FAILED | PENDING
​
crossheck_status
string
Reflects pairwise cross-document validation (note: field name is spelled crossheck_status in the API response).Possible values: NOT_STARTED | PENDING | COMPLETED
​
master_status
string
The overall status of the flow. This is the primary field to watch when polling.Possible values: NOT_STARTED | IN_PROGRESS | SUCCESS | FAILED

​
Example

curl --request GET \
  --url "https://api.helloatlas.in/v3/verification/status?flow_uuid=ec57821d-d766-4e24-81ef-a2768094511b" \
  --header "Token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

​
Error responses

StatusMeaning
400Missing required ['flow_uuid'] parameters — the query parameter was not included.
401Invalid token — the Token header is missing, expired, or invalid.
409Flow not found — no flow exists for the provided flow_uuid.
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.