Participant APIs | REST

Selected Version:
Download Open API File

Get the list of investment accounts

https://api.wealthcare.com/participant/services/hsainvestment/accounts/{tpaId}/{employerId}/{participantId}

Retrieve a list of investment accounts associated with a specific participant, identified by their TPA ID, Employer ID, and Participant ID. This operation is useful for obtaining detailed investment information for account management and reporting purposes.

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.

Response

  • array <object>
    • FlexAcctId string

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

    • InvestmentPartner enum<string>

      Indicates which investment solution the account is using. Valid values are: None, WealthCareInvestment, and Devenir

      Possible values: None WealthCareInvestment Devenir
    • IsInvAcctCreated boolean

      Indicates whether the investment account is active.

  • array <object>
    • FlexAcctId string

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

    • InvestmentPartner enum<string>

      Indicates which investment solution the account is using. Valid values are: None, WealthCareInvestment, and Devenir

      Possible values: None WealthCareInvestment Devenir
    • IsInvAcctCreated boolean

      Indicates whether the investment account is active.

Response Headers
No response yet.
Response Body
No response yet.

AI Assistant Preview

Generating response...