POST /flow/submit — Submit & Close Flow

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 /verification/flow/submit

Request headers

string

required

JWT access token obtained from the auth API.

Query parameters

string

required

UUID of the verification flow.

string

Whether to close the flow after submission. Allowed values: yes, no.

Request body

string

required

UUID of the verification flow.

string

Whether to close the flow after submission (yes or no).

Response

string

The flow UUID.

object

Flow-level configuration parameters.

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

{
  "flow_id": "4477b35e-07d0-4324-b301-b946a26dae67",
  "flow_params": {},
  "data": [
    {
      "document_id": "123",
      "external_reference_id": "1q2w3e",
      "file_uuid": "db096806-41b1-4123-891d-b97d1d3cbdfe",
      "data": {
        "document_type": "PAN",
        "name_as_per_pan": {
          "value": "PASHANGH RAYOMAND IRANI",
          "confidence_score": 0.9
        },
        "pan_number": {
          "value": "AFQP19186N",
          "confidence_score": 0.95
        },
        "dob": {
          "value": "14/11/1998",
          "confidence_score": 0.95
        },
        "is_original": {
          "value": "yes",
          "confidence_score": 0.6
        }
      }
    },
    {
      "document_id": "124",
      "external_reference_id": "",
      "file_uuid": "17d3abc2-a669-463b-8cd4-2fc6f97b0691",
      "data": {
        "processing_error": "PROCESSING_FAILED"
      }
    }
  ]
}

Error responses

Status	Meaning
`400`	Missing or invalid `flow_id`
`401`	Invalid 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.

Authentication

IDP Extraction

Document Verification

Chat Based Onboarding

Bulk Service

Address Match

POST /flow/submit — Submit & Close Flow

Endpoint

Request headers

Query parameters

Request body

Response

Example

Error responses

​Endpoint

​Request headers

​Query parameters

​Request body

​Response

​Example

​Error responses

Endpoint

Request headers

Query parameters

Request body

Response

Example

Error responses