DELETE /flow/coapplicant — Delete Co-applicant

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

Endpoint

DELETE /verification/flow/coapplicant

Request headers

string

required

JWT access token obtained from the auth API.

Request body

string

required

UUID of the verification flow.

string

External identifier of the co-applicant.

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

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

Authentication

IDP Extraction

Document Verification

Chat Based Onboarding

Bulk Service

Address Match

DELETE /flow/coapplicant — Delete Co-applicant

Endpoint

Request headers

Request body

Response

Example

Error responses

​Endpoint

​Request headers

​Request body

​Response

​Example

​Error responses

Endpoint

Request headers

Request body

Response

Example

Error responses