Sign in

v1

latestOpenAPI 3.1.02026-07-242735131.1 MB
Company Management

Update a company

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 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 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

CategoryRead only ScopeWrite only Scope (read access implicit)
Manage companies (company_management)-Manage companies (company:write)
put/v1/companies/{company_id}

Path parameters

company_idstring required

Company ID

Query parameters

integer

Specific version number

OR
'latest'

Use latest version

Version of the address_details form schema

integer

Specific version number

OR
'latest'

Use latest version

Version of the bank_account_details form schema

Headers

Authorizationstring required

Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow.

The refresh token needs to have been obtained through the Authorization Code flow.

Request body

address_detailsobject

Fields can vary depending on the country. Please, check the required fields structure using the Show form schema endpoint. Use the desired country and address_details as the form name for the placeholders. The response complies with the JSON Schema specification.

bank_account_detailsobject

Fields can vary depending on the country. Please, check the required fields structure using the Show form schema endpoint. Use the desired country and bank_account_details as the form name for the placeholders. The response complies with the JSON Schema specification.

country_codestring

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.

namestring

This field is only accepted if company is in status pending. Please contact Remote if you wish to update it.

phone_numberstring

A phone number the company can be contacted with.

registration_numberstring

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_numberstring

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.

Example request

{
  "address_details": {
    "address": "1709 Broderick St",
    "address_line_2": "Flat number 123",
    "city": "San Francisco",
    "postal_code": "94115",
    "state": "CA"
  },
  "bank_account_details": {
    "account_holder": "Joe Smith",
    "account_number": "31234123123",
    "account_type": "savings",
    "name": "Bank name",
    "ownership_type": "BUSINESS",
    "routing_number": "123124123"
  },
  "country_code": "USA",
  "desired_currency": "USD",
  "name": "Tech Vision",
  "phone_number": "+11123123456",
  "tax_number": "123456789"
}

Response

Success

Example response

{
  "data": {
    "company": {
      "address_details": {
        "address": "1709 Broderick St",
        "address_line_2": "Flat number 123",
        "city": "San Francisco",
        "postal_code": "94115",
        "state": "CA"
      },
      "bank_account_details": {
        "account_holder": "Joe Smith",
        "account_number": "31234123123",
        "account_type": "savings",
        "name": "Bank name",
        "ownership_type": "BUSINESS",
        "routing_number": "123124123"
      },
      "company_owner_email": "te@remote.com",
      "company_owner_name": "Joe Smith",
      "company_owner_user_id": "75619adf-8775-4531-9e7d-5b2cbabdc1a8",
      "country_code": "USA",
      "created_at": "2021-07-15T18:18:17Z",
      "default_legal_entity_credit_risk_status": "no_deposit_required",
      "desired_currency": "USD",
      "external_id": "00001111",
      "id": "e5a8b061-company-id-4c5c81ac885e",
      "name": "Your Company Name",
      "phone_number": "+1123123456",
      "status": "active",
      "terms_of_service_accepted_at": "2021-10-29T12:39:15Z",
      "updated_at": "2021-07-15T18:18:17Z"
    }
  }
}