Skip to main content
This endpoint allows you to attach one or more co-applicants to an existing verification flow. Each co-applicant can have a unique external_reference_id and a set of required documents.

​
Endpoint

POST /v2/verification/flow/coapplicant

​
Request headers

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

​
Request body

​
flow_id
string
required
UUID of the verification flow.
​
co_applicants
array
required
List of co-applicants to be added.
​
co_applicants[].external_reference_id
string
required
Your unique identifier for the co-applicant.
​
co_applicants[].username
string
required
Name of the co-applicant.
​
co_applicants[].user_docs
array
List of required document types for this co-applicant.

​
Response

​
created
array
List of successfully created co-applicants.
​
failed
array
List of co-applicants that failed to be created along with error details.

​
Example

curl --request POST \
  --url https://api.helloatlas.in/v2/verification/flow/coapplicant \
  --header "Token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..." \
  --header "Content-Type: application/json" \
  --data '{
    "flow_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "co_applicants": [
      {
        "external_reference_id": "user-123",
        "username": "John Doe",
        "user_docs": ["PAN", "AADHAAR"]
      }
    ]
  }'

​
Error responses

StatusMeaning
400co_applicants list cannot be empty
401Invalid or missing token
409Flow not found