Participant APIs | REST

Version:
Download Open API Specification

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

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

Retrieves the disclosure accounts for a specific employee, providing decrypted information including Employee ID, First Name, and Last Name. This operation is useful for accessing sensitive employee data while ensuring that the information is securely decrypted.

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, assigned during the employer creation process. This identifier consists of a 3-character prefix followed by additional characters defined by the user.

  • participantId string Required

    The unique identifier for the participant whose disclosure accounts are being requested. This ID is essential for retrieving the correct employee data.

  • lastName string Required

    The last name of the participant. This parameter helps to filter the results and ensure the correct employee is identified.

  • tokenId string Required

    The Disclosure Acknowledgement Token ID, which is required to validate the request and ensure that the user has acknowledged the necessary disclosures.

  • 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

AI Assistant Preview

Generating response...