Participant APIs | REST

Selected Version:
Download Open API File

Save multiple beneficiary details

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

Update the details of multiple beneficiaries for a specific participant identified by TPA ID, Employer ID, and Participant ID. This operation is typically used when adding or modifying beneficiary information 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.

  • 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.

  • 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
  • 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
  • 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 Headers
No response yet.
Response Body
No response yet.

AI Assistant Preview

Generating response...