Administrative APIs | REST

Version:
Download Open API Specification

Add Employer User

https://api.wealthcare.com/system/Services/Employer/User/{tpaId}/{employerId}

  • 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.

  • firstName string Required

    User's first name.

    Min Length: 0
    Max Length: 50
  • lastName string Required

    User's last name.

    Min Length: 0
    Max Length: 50
  • userID string Required

    Unique user ID to be created. Must be between 4 and 25 alphanumeric characters.

  • password string Required

    Password to be assigned to the user ID. Password cannot be the same as the username and cannot contain the username. Between 8 and 16 characters.

  • profileName string Required

    Name of existing WCA employer user profile to assign this user.

  • middleInitial string

    User's middle initial.

    Min Length: 0
    Max Length: 1
  • namePrefix enum<string>

    User's name prefix.

    Possible values: Mr. Mrs. Ms. Dr. Rev.
  • phone string

    User's phone number including area code.

    Min Length: 0
    Max Length: 30
  • email string

    User's email address.

    Min Length: 0
    Max Length: 75
  • allowGetCurrentSessions boolean

    Allows user to authenticate via WCA Web Services.

  • allowToUploadAPayrollFile boolean

    Allows user to upload a payroll file through the Contribution Manager.

  • ErrorCode integer <int32>
  • ErrorDescription string