Prefills the employee personal-information step from the employer side.

put

https://example.com/wep/companies/{companyId}/onboarding/start/{id}/personalinfoee

Access: System, Admin, and ClientAdmin users only.

The endpoint lets the employer seed or correct personal-information fields that the employee later sees in phase 2.
Depending on template configuration, driver-license details and W-2 electronic consent can be required before the step is approved.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

companyId

int32

required

Company identifier from the route.

int32

required

Onboarding identifier from the route.

Body Params

Personal-information values to prefill into the employee step.

Request payload used to prefill the employee personal-information step.

ssn

string | null

Social Security number to store or prefill for the employee.

salutation

int32

enum

Members:

1 - Mr ( Mr.. )
2 - Miss ( Miss.. )
3 - Mrs ( Mrs.. )
4 - Ms ( Ms. )
5 - Dr ( Dr.. )

Allowed:

firstName

string | null

Employee first name.

lastName

string | null

Employee last name.

middleName

string | null

Employee middle name.

otherName

string | null

Other legal name used by the employee, when applicable.

nickname

string | null

Preferred nickname.

suffix

string | null

Name suffix, such as Jr. or III.

birthOn

date | null

required

Date of birth in date format.
Data type is validated and must be Number

gender

int32

enum

Members:

1 - Female ( Female. )
2 - Male ( Male. )
3 - Other ( Other. )

Allowed:

citizenship

int32

enum

Members:

1 - USCitizen ( USCitizen. )
2 - PernamentResident ( PernamentResident. )
3 - ResidentAlien ( ResidentAlien. )
4 - NonResidentAlien ( NonResidentAlien. )

Allowed:

driversLicense

object

Driver's-license details captured for the employee personal-information step.

w2ElectronicConsent

boolean | null

Indicates whether the employee consents to receiving electronic W-2 forms.
This can be required when the step is being approved immediately.

approveStep

boolean | null

When true, the employee personal-information step is approved immediately after the prefill is saved.

Headers

api-version

string

required

Defaults to 2.0

The requested API version

x-api-version

string

Defaults to 2.0

The requested API version

Responses

204

No Content

400Bad Request

500Internal Server Error