GET /verification/status — Get Verification Status

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 /verification/status

Request headers

string

required

JWT access token used for authentication.

Query params

string

required

UUID of the verification flow.

string

required

Your external identifier associated with the flow (for example, application ID or customer ID).

Response

array

List of statuses for each uploaded file.

string

Unique identifier for the uploaded file.

string

Your provided document identifier.

string

Processing status of the file (e.g., UPLOAD_SUCCESS, PROCESSING_SUCCESS).

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>"

{
  "file_statuses": [
    {
      "file_uuid": "c6a2ffd7-eb44-4d16-8b45-32adc2182a8b",
      "document_id": "5643",
      "status": "PROCESSING_SUCCESS"
    },
    {
      "file_uuid": "b5e3cc27-5a34-4f96-832c-8b9bcab1742f",
      "document_id": "7890",
      "status": "UPLOAD_SUCCESS"
    }
  ],
  "master_status": "SUCCESS"
}

Status values

Status	Meaning
`UPLOAD_SUCCESS`	File uploaded successfully
`PROCESSING`	Document is being processed
`PROCESSING_SUCCESS`	Extraction completed successfully
`FAILED`	Processing failed

Error responses

Status	Meaning
`400`	Missing or invalid parameters (e.g., missing `flow_id`)
`401`	Invalid or expired token
`409`	Applicant not found for given `flow_id` and `external_reference_id`
`410`	Applicant 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.

Authentication

IDP Extraction

Document Verification

Chat Based Onboarding

Bulk Service

Address Match

GET /verification/status — Get Verification Status

Endpoint

Request headers

Query params

Response

Example

Status values

Error responses

Error examples

Notes

​Endpoint

​Request headers

​Query params

​Response

​Example

​Status values

​Error responses

​Error examples

​Notes

Endpoint

Request headers

Query params

Response

Example

Status values

Error responses

Error examples

Notes