Company Management

Show a company

Given an ID, shows a company.

With any token other than a client credentials token, only the token's company can be accessed through the endpoint.

Authentication

This endpoint accepts any one of the following token types:

Company-scoped access token (OAuth2AuthorizationCode) — obtained by a company manager through the Authorization Code flow or the Refresh Token flow. See Authentication for partners.
Company-scoped access token (assertion) (OAuth2CompanyManagerAssertion) — obtained through the urn:ietf:params:oauth:grant-type:jwt-bearer grant for a company manager. See OAuth Assertion.
Client credentials access token (OAuth2ClientCredentials) — obtained through the Client Credentials flow or the Refresh Token flow. See Authentication for partners.
Customer API token (CustomerAPIToken) — generated by the customer on their Integration Settings page, with the scopes they choose there. See Authorization for customers.

Scopes

Any one of the scopes in a token type's row is enough. all:read and all:write work too.

Token type	Category	Read only Scope	Write only Scope (read access implicit)
Company-scoped access token	Manage company resources (company_admin)	View companies (company:read)	-
Company-scoped access token (assertion)	Manage company resources (company_admin)	View companies (company:read)	-
Client credentials access token	Manage company resources (company_admin)	View companies (company:read)	Manage companies (company:write)
Customer API token	Manage company resources (company_admin)	View companies (company:read)	-

get/v1/companies/{company_id}

Request

Base URL
https://gateway.remote.com
URL
https://gateway.remote.com/v1/companies/{company_id}
Auth
- OAuth 2
  Authorization code: /auth/oauth2/authorize
  Token URL: /auth/oauth2/token scopes: https://gateway.remote.com/company.manage
- or OAuth 2
  Authorization code: /auth/oauth2/authorize
  Token URL: /auth/oauth2/token scopes: company:read
- or OAuth 2
  Authorization code: /auth/oauth2/authorize
  Token URL: /auth/oauth2/token scopes: all:read
- or OAuth 2
  Authorization code: /auth/oauth2/authorize
  Token URL: /auth/oauth2/token scopes: all:write
- or OAuth 2
  Client credentials
  Token URL: /auth/oauth2/token scopes: company:read
- or OAuth 2
  Client credentials
  Token URL: /auth/oauth2/token scopes: all:read
- or OAuth 2
  Client credentials
  Token URL: /auth/oauth2/token scopes: all:write
- or OAuth 2
  Client credentials
  Token URL: /auth/oauth2/token scopes: https://gateway.remote.com/company.manage
- or OAuth 2
  Client credentials
  Token URL: /auth/oauth2/token scopes: company:read
- or OAuth 2
  Client credentials
  Token URL: /auth/oauth2/token scopes: all:read
- or OAuth 2
  Client credentials
  Token URL: /auth/oauth2/token scopes: all:write
- or HTTP bearer

Path parameters

company_idstring required

Company ID

Headers

Authorizationstring required

An access token of one of the types listed in this endpoint's Authentication section, as Bearer <ACCESS TOKEN>.

A token from the Refresh Token flow is of the same type as the token issued with that refresh token.

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

Changes

No recorded changes to this operation across all 1 revision of this API.