--- title: "Update a company" method: PATCH path: "/v1/companies/{company_id}" tags: ["Company Management"] --- # Update a company `PATCH /v1/companies/{company_id}` Given an ID and a request object with new information, updates a company. ### Getting a company and its owner to `active` status If you created a company using the [create a company endpoint](#tag/Companies/operation/post_create_company) without all the required request body parameters, you can use this endpoint to provide the missing data. Once the company and its owner have all the necessary data, both their statuses will be set to `active` and the company onboarding will be marked as "completed". The following constitutes a company with "all the necessary data": * Complete `address`, with valid `address`, `postal_code`, `country` and `state` parameters (Varies by country. Use the [show form schema endpoint](#tag/Countries/operation/get_show_form_country) to see which address parameters are required). * Company `tax_number` or `registration_number` is not nil * Company `name` is not nil (already required when creating the company) * Company has a `desired_currency` in their bank account (already required when creating the company) * Company has accepted terms of service (already required when creating the company) ## Scopes | Category | Read only Scope | Write only Scope (read access implicit) | |---|---|---| | Manage companies (`company_management`) | - | Manage companies (`company:write`) | ## Path parameters - `company_id` string, required ## Query parameters - `address_details_json_schema_version` union - integer — Specific version number - 'latest' — Use latest version - `bank_account_details_json_schema_version` union - integer — Specific version number - 'latest' — Use latest version ## Headers - `Authorization` string, required ## Request body - UpdateCompanyParams - `address_details` object — Fields can vary depending on the country. Please, check the required fields structure using the [Show form schema endpoint](#operation/get_show_form_country). Use the desired country and `address_details` as the form name for the placeholders. The response complies with the [JSON Schema](https://developer.remote.com/docs/how-json-schemas-work) specification. - `bank_account_details` object — Fields can vary depending on the country. Please, check the required fields structure using the [Show form schema endpoint](#operation/get_show_form_country). Use the desired country and `bank_account_details` as the form name for the placeholders. The response complies with the [JSON Schema](https://developer.remote.com/docs/how-json-schemas-work) specification. - `country_code` string — Country of company address - `desired_currency` 'AUD' | 'CAD' | 'CHF' | 'DKK' | 'EUR' | 'GBP' | 'JPY' | 'NOK' | 'NZD' | 'SEK' | 'SGD' | 'USD' — Desired currency for invoicing and displaying converted salaries in Remote UI regardless of the employee's country. This field is only accepted if company is in status `pending`. Please contact Remote if you wish to update it. - `name` string — This field is only accepted if company is in status `pending`. Please contact Remote if you wish to update it. - `phone_number` string — A phone number the company can be contacted with. - `registration_number` string — The company registration number. This field or tax_number (but not both) should be submitted. This field is only accepted if company is in status `pending`. - `tax_number` string — The tax identifier of the company. This field or registration_number (but not both) should be submitted. This field is only accepted if company is in status `pending`. ## Response `200` Success - CompanyResponse — Shows a company - `data` object, required - `company` Company - `address_details` object, required — Fields can vary depending on the country. Please, check the required fields structure using the [Show form schema endpoint](#operation/get_show_form_country). Use the desired country and `address_details` as the form name for the placeholders. The response complies with the [JSON Schema](https://developer.remote.com/docs/how-json-schemas-work) specification. - `bank_account_details` object — Fields can vary depending on the country. Please, check the required fields structure using the [Show form schema endpoint](#operation/get_show_form_country). Use the desired country and `bank_account_details` as the form name for the placeholders. The response complies with the [JSON Schema](https://developer.remote.com/docs/how-json-schemas-work) specification. - `company_owner_email` string, email, required — The email address of the company owner who administers the Remote account. - `company_owner_name` string — The full name of the company owner. Cannot be changed after company creation. - `company_owner_user_id` string, required — The unique identifier (UUID) of the company owner's user account on Remote. - `country_code` string, required — The ISO 3166-1 3-letter country code where the company is registered. - `created_at` string, date-time, required — The timestamp when the company was created on Remote. - `default_legal_entity_credit_risk_status` 'not_started' | 'ready' | 'in_progress' | 'referred' | 'fail' | 'deposit_required' | 'no_deposit_required', required — The credit risk status of the company default legal entity. - `not_started`: The credit risk assessment has not started yet. - `ready`: The credit risk assessment is ready to be started. - `in_progress`: The automated credit risk assessment is in progress. - `referred`: The credit risk assessment has been referred to a human reviewer. - `fail`: The credit risk assessment has failed and the company will be archived. - `deposit_required`: The company default legal entity requires a deposit before onboarding new employees. - `no_deposit_required`: The company default legal entity does not require a deposit before onboarding new employees. - `desired_currency` string, required — The ISO 4217 currency code the company prefers for billing and invoicing (e.g., "USD", "EUR"). - `external_id` string, nullable — A unique reference code for this company in a non-Remote system. Null if not set. - `id` string, required — The unique identifier (UUID) of the company. - `name` string, required — The company's registered name. Can only be changed while the company is in `pending` status. - `phone_number` string — The company's contact phone number. - `registration_number` string, nullable — The company's business registration number. Null if not provided. Can only be set while the company is in `pending` status. - `status` 'pending' | 'review' | 'active' | 'archived', required — The company status determines what a company is allowed to do: - `pending`: The company has been created and the company owner invited. Remote is waiting for the company owner to complete onboarding. - `review`: The company is under review. In rare occasions, a company may not automatically get created in `active` status because Remote needs to manually review the company that was created. The company will become `active` once the review is completed and no further action is necessary through the Remote API. - `active`: The company owner has completed onboarding and the company is ready to employ. - `archived`: The company is no longer active on the Remote platform and no changes can be made to the company. - `tax_number` string, nullable — The company's tax identification number. Null if not provided. Can only be set while the company is in `pending` status. - `terms_of_service_accepted_at` string, date-time, required — The timestamp when the company owner accepted Remote's Terms of Service. - `updated_at` string, date-time, required — The timestamp when the company record was last updated. ## Other responses - `400` — Bad Request - `401` — Unauthorized - `404` — Not Found - `422` — Unprocessable Entity - `429` — Too many requests --- [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)