Employments
Risk Reserve

Create risk reserve

Create a new risk reserve

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.
  • Customer API token (CustomerAPIToken) — generated by the customer on their Integration Settings page. See Authorization for customers.

Scopes

CategoryRead only ScopeWrite only Scope (read access implicit)
Manage company resources (company_admin)-Manage risk reserves (risk_reserve:write)
post/v1/risk-reserve

Request

  • Base URL: https://gateway.remote.com
  • URL: https://gateway.remote.com/v1/risk-reserve
  • Auth: HTTP bearer and OAuth 2 (authorization code, authorization URL /auth/oauth2/authorize, token URL /auth/oauth2/token, scopes: https://gateway.remote.com/company.manage, risk_reserve:write, company_admin, all:write)

Request body

employment_slugstring required

The unique identifier (UUID) of the employment to create a risk reserve for. The employment must exist and be in a state that allows risk reserve creation.

Example request

{
  "employment_slug": "0cb279d7-0489-432c-bebc-e3c3acf9ab14"
}

Response

Success

Example response

{
  "data": {
    "status": "ok"
  }
}

Changes

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