API Reference

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

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

Access: Employee users only.

The country and state combination is validated against the employee's legislative profile before the request is stored.

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

Address-change request payload to store.

Payload used to submit or review an employee residential-address change request.

string | null
required

Primary address line for the employee residence.

string | null

Additional address line such as apartment, suite, or unit.

string | null
required

City for the residential address.

string | null

State, province, or region for the residential address when applicable.

string | null
required

Postal code for the residential address.

string | null

Country code or country name accepted by the residential-address request workflow.

double | null

Optional geolocation latitude associated with the residential address.

double | null

Optional geolocation longitude associated with the residential address.

string | null

Optional employee note submitted together with the address-change 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