Update employee demographic

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

The Update Employee Demographic API is used to update an employee’s basic demographic information including name, billing and shipping address, email, phone and other miscellaneous employee details.

Path parameters

tpaId string Required

A unique identifier used to identify your admin instance. This value is system generated when 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

Unique identifier for the participant user whose feature information is being retrieved.

Query parameters

decrypt integer <int32>

Indicate if the URI parameters are encrypted or not. Use 1 for encrypted, 0 for decrypted (default is 0). This affects how the API interprets the incoming identifiers.

Request body

ParticipantId string

Unique identifier for the employee.
FirstName string

First name of employee.
LastName string

Last name of employee.
MiddleInitial string

Employee’s middle initial.
BirthDate string

Birth date of employee.
EmployeeSSN string

Social Security Number of employee.
MaritalStatus enum<string>

Marital status of the employee.

Possible values: None Single Married Separated Widowed Divorced
Gender enum<string>

Gender of employee.

Possible values: None Male Female
MotherMaidenName string

Maiden name of employee's mother.
DriverLicenceNumber string

Employee Driver’s License Number.
Phone string

Employee’s phone number, including area code.
Email string

Email id of employee.
AddressLine1 string

First line of employee’s mailing address.
AddressLine2 string

Second line of employee’s mailing address.
City string

City associated with employee’s mailing address.
State string

2-character state code associated with the employee’s mailing address.
Zip string

ZIP code associated with the employee’s mailing address.
Country string

Country associated with employee’s mailing address.
ShippingAddressLine1 string

First line of the employee’s shipping address.
ShippingAddressLine2 string

Second line of the employee’s shipping address.
ShippingAddressCity string

City associated with an employee’s shipping address.
ShippingAddressState string

The 2-character state code associated with the employee’s shipping address.
ShippingAddressZip string

ZIP code associated with the employee’s shipping address.
ShippingAddressCountry string

Country associated with the employee’s shipping address.
LastUpdated string <date-time>

Last date the employee demographic data was modified.
MiscData object
- CitizenStatusCode enum<string>
  
  State code associated with the employee’s citizenship.
  
  Possible values: None USCitizen ResidentAlien NonResidentAlien
- CitizenshipCountry string
  
  Country name whose citizenship employee is holding.
- BaseSalary number <double>
  
  Initial Salary paid to an employee without any benefits.
- EmployermentStatus enum<string>
  
  Employment status associated with employee.
  
  Possible values: None Employed Unemployed SelfEmployed
- EmployerName string
  
  Name of employer.
- EmployerCity string
  
  City associated with employer's mailing address.
- EmployerState string
  
  State code associated with the employer's mailing address.
- JobTitle string
  
  Name that describes someone's job or position.

ParticipantId string

Unique identifier for the employee.
FirstName string

First name of employee.
LastName string

Last name of employee.
MiddleInitial string

Employee’s middle initial.
BirthDate string

Birth date of employee.
EmployeeSSN string

Social Security Number of employee.
MaritalStatus enum<string>

Marital status of the employee.

Possible values: None Single Married Separated Widowed Divorced
Gender enum<string>

Gender of employee.

Possible values: None Male Female
MotherMaidenName string

Maiden name of employee's mother.
DriverLicenceNumber string

Employee Driver’s License Number.
Phone string

Employee’s phone number, including area code.
Email string

Email id of employee.
AddressLine1 string

First line of employee’s mailing address.
AddressLine2 string

Second line of employee’s mailing address.
City string

City associated with employee’s mailing address.
State string

2-character state code associated with the employee’s mailing address.
Zip string

ZIP code associated with the employee’s mailing address.
Country string

Country associated with employee’s mailing address.
ShippingAddressLine1 string

First line of the employee’s shipping address.
ShippingAddressLine2 string

Second line of the employee’s shipping address.
ShippingAddressCity string

City associated with an employee’s shipping address.
ShippingAddressState string

The 2-character state code associated with the employee’s shipping address.
ShippingAddressZip string

ZIP code associated with the employee’s shipping address.
ShippingAddressCountry string

Country associated with the employee’s shipping address.
LastUpdated string <date-time>

Last date the employee demographic data was modified.
MiscData object
- CitizenStatusCode enum<string>
  
  State code associated with the employee’s citizenship.
  
  Possible values: None USCitizen ResidentAlien NonResidentAlien
- CitizenshipCountry string
  
  Country name whose citizenship employee is holding.
- BaseSalary number <double>
  
  Initial Salary paid to an employee without any benefits.
- EmployermentStatus enum<string>
  
  Employment status associated with employee.
  
  Possible values: None Employed Unemployed SelfEmployed
- EmployerName string
  
  Name of employer.
- EmployerCity string
  
  City associated with employer's mailing address.
- EmployerState string
  
  State code associated with the employer's mailing address.
- JobTitle string
  
  Name that describes someone's job or position.

Response

Response body

ParticipantId string

Unique identifier for the employee.
FirstName string

First name of employee.
LastName string

Last name of employee.
MiddleInitial string

Employee’s middle initial.
BirthDate string

Birth date of employee.
EmployeeSSN string

Social Security Number of employee.
MaritalStatus enum<string>

Marital status of the employee.

Possible values: None Single Married Separated Widowed Divorced
Gender enum<string>

Gender of employee.

Possible values: None Male Female
MotherMaidenName string

Maiden name of employee's mother.
DriverLicenceNumber string

Employee Driver’s License Number.
Phone string

Employee’s phone number, including area code.
Email string

Email id of employee.
AddressLine1 string

First line of employee’s mailing address.
AddressLine2 string

Second line of employee’s mailing address.
City string

City associated with employee’s mailing address.
State string

2-character state code associated with the employee’s mailing address.
Zip string

ZIP code associated with the employee’s mailing address.
Country string

Country associated with employee’s mailing address.
ShippingAddressLine1 string

First line of the employee’s shipping address.
ShippingAddressLine2 string

Second line of the employee’s shipping address.
ShippingAddressCity string

City associated with an employee’s shipping address.
ShippingAddressState string

The 2-character state code associated with the employee’s shipping address.
ShippingAddressZip string

ZIP code associated with the employee’s shipping address.
ShippingAddressCountry string

Country associated with the employee’s shipping address.
LastUpdated string <date-time>

Last date the employee demographic data was modified.
MiscData object
- CitizenStatusCode enum<string>
  
  State code associated with the employee’s citizenship.
  
  Possible values: None USCitizen ResidentAlien NonResidentAlien
- CitizenshipCountry string
  
  Country name whose citizenship employee is holding.
- BaseSalary number <double>
  
  Initial Salary paid to an employee without any benefits.
- EmployermentStatus enum<string>
  
  Employment status associated with employee.
  
  Possible values: None Employed Unemployed SelfEmployed
- EmployerName string
  
  Name of employer.
- EmployerCity string
  
  City associated with employer's mailing address.
- EmployerState string
  
  State code associated with the employer's mailing address.
- JobTitle string
  
  Name that describes someone's job or position.

ParticipantId string

Unique identifier for the employee.
FirstName string

First name of employee.
LastName string

Last name of employee.
MiddleInitial string

Employee’s middle initial.
BirthDate string

Birth date of employee.
EmployeeSSN string

Social Security Number of employee.
MaritalStatus enum<string>

Marital status of the employee.

Possible values: None Single Married Separated Widowed Divorced
Gender enum<string>

Gender of employee.

Possible values: None Male Female
MotherMaidenName string

Maiden name of employee's mother.
DriverLicenceNumber string

Employee Driver’s License Number.
Phone string

Employee’s phone number, including area code.
Email string

Email id of employee.
AddressLine1 string

First line of employee’s mailing address.
AddressLine2 string

Second line of employee’s mailing address.
City string

City associated with employee’s mailing address.
State string

2-character state code associated with the employee’s mailing address.
Zip string

ZIP code associated with the employee’s mailing address.
Country string

Country associated with employee’s mailing address.
ShippingAddressLine1 string

First line of the employee’s shipping address.
ShippingAddressLine2 string

Second line of the employee’s shipping address.
ShippingAddressCity string

City associated with an employee’s shipping address.
ShippingAddressState string

The 2-character state code associated with the employee’s shipping address.
ShippingAddressZip string

ZIP code associated with the employee’s shipping address.
ShippingAddressCountry string

Country associated with the employee’s shipping address.
LastUpdated string <date-time>

Last date the employee demographic data was modified.
MiscData object
- CitizenStatusCode enum<string>
  
  State code associated with the employee’s citizenship.
  
  Possible values: None USCitizen ResidentAlien NonResidentAlien
- CitizenshipCountry string
  
  Country name whose citizenship employee is holding.
- BaseSalary number <double>
  
  Initial Salary paid to an employee without any benefits.
- EmployermentStatus enum<string>
  
  Employment status associated with employee.
  
  Possible values: None Employed Unemployed SelfEmployed
- EmployerName string
  
  Name of employer.
- EmployerCity string
  
  City associated with employer's mailing address.
- EmployerState string
  
  State code associated with the employer's mailing address.
- JobTitle string
  
  Name that describes someone's job or position.

Request URL

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

tpaId (Required) A unique identifier used to identify your admin instance. This value is system generated when the admin instance was created.

employerId (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 (Required) Unique identifier for the participant user whose feature information is being retrieved.

decrypt Indicate if the URI parameters are encrypted or not. Use 1 for encrypted, 0 for decrypted (default is 0). This affects how the API interprets the incoming identifiers.

Content Type

Request body (application/json)

Response

No response yet.

No response yet.

Language

Example

Participant APIs | REST