Delete a beneficiary
Deletes a specified beneficiary from the enrollment records based on the provided unique identifiers. This operation is typically used to remove beneficiaries who are no longer eligible or needed in the system.
Request
-
tpaId string Required
A unique identifier used to identify your admin instance. This value is system generated when the admin instance was created.
-
employerId string Required
Unique identifier for the employer. Note: When the employer was created, WealthCare Admin assigned the 3-character prefix; you assigned the remaining characters.
-
participantId string Required
Unique identifier for the participant user whose feature information is being retrieved.
-
flexAcctId string Required
A 10-character string representing an internal key assigned to a benefit account in the WCA system, used to uniquely identify the account. This value is left-padded with 0s, i.e., "0001699940".
-
beneficiaryTypeCde enum<string> Required
Beneficiary Type Code (Primary or Contigent)
Possible values:NonePrimaryContigent -
beneficiaryNumber integer <int32> Required
Beneficiary Number
-
decrypt integer <int32>
Indicate if the URI parameters are encrypted or not. Use 1 for encrypted, 0 for decrypted (default is 0). This affects how the API interprets the incoming identifiers.