Updates the authenticated employee's residential address.

The address is replaced: optional fields that aren't sent are cleared.

The employment is derived from the access token's subject — there is no employment id in the path. The token must be an employee-role token (typically obtained via the OAuth2 assertion grant with subject urn:remote-api:employee:employment:<employment_id>).

This endpoint requires country-specific data. The exact required fields vary depending on which country the authenticated employee's employment is in. Query the Show form schema endpoint with address_details as the form name to discover the schema for a given country.

Authentication

This endpoint accepts any one of the following token types:

• Employee-scoped access token (OAuth2Assertion) — obtained through the urn:ietf:params:oauth:grant-type:jwt-bearer grant. See OAuth Assertion.
• Company-scoped access token (OAuth2AuthorizationCode) — obtained by the employee through the Authorization Code flow or the Refresh Token flow. See Authentication for partners.

Scopes

Any one of the scopes in a token type's row is enough. all:write works too.

{
  "address_details": {
    "city": "London",
    "country": "GBR",
    "postal_code": "SW1A 1AA",
    "street": "1 Imaginary Way"
  }
}

{
  "data": {
    "employment": {
      "contract_origin": "remote_contract",
      "id": "20a72f86-employment-id-9e4942a902ff",
      "personal_details": {},
      "status": "created",
      "type": "employee",
      "updated_at": "2024-01-15T10:30:00Z",
      "user_status": "active"
    }
  }
}