---
title: "Show employee address"
method: GET
path: "/v1/employee/address"
tags: ["Employee Address"]
---

# Show employee address

`GET /v1/employee/address`

Returns the authenticated employee's residential address.

The employment is derived from the access token's subject — there is no
employment id in the path.

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](#tag/Countries/operation/get_show_form_country) endpoint with `address_details`
as the form name to discover the schema for a given country.



## Scopes

| Category | Read only Scope | Write only Scope (read access implicit) |
|---|---|---|
| Manage employments (`employments`) | View addresses (`address:read`) | Manage addresses (`address:write`) |

## Query parameters

- `address_details_json_schema_version` union
  - integer — Specific version number
  - 'latest' — Use latest version

## Response `200`

Success

- EmploymentDetailsOnlyResponse — Response containing only the updated details struct plus base employment fields (id, status, type, updated_at, user_status). Exactly one of the details properties is present per response.
  - `data` object, required
    - `employment` object
      - `address_details` object, nullable — Home address information. Its properties may vary depending on the country. Null if the employee has not submitted their address yet.
      - `administrative_details` object — Administrative information. Its properties may vary depending on the country.
      - `bank_account_details` object[]
      - `basic_information` object — Basic information. Its properties may vary depending on the country.
      - `billing_address_details` object — Billing address information. Its properties may vary depending on the country.
      - `contract_details` object — Contract details information. Its properties may vary depending on the country.
      - `contract_origin` 'remote_contract' | 'custom_remote_contract' | 'provided_by_customer', nullable — Origin of the employment contract. Returned by the basic information endpoint.
      - `emergency_contact_details` object, nullable — Emergency contact information. Its properties may vary depending on the country. Null if the employee has not submitted their emergency contact yet.
      - `id` string, required — The unique identifier (UUID) of the employment.
      - `personal_details` object, nullable — Personal details information. Its properties may vary depending on the country. Null if the employee has not submitted their personal details yet.
      - `pricing_plan_details` object — Pricing plan information.
      - `status` 'active' | 'created' | 'pre_hire' | 'created_awaiting_reserve' | 'created_reserve_paid' | 'initiated' | 'invited' | 'pending' | 'review' | 'job_title_review' | 'pending_post_self_enrollment_actions' | 'offboarding' | 'archived' | 'deleted', required — The current status of the employment record. - `active`: The employee is fully onboarded and actively working. - `created`: The employment has been created but onboarding has not started. - `pre_hire`: A pre-hire employment record, created before formal onboarding begins. - `created_awaiting_reserve`: The employment is created but waiting for a risk reserve deposit to be paid. - `created_reserve_paid`: The risk reserve has been paid and the employment can proceed with onboarding. - `initiated`: Onboarding has been started by the employer. - `invited`: The employee has been invited to complete their self-enrollment on Remote. - `pending`: The employment is pending review or further action before it can become active. - `review`: The employment is under review by Remote (e.g., contract or compliance review). - `archived`: The employment has been terminated or offboarded. - `deleted`: The employment record has been deleted.
      - `type` 'employee' | 'contractor' | 'direct_employee' | 'global_payroll_employee', required — The type of employment.
      - `updated_at` string, required — The timestamp when this employment record was last updated.
      - `user_status` 'active' | 'created' | 'initiated' | 'cancelled' | 'inactive' | 'deleted', required — The status of the user account associated with this employment. - `active`: The user account is active and the user can log in. - `created`: The user account has been created but not yet activated. - `initiated`: The user has been invited but has not completed registration. - `cancelled`: The user account was cancelled before activation. - `inactive`: The user account has been deactivated (e.g., after offboarding). - `deleted`: The user account has been deleted.

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found
- `429` — Unprocessable Entity

---

[API](https://skmtc.net/remote-com/apis/remote.md) · [All operations](https://skmtc.net/remote-com/apis/remote/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/remote-com/remote/revisions/7e6a0c61ac82/schema)
