API Reference

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

put
https://example.com/wep/companies//onboarding/start//contactinfoee

Access: System, Admin, and ClientAdmin users only.

This endpoint stores employer-supplied contact details that phase 2 can start from.
When requested, the residential address is validated for payroll and the step can optionally be auto-approved for the employee.

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

Onboarding identifier from the route.

Body Params

Contact-information values to prefill into the employee step.

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

residentialAddress
object

Residential address used by the contact-information prefill payload.

string | null

Personal email address to prefill into the employee contact-information step.

string | null

Personal phone number to prefill into the employee contact-information step.

string | null

Personal cell-phone number to prefill into the employee contact-information step.

emergencyContact
object

Emergency-contact details for the employee.

boolean | null
required

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

int32
enum

Flags that alter how employer-supplied contact-information prefills are processed.

Members:

  • 1 - ValidResAddressForPayroll ( Validates the residential address for payroll before the data is stored. )

Allowed:
Headers
string
required
Defaults to 2.0

The requested API version

string
Defaults to 2.0

The requested API version

Responses
204

No Content

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