Companies
Company Management

List a company's pending actions

Changed on

Given a company ID, returns the company-level actions still pending for the company — for example company verification and Remote Payments setup. The list can be empty or contain one or more actions; setup_remote_payments is returned once per legal entity that needs it.

Authentication

This endpoint accepts any one of the following token types:

  • Company-scoped access token (OAuth2AuthorizationCode) — obtained through the Authorization Code flow or the Refresh Token flow. See Authentication for partners.
  • 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 company resources (company_admin)View companies (company:read)Manage companies (company:write)
get/v1/companies/{company_id}/actions

Request

  • Base URL: https://gateway.remote.com
  • URL: https://gateway.remote.com/v1/companies/{company_id}/actions
  • Auth: OAuth 2 (authorization code, authorization URL /auth/oauth2/authorize, token URL /auth/oauth2/token, scopes: https://gateway.remote.com/company.manage, company:read, company:write, company_admin, all:write, all:read) and OAuth 2 (client credentials, token URL /auth/oauth2/token, scopes: https://gateway.remote.com/company.manage, company:read, company:write, company_admin, all:write, all:read)

Path parameters

company_idstring required

Company ID

Response

Success

Example response

{
  "data": {
    "actions": [
      {
        "required": true,
        "type": "verify_company"
      },
      {
        "legal_entity_id": "31b8e49b-aa1c-47af-849c-3d0a53e20e0d",
        "required": true,
        "type": "setup_remote_payments"
      }
    ]
  }
}

Changes

  • 09a7e24e0df5Revision changes
    • info

      the security scope company_admin was added to the endpoint's security scheme OAuth2AuthorizationCode

    • info

      the security scope company_admin was added to the endpoint's security scheme OAuth2ClientCredentials

    • info

      the security scope company_management was removed from the endpoint's security scheme OAuth2AuthorizationCode

    • info

      the security scope company_management was removed from the endpoint's security scheme OAuth2ClientCredentials

  • 9410f5f18a91Revision changes
    • info

      the security scope company_management was added to the endpoint's security scheme OAuth2AuthorizationCode

    • info

      the security scope company_management was added to the endpoint's security scheme OAuth2ClientCredentials

    • info

      the security scope company_admin was removed from the endpoint's security scheme OAuth2AuthorizationCode

    • info

      the security scope company_admin was removed from the endpoint's security scheme OAuth2ClientCredentials