Skip to main content
A flow represents a single loan application and applicant journey inside Atlas. Before documents can be uploaded or chat interactions can begin, you must create a flow using this endpoint. A flow is uniquely identified by the combination of:
  • application_id
  • external_reference_id

​
Endpoint

POST /verification/flow/init

​
Request headers

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

​
Request body

​
product_type
string
required
Product configuration assigned to your organization. This determines the onboarding journey, required documents, validations, and chat behaviour.
​
application_id
string
required
Your internal application identifier. This should uniquely identify the loan or onboarding case in your system.
​
external_reference_id
string
required
Unique identifier for the primary applicant within the application.
​
username
string
required
Name of the primary applicant.
​
user_docs
array
List of expected document types for the primary applicant.Example:
[
  "PAN",
  "AADHAAR",
  "BANK_STATEMENT"
]
​
callback_url
string
URL where Atlas sends extracted document data and verification results once processing is complete.
​
chat_notification_url
string
Optional webhook URL that receives chat-related events and notifications from Atlas.
​
auth_token_url
string
Authentication endpoint Atlas can call to obtain authorization before sending callbacks to your systems.
​
flow_params
object
Optional key-value configuration object. Atlas stores and returns these parameters with the flow.

​
Response

​
flow_id
string
UUID generated by Atlas that uniquely identifies this onboarding flow.
​
application_id
string
Application identifier supplied during flow creation.
​
external_reference_id
string
Primary applicant identifier supplied during flow creation.
​
username
string
Applicant name associated with the flow.

​
Example

curl --request POST \
  --url https://api.helloatlas.in/v2/verification/flow/init \
  --header "Token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..." \
  --header "Content-Type: application/json" \
  --data '{
    "product_type": "MSME_OD",
    "application_id": "APP-10001",
    "external_reference_id": "CUST-9283",
    "username": "Rahul Sharma",
    "user_docs": [
      "PAN",
      "AADHAAR",
      "BANK_STATEMENT"
    ],
    "callback_url": "https://your-system.com/atlas/callback",
    "chat_notification_url": "https://your-system.com/atlas/chat-events",
    "auth_token_url": "https://your-system.com/atlas/auth",
    "flow_params": {
      "branch": "Mumbai",
      "channel": "DSA"
    }
  }'

​
Callback support

Atlas supports asynchronous delivery of verification results. Provide the following URLs during flow creation:
FieldPurpose
callback_urlReceives extracted document data and verification results
auth_token_urlUsed by Atlas to obtain authentication before posting callbacks
chat_notification_urlReceives chat events and onboarding notifications
Atlas maintains the callback configuration against the flow and automatically pushes updates as onboarding progresses.

​
Error responses

StatusMeaning
400Missing or invalid request parameters.
401Invalid or expired access token.
409A flow already exists for the supplied combination of application_id and external_reference_id.
Store the returned flow_id securely. Every subsequent onboarding API call—including uploads, chat messages, status checks, checklist retrieval, co-applicant management, and final submission—requires this identifier.