Participant APIs | REST

Version:

Download Open API Specification

Save multiple beneficiary details

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

Save the details of multiple beneficiaries.

Path parameters

tpaId string Required

A unique identifier used to identify your admin instance. This value was system generated with 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

Participant Id

Query parameters

decrypt integer <int32>

Indicate if the URI parameters are encrypted or not. 1: encrypted, 0: decrypted, default to 0.

Request body

TpaId string
FlexAcctId string
BeneficiaryList array <object>
- 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

Response

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