Companies
Company Management

Create a company

Changed on

Creates a new company.

Creating a company with only the required request body parameters

When you call this endpoint and omit all the optional parameters in the request body, the following resources get created upon a successful response:

  • A new company with status pending.
  • A company owner for the new company with status initiated.

See the update a company endpoint for more details on how to get your company and its owner to active status.

If you'd like to create a company and its owner with active status in a single request, please provide the optional address_details parameter as well.

Accepting the Terms of Service

A required step for creating a company in Remote is to accept our Terms of Service (ToS).

Company managers need to be aware of our Terms of Service and Privacy Policy, hence it's the responsibility of our partners to advise and ensure company managers read and accept the ToS. The terms have to be accepted only once, before creating a company, and the Remote API will collect the acceptance timestamp as its confirmation.

To ensure users read the most recent version of Remote's Terms of Service, their acceptance must be done within the last fifteen minutes prior the company creation action.

To retrieve this information, partners can provide an element with any text and a description explaining that by performing that action they are accepting Remote's Term of Service. For instance, the partner can add a checkbox or a "Create Remote Account" button followed by a description saying "By creating an account, you agree to Remote's Terms of Service. Also see Remote's Privacy Policy".

Authentication

This endpoint requires the following token type:

  • Client credentials access token (OAuth2ClientCredentials) — obtained through the Client Credentials flow or the Refresh Token flow. See Authentication for partners.

Scopes

CategoryRead only ScopeWrite only Scope (read access implicit)
Manage companies (company_management)-Manage companies (company:write)
post/v1/companies

Request

  • Base URL: https://gateway.remote.com
  • URL: https://gateway.remote.com/v1/companies
  • Auth: OAuth 2 (client credentials, token URL /auth/oauth2/token, scopes: https://gateway.remote.com/company.manage, company:write, company_management, all:write)

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

actionstring

Complementary action(s) to perform when creating a company:

  • get_oauth_access_tokens returns the user's access and refresh tokens
  • send_create_password_email sends a reset password token to the company owner's email so they can log in using Remote UI (not needed if integration plans to use SSO only)

If action contains send_create_password_email you can redirect the user to https://employ.remote.com/api-integration-new-password-send

asyncboolean

Whether the request should be performed async

scopestring

Scope of the access token

Headers

Authorizationstring required

Requires a client credentials access token obtained through the Client Credentials flow or the Refresh Token flow.

The refresh token needs to have been obtained through the Client Credentials flow.

Request body

OR

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"
  },
  "company_owner_email": "ceo@techvision.com",
  "company_owner_name": "Joe Smith",
  "country_code": "USA",
  "desired_currency": "USD",
  "external_id": "00001111",
  "name": "Tech Vision",
  "phone_number": "+11123123456",
  "tax_number": "123456789",
  "terms_of_service_accepted_at": "2022-05-05 15:03:45Z"
}

Response

Created

Example response

{
  "data": {
    "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"
      }
    }
  }
}

Changes

    • breaking

      added subschema #1 subschema #2 to the request body allOf list

    • warning

      removed subschema #1 subschema #2 from the request body allOf list

    • breaking

      added subschema #1 subschema #2 to the request body allOf list

    • breaking

      the request's body type changed from object to no type

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property