Skip to main content
This API returns the processing status of each uploaded document along with an overall master_status for the flow. Use this endpoint to track progress after uploading documents via /multiupload.

​
Endpoint

GET /v2/verification/status

​
Request headers

​
Token
string
required
JWT access token used for authentication.

​
Query params

​
flow_id
string
required
UUID of the verification flow.
​
external_reference_id
string
required
Your external identifier associated with the user (for example customer ID).

​
Response

​
file_statuses
array
List of statuses for each uploaded file.
​
file_statuses[].file_uuid
string
Unique identifier for the uploaded file.
​
file_statuses[].document_id
string
Your provided document identifier.
​
file_statuses[].status
string
Processing status of the file (e.g., UPLOAD_SUCCESS, PROCESSING_SUCCESS).
​
master_status
string
Overall status of the flow (e.g., IN_PROGRESS, SUCCESS, FAILED).

​
Example

curl --request GET \
  --url "https://api.helloatlas.in/v2/verification/status?flow_id=3fa85f64-5717-4562-b3fc-2c963f66afa6&external_reference_id=12345" \
  --header "Token: <TOKEN>"

​
Status values

StatusMeaning
UPLOAD_SUCCESSFile uploaded successfully
PROCESSINGDocument is being processed
PROCESSING_SUCCESSExtraction completed successfully
FAILEDProcessing failed

​
Error responses

StatusMeaning
400Missing or invalid parameters (e.g., missing flow_id)
401Invalid or expired token
409Applicant not found for given flow_id and external_reference_id
410Applicant has been deleted

​
Error examples

{
  "error": "Missing required ['flow_id'] parameters"
}

{
  "error": "Invalid token",
  "reason": "Signature verification failed"
}

{
  "error": "Applicant not found"
}

{
  "error": "Applicant has been deleted."
}

​
Notes

Use this API to poll processing status if you are not using a callback mechanism.
Wait until master_status is SUCCESS before calling the extracts API.