---
title: "Set requirements due"
method: POST
path: "/simulate/entities/{entityId}/requirements-due"
tags: ["Onboarding Simulator"]
---

# Set requirements due

`POST /simulate/entities/{entityId}/requirements-due`

## Request

- Base URL: `https://{prefix}.api.sandbox.checkout.com`
- URL: `https://{prefix}.api.sandbox.checkout.com/simulate/entities/{entityId}/requirements-due`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `string` scopes: `accounts`
- TypeScript: <https://skmtc.dev/checkout/apis/checkout-com-api-reference/docs/simulate/entities/:entityId/requirements-due/post.ts> (a function with typed inputs; its response is checked against the schema)

**Sandbox only** — not available in Production.

Marks the specified requirement fields as due on an entity. Use this to test how your integration handles the requirements-due state.

## Request body

- SimulatorSetRequirementsDueRequest
  - `fields` string[], required: The requirement fields to mark as due. <br/> Call the [List available requirements](/#tag/Onboarding-Simulator/paths/~1simulate~1requirements-due/get) endpoint for a list of valid values.

## Response `200`

Requirements due set successfully

- SimulatorSetRequirementsDueResponse
  - `entity_id` string: The ID of the entity.
  - `previous_status` string: The status before the update.
  - `current_status` string: The status after the update.
  - `requirements_due` string[]: The requirement fields that are now marked as due.

## Other responses

- `400`: Unknown or missing fields
- `401`: Unauthorized
- `404`: Entity not found
- `502`: Dependency error

---

[API](https://skmtc.dev/checkout/apis/checkout-com-api-reference.md) - [All operations](https://skmtc.dev/checkout/apis/checkout-com-api-reference/llms.txt) - [OpenAPI document](https://skmtc.dev/checkout/apis/checkout-com-api-reference/revisions/0f1abdb1c3e9?raw)