Participant APIs | REST

Version:
Download Open API Specification

Search Employee (Registration)

https://api.wealthcare.com/participant/registration/searchEmployee

Search for one or more employees.

  • decrypt integer <int32>

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

  • EmployeeID string
    Min Length: 0
    Max Length: 255
  • EmployerID string
    Min Length: 0
    Max Length: 18
  • TpaId string Required
    Min Length: 0
    Max Length: 6
  • FirstName string Required
    Min Length: 0
    Max Length: 50
  • LastName string Required
    Min Length: 0
    Max Length: 50
  • ZipCode string Required
    Min Length: 0
    Max Length: 15
  • CardNumber string
    Min Length: 0
    Max Length: 19
  • EmpeOtpViaSMSOnly boolean

    Indicates if OTP should be generated only via SMS.

  • 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 the employer was created, WealthCare Admin assigned the 3-character prefix; you assigned the remaining characters.

  • EmployeeId string

    Unique identifier for the Employee.

  • Phone string

    Employee’s phone number, including area code.

  • MobileNumber string

    Employee’s Mobile phone number.

  • Email string

    Employee’s email address.

  • EmployeeStatus enum<string>

    Activity status for the employee.

    Possible values: All New Active TempInactive PermInactive Terminated Enrollment
  • IsCardRequired boolean

    Indicates if card number is required during participant registration.