Update an existing employee with an employer

patch

https://api.symmetry.com/i9/v1/employers/{employerId}/employees/{employeeId}

Path Params

employerId

string

required

employeeId

string

required

Body Params

address

object

The address sub-element of the Employee element contains all data pertaining to Employee's physical address.

appliedForSsn

boolean

Indicates whether the employee has applied for an SSN. If true, socialSecurityNumber cannot be provided. If false, socialSecurityNumber is required. For updates, this field is optional.

dateOfBirth

date

required

Date of birth associated with a Employee.

emailAddress

string

required

Email address associated with a Employee.

employment

object

required

Current employment record

firstName

string

required

Employee's first name.

gender

string

enum

Allowed:

uuid

lastName

string

required

Employee's last name.

middleName

string

Employee's middle name.

nickname

string

skipEverify

boolean

Allows employer to manage E-Verify cases manually via the E-Verify website directly. When true, employee will not be automatically sent to E-Verify when Form I-9 is completed.

socialSecurityNumber

string

Employee's Social Security Number. Must be exactly 9 digits. All non-numeric characters will be automatically removed before validation (for example, 123-45-6789 will be validated as 123456789). Required when appliedForSsn is false. Cannot be provided when appliedForSsn is true.

telephoneNumber

string

The phone number associated with a Employee. Required if remote verification (i9RemoteCounterSignAuthorized or i9RemoteReverificationAuthorized) is enabled.

Responses

404

Resource not found

Language

Credentials

Bearer

JWT

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

400Bad Request - Validation errors or malformed request. Common issues include: missing required fields, invalid field formats, or conditional validation failures (e.g., SSN required when appliedForSsn is false).