Companies
Compliance

Get Onboarding Reserves Status for Employment

Returns the onboarding reserves status for a specific employment.

The status is the same as the credit risk status but takes the onboarding reserves policies into account.

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 employments (employments)View employments (employment:read)Manage employments (employment:write)
get/v1/companies/{company_id}/employments/{employment_id}/onboarding-reserves-status

Request

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

Path parameters

company_idstring uuid required

A unique identifier in UUID v4 format.

Example:663e0b79-c893-45ff-a1b2-f6dcabc098b5

Company ID

employment_idstring uuid required

A unique identifier in UUID v4 format.

Example:663e0b79-c893-45ff-a1b2-f6dcabc098b5

Employment ID

Response

Success

Example response

{
  "data": {
    "policies": [
      "country_policy",
      "industry_policy"
    ],
    "status": "deposit_required"
  }
}

Changes

No recorded changes to this operation across all 65 revisions of this API.