Skip to main content
This endpoint removes a co-applicant from a verification flow using either co_applicant_id or external_reference_id.

​
Endpoint

DELETE /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.
​
external_reference_id
string
External identifier of the co-applicant.
​
co_applicant_id
string
UUID of the co-applicant.

​
Response

This endpoint returns no content on success.

​
Example

curl --request DELETE \
  --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",
    "external_reference_id": "user-123"
  }'

​
Error responses

StatusMeaning
400Missing required parameters
401Invalid or missing token
409Applicant not found
410Applicant already deleted