Participant APIs | REST

Version:
Download Open API Specification

Get a list of documents

https://api.wealthcare.com/participant/services/document/management/document/{tpaId}

Get a list of documents

  • tpaId string Required

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

  • 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
  • retrieveOptions enum<string>

    Get the documents from these options: Hidden = 1, AllEmployer = 2,SelectedEmployer = 3, DocumentAudience = 4, All = 10

    Possible values: None Hidden AllEmployer SelectedEmployer DocumentAudience All
  • employerId string

    Unique identifier for the employer. Note: WealthCare Admin assigns the 3-character prefix; you assign the remaining characters. It's required when retrieve options is 2 (AllEmployer).

  • audienceId string

    Audience Id is required when retrieve options is 4(DocumentAudience).

  • decrypt integer <int32>

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

  • array <object>
    • DocumentKey integer <int32>
    • TpaId string
    • DocumentId string
    • DocumentName string
    • Description string
    • DocumentPostDate string <date-time>
    • ExpireDate string <date-time>
    • CategoryId string
    • CategoryName string
    • DisplayOrder integer <int32>
    • AudienceId string
    • AudienceName string
    • DocumentFileKey integer <int32>
    • FileDetails object
      • DocumentFileKey integer <int32>
      • ContentLength integer <int32>
      • ContentType string
      • FileName string
      • InputStream string <byte>
      • Base64 string
      • FileFormat enum<string>
        Possible values: All Unknown Fixed Csv Xml Pdf Qif Excel Jpeg Gif Bmp FixedNacha Delimited Word Png Tiff ExtFileFormat
    • LastUpdateDate string <date-time>
    • Employers array <object>
      • TpaId string
      • EmprId string
      • EmprName string
    • isLegacyDocument boolean
    • AssignedOption enum<string>
      Possible values: None Hidden AllEmployer SelectedEmployer DocumentAudience All