Employments
Risk Reserve

Submit risk reserve proof of payment

Submits a proof of payment document for a risk reserve associated with an employment.

Triggers an employment.cor_hiring.proof_of_payment_submitted webhook event.

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/employments/{employment_id}/risk-reserve-proof-of-payments

Request

  • Base URL: https://gateway.remote.com
  • URL: https://gateway.remote.com/v1/employments/{employment_id}/risk-reserve-proof-of-payments
  • 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)

Path parameters

employment_idstring required

Employment ID

Response

Success

Example response

{
  "data": {
    "slug": "5b44799c-e845-4d5c-9c52-b6e5f7c3d4e1",
    "status": "pending"
  }
}

Changes

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