Save beneficiary details

https://api.wealthcare.com/participant/services/enrollment/beneficiary/{tpaId}/{employerId}/{participantId}

Update and save the beneficiary details for a specific participant identified by TPA ID, Employer ID, and Participant ID. This operation is typically used to add or modify beneficiary information associated with a participant's account.

Request

Path parameters

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.

Query parameters

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.

Request body

TpaId string
FlexAcctId string
BeneficiaryTypeCde enum<string>

Possible values: None Primary Contigent
BeneficiaryNumber integer <int32>
BeneficiaryName string
Addr1 string
Addr2 string
City string
State string
Zip string
BeneficiarySsn string
ApplicantRelation string
Percentage integer <int32>
BirthDte string
LastUpdateDte string <date-time>
IsNew boolean

TpaId string
FlexAcctId string
BeneficiaryTypeCde enum<string>

Possible values: None Primary Contigent
BeneficiaryNumber integer <int32>
BeneficiaryName string
Addr1 string
Addr2 string
City string
State string
Zip string
BeneficiarySsn string
ApplicantRelation string
Percentage integer <int32>
BirthDte string
LastUpdateDte string <date-time>
IsNew boolean

Response

Response body

TpaId string
FlexAcctId string
BeneficiaryTypeCde enum<string>

Possible values: None Primary Contigent
BeneficiaryNumber integer <int32>
BeneficiaryName string
Addr1 string
Addr2 string
City string
State string
Zip string
BeneficiarySsn string
ApplicantRelation string
Percentage integer <int32>
BirthDte string
LastUpdateDte string <date-time>
IsNew boolean

TpaId string
FlexAcctId string
BeneficiaryTypeCde enum<string>

Possible values: None Primary Contigent
BeneficiaryNumber integer <int32>
BeneficiaryName string
Addr1 string
Addr2 string
City string
State string
Zip string
BeneficiarySsn string
ApplicantRelation string
Percentage integer <int32>
BirthDte string
LastUpdateDte string <date-time>
IsNew boolean

Request URL

Authorization Bearer Token

tpaId (Required)

employerId (Required)

participantId (Required)

decrypt

Content Type

Request body (optional)

No response yet.

No response yet.

Participant APIs | REST