API Reference

Creates or replaces the employee's pending general-information change request.

put
https://example.com/wep/companies//employees//requests/general

Access: Employee users only.

For US employees, citizenship is required. The response returns the saved request payload after the waiting request is created.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required

Company identifier from the route.

int32
required

Employee identifier from the route.

Body Params

General-information request payload to store.

Payload used to submit or review an employee general-information change request.

date | null
required

Employee date of birth in ISO 8601 date format (yyyy-MM-dd).
Data type is validated and must be Number

int32
enum

Members:

  • 1 - Female ( Female. )
  • 2 - Male ( Male. )
  • 3 - Other ( Other. )
Allowed:
int32 | null

Identifier of the configured gender-identity option, when the profile uses a custom lookup.

int32
enum

Members:

  • 1 - HeHimHis ( HeHimHis. )
  • 2 - TheThemTheirs ( TheThemTheirs. )
  • 3 - ZeHirHirs ( ZeHirHirs. )
  • 4 - ZeZirZirs ( ZeZirZirs. )
  • 5 - SheHerHers ( SheHerHers. )
  • 6 - Other ( Other. )
  • 7 - PreferNotToAnswer ( PreferNotToAnswer. )
Allowed:
int32
enum

Members:

  • 1 - USCitizen ( USCitizen. )
  • 2 - PernamentResident ( PernamentResident. )
  • 3 - ResidentAlien ( ResidentAlien. )
  • 4 - NonResidentAlien ( NonResidentAlien. )
Allowed:
string | null

Visa type recorded for the employee when applicable.

date | null

Visa expiration date in ISO 8601 date format (yyyy-MM-dd), or null when not applicable.
Data type is validated and must be Number

int32
enum

Members:

  • 1 - HispanicOrLatino ( Hispanic or Latino. )
  • 2 - White ( White. )
  • 3 - BlackOrAfricanAmerican ( Black or African American. )
  • 4 - NativeHawaiianOrOtherPacificIslander ( Native Hawaiian or Other Pacific Islander. )
  • 5 - Asian ( Asian. )
  • 6 - AmericanIndianOrAlaskaNative ( American Indian or Alaska Native. )
  • 7 - TwoOrMoreRaces ( Two or More Races. )
  • 8 - MiddleEasternOrNorthAfrican ( MiddleEasternOrNorthAfrican. )
int32
enum

Members:

  • 1 - Single ( Single. )
  • 2 - Married ( Married. )
  • 3 - Separated ( Separated. )
  • 4 - DivorcedOrWidowed ( Divorced or Widowed. )
Allowed:
string | null

Driver's license number, when applicable.

date | null

Driver's license expiration date in ISO 8601 date format (yyyy-MM-dd), or null when not applicable.
Data type is validated and must be Number

string | null

Driver's license class, when applicable.

string | null

Two-character state or region code for the driver's license when applicable.

string | null

Two-character country code for the driver's license when applicable.

string | null

Optional employee note submitted together with the general-information request.

boolean | null

Indicates whether the employee consents to electronic-only W-2 delivery.

Headers
string
required
Defaults to 2.0

The requested API version

string
Defaults to 2.0

The requested API version

Responses

Updated about 1 month ago

Language
Credentials
Bearer
jwt
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago