v1

latestOpenAPI 3.1.02026-07-242735131.1 MB

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.

Category	Read only Scope	Write 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

company_idstring uuid required

Identifier of the employment being terminated.

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

Company ID

employment_idstring uuid required

Identifier of the employment being terminated.

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

Employment ID

Success

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