Participant APIs | REST

Version:
Download Open API Specification

Get contact information for employee

https://api.wealthcare.com/participant/services/participant/employee/contact/{tpaId}/{employerId}/{participantId}

Get contact information for employee

  • 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

  • Accept-Language enum<string>

    Specify the participant’s language preference. The corresponding response will then return text/string values in the language specified, defaulting to English if not specified or if an invalid value is sent. Note: If Spanish or French is requested and a particular field does not have a translated value (Spanish or French), then the English text value will be returned.

    Possible values: es en fr
  • decrypt integer <int32>

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

  • TpaId string

    A unique identifier used to identify your admin instance. This value was system generated with the admin instance was created.

  • EmployerId string

    Unique identifier for the employer. Note: When an employer is created, WealthCare Admin assigns the 3-character prefix; you assign the remaining characters.

  • ContactURL string

    A URL to be presented to the participant. If the participant is tied to a division and the division has a URL configured, that will be returned. Otherwise, the employer’s consumer portal URL be returned will be returned, or if that does not exist, the consumer portal URL onfigured for the admin will be returned.

  • ContactPhone string

    A contact phone number to be presented to the participant. If the participant is tied to a division and the division has a phone number configured, that will be returned. Otherwise, the employer’s customer service phone number will be returned, or if that does not exist, the phone number configured for the admin will be returned.

  • ContactNotes string

    If a participant is tied to a division, this will return the division notes. This will be null if not applicable.