Skip to main content
This endpoint submits all processed data for a verification flow and optionally closes the flow. It returns the final extracted data across all uploaded documents. Use this when:
  • You want to fetch final structured OCR data
  • You want to explicitly close the flow after processing

​
Endpoint

POST /v2/verification/flow/submit

​
Request headers

​
Token
string
required
JWT access token obtained from the auth API.

​
Query parameters

​
flow_id
string
required
UUID of the verification flow.
​
close_flow
string
Whether to close the flow after submission. Allowed values: yes, no.

​
Request body

​
flow_id
string
required
UUID of the verification flow.
​
close_flow
string
Whether to close the flow after submission (yes or no).

​
Response

​
flow_id
string
The flow UUID.
​
flow_params
object
Flow-level configuration parameters.
​
data
array
List of processed documents and their extracted data.

​
Example

curl --request POST \
  --url "https://api.helloatlas.in/v2/verification/flow/submit?flow_id=3fa85f64-5717-4562-b3fc-2c963f66afa6&close_flow=yes" \
  --header "Token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..." \
  --header "Content-Type: application/json" \
  --data '{
    "flow_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "close_flow": "yes"
  }'

​
Error responses

StatusMeaning
400Missing or invalid flow_id
401Invalid or missing token
If close_flow is set to yes, the flow will be marked as completed and no further documents can be uploaded. If set to no, the flow remains active for additional processing.