Administrative APIs | REST

Version:
Download Open API Specification

Add Employer User

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

Creates a new employer user within the specified employer account, identified by TPA ID and Employer ID. This operation is typically used when onboarding new users who require access to the employer's administrative functions.

Request

  • 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

    User's first name.

    Min Length: 0
    Max Length: 50
  • lastName string

    User's last name.

    Min Length: 0
    Max Length: 50
  • userID string

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

  • password string

    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

    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.

Response

  • ErrorCode integer <int32>
  • ErrorDescription string

AI Assistant Preview

Generating response...