Skip to main content
This endpoint returns a map of document types with a boolean value indicating whether each document has been uploaded for a given flow. Use this to:
  • Show a checklist UI to users
  • Track missing documents
  • Drive next-step prompts in onboarding flows

​
Endpoint

GET /v2/verification/docs

​
Request headers

​
Token
string
required
JWT access token for authentication.

​
Query parameters

​
flow_id
string
required
UUID of the verification flow.
​
external_reference_id
string
required
External identifier for the applicant (or co-applicant).

​
Response

Returns a key-value map:
  • Key → Document type
  • Value → true (uploaded) or false (missing)

​
Example

curl --request GET \
  --url "https://api.helloatlas.in/v2/verification/docs?flow_id=3fa85f64-5717-4562-b3fc-2c963f66afa6&external_reference_id=user-123" \
  --header "Token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

​
Error responses

StatusMeaning
400Missing or invalid parameters
401Invalid or missing token
409Applicant not found
410Applicant already deleted
The document list is dynamically determined based on the product configuration and applicant type. Use this endpoint to guide users on which documents are still pending.