API Reference

Creates or replaces the employee's pending identification-number change request.

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

Access: Employee users only.

The submitted identification type must match the employee's legislative setup. The response returns the saved request payload in the public DTO format.

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

Identification-number request payload to store.

Payload used to submit or review an employee identification-number change request.

int32
enum

Members:

  • 1 - SSN ( SSN. )
  • 2 - FEIN ( FEIN. )
  • 3 - Foreigner ( Foreigner. )
  • 4 - Unpaid ( Unpaid Employee. )
  • 255 - Global ( Global. )
Allowed:
string | null

New Social Security Number value when Worklio.ApiModels.API.Models.Employees.Requests.SSN_v10.EmployeeIdentification is SSN.

string | null

New FEIN value when Worklio.ApiModels.API.Models.Employees.Requests.SSN_v10.EmployeeIdentification is FEIN.

string | null

New national identification value when Worklio.ApiModels.API.Models.Employees.Requests.SSN_v10.EmployeeIdentification is Global.

string | null

Optional employee note submitted together with the identification-number request.

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