Sign in

v1

latestOpenAPI 3.1.02026-07-242735131.1 MB
Sandbox

Set company credit risk status

Sets the credit risk status of a specific legal entity to any valid credit risk status.

Use this endpoint to test hiring flows affected by credit risk, without needing Remote admin intervention.

This endpoint is only available in Sandbox, otherwise it will respond with a 404.

post/v1/sandbox/companies/{company_id}/legal-entities/{legal_entity_id}/set-credit-risk-status

Path parameters

company_idstring required

Company ID

legal_entity_idstring required

Legal Entity ID

Headers

Authorizationstring required

Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow.

The refresh token needs to have been obtained through the Authorization Code flow.

Request body

credit_risk_statusstring required

Credit risk status to set.

Example request

{
  "credit_risk_status": "deposit_required"
}

Response

Success

Example response

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