--- title: "Get basic information" method: GET path: "/v2/employments/{employment_id}/basic-information" tags: ["Basic Information"] --- # Get basic information `GET /v2/employments/{employment_id}/basic-information` Returns the employment's basic information. This endpoint requires and returns country-specific data. The exact required and returned fields will vary depending on which country the employment is in. To see the list of parameters for each country, see the **Show form schema** endpoint under the [Countries](#tag/Countries) category. Please note that the compliance requirements for each country are subject to change according to local laws. Given its continual updates, using Remote's [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) should be considered in order to avoid compliance issues and to have the latest version of a country requirements. If you are using this endpoint to build an integration, make sure you are dynamically collecting or displaying the latest parameters for each country by querying the _"Show form schema"_ endpoint. For more information on JSON Schemas, see the **How JSON Schemas work** documentation. To learn how you can dynamically generate forms to display in your UI, see the documentation for the [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) tool. ## Scopes | Category | Read only Scope | Write only Scope (read access implicit) | |---|---|---| | Manage employments (`employments`) | View employments (`employment:read`) | Manage employments (`employment:write`) | ## Path parameters - `employment_id` string, required ## Query parameters - `employment_basic_information_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 - `403` — Forbidden - `404` — Not Found - `422` — Unprocessable Entity - `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/versions/7e6a0c61ac82/schema)