family_management

verify and assign

Verifies the OTP for a family link transaction and, in the same step, links the given ABHA address under the relationship type. May also unassign a previous address.

POST/family-management/verify-and-assign

Authorizations

Authorizationbearer tokenRequired

The access token from POST /api/hiecm/gateway/v3/sessions.

Body

abhaAddressToLinkstring

txnIdstringRequired

relationshipTypeIdintegerRequired

abhaAddressToUnassignstring

Responses

200

Example values, scrubbed.

400

Example values, scrubbed.

Error codes for this module

500

Example values, scrubbed.

Error codes for this module

verify and assign

curl --request POST \
  --url https://phrsbx.abdm.gov.in/family-management/verify-and-assign \
  --header 'Authorization: Bearer <ACCESS_TOKEN_FROM_SESSIONS_CALL>' \
  --header 'Content-Type: application/json' \
  --data '{
  "abhaAddressToLink": "<ABHA_ADDRESS_TO_LINK>",
  "txnId": "<TXN_ID>",
  "relationshipTypeId": 0,
  "abhaAddressToUnassign": "<ABHA_ADDRESS_TO_UNASSIGN>"
}'

{
  "message": "<MESSAGE>",
  "success": false,
  "relationshipId": "<RELATIONSHIP_ID>"
}

Generated from the schema. The values are placeholders, not a captured response.