Participant APIs | REST

Selected Version:
Download Open API File

Get Employee Disclosure Accounts. This method returns the decrypted EmployeeId, FirstName and LastName.

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

Retrieves the disclosure accounts for a specific employee, identified by their unique TPA ID, Employer ID, and Participant ID. This operation is useful for accessing sensitive employee information in a secure manner.

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.

  • lastName string Required

    The last name of the participant, used to filter the disclosure accounts returned. This parameter is required to ensure accurate retrieval of employee information.

  • tokenId string Required

    A unique token that acknowledges the participant's consent to disclose their information. This parameter is essential for validating the request and ensuring compliance with privacy regulations.

  • 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>
    • TpaId string
    • EmprId string
    • DataPartnerId string
    • DataPartnerOptions integer <int64>
    • EmployeeID string
    • FlexAccountKey integer <int32>
    • PlanId string
    • PlanStartDate string
    • PlanEndDate string
    • DiscIntroTxt string
    • DiscLink1Name string
    • DiscLink1Url string
    • DiscLink1Desc string
    • DiscLink2Name string
    • DiscLink2Url string
    • DiscLink2Desc string
    • DiscLink3Name string
    • DiscLink3Url string
    • DiscLink3Desc string
    • DiscLink4Name string
    • DiscLink4Url string
    • DiscLink4Desc string
    • DiscLink5Name string
    • DiscLink5Url string
    • DiscLink5Desc string
    • DiscEndCustomText string
    • DiscAcceptText string
    • FirstName string
    • LastName string
  • array <object>
    • TpaId string
    • EmprId string
    • DataPartnerId string
    • DataPartnerOptions integer <int64>
    • EmployeeID string
    • FlexAccountKey integer <int32>
    • PlanId string
    • PlanStartDate string
    • PlanEndDate string
    • DiscIntroTxt string
    • DiscLink1Name string
    • DiscLink1Url string
    • DiscLink1Desc string
    • DiscLink2Name string
    • DiscLink2Url string
    • DiscLink2Desc string
    • DiscLink3Name string
    • DiscLink3Url string
    • DiscLink3Desc string
    • DiscLink4Name string
    • DiscLink4Url string
    • DiscLink4Desc string
    • DiscLink5Name string
    • DiscLink5Url string
    • DiscLink5Desc string
    • DiscEndCustomText string
    • DiscAcceptText string
    • FirstName string
    • LastName string
Response Headers
No response yet.
Response Body
No response yet.

AI Assistant Preview

Generating response...