Saves the employer-entered basic employee information for phase 1.

put

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

Access: System, Admin, and ClientAdmin users only.

The request stores the employee's identifying setup data and validates onboarding-type-specific country and SSN rules before advancing navigation metadata.

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

Phase-1 employee identity data to save.

Request payload for the phase-1 basic employee-information step.

firstName

string | null

required

Employee first name.

lastName

string | null

required

Employee last name.

string | null

Employee login email used for onboarding communication when required by the template.

ssn

string | null

Employee Social Security number.
This can be required by template rules or special onboarding actions.

countryCode

string | null

Two-letter country code.
This field is required for global onboardings and ignored for U.S.-only onboarding types.

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

Language

Credentials

Bearer

jwt

Loading…

Response

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

application/json

200OK

400Bad Request

403Forbidden

500Internal Server Error