CHcheckout
Onboarding Simulator

Set requirements due

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.

post/simulate/entities/{entityId}/requirements-due

Request

Request body

fieldsstring[] required

The requirement fields to mark as due. <br/> Call the List available requirements endpoint for a list of valid values.

Example request

{
  "fields": [
    "individual.identification.document"
  ]
}

Response

Requirements due set successfully

entity_idstring

The ID of the entity.

previous_statusstring

The status before the update.

current_statusstring

The status after the update.

requirements_duestring[]

The requirement fields that are now marked as due.

Example response

{
  "entity_id": "ent_w4jelhppmfiufdnatam37wrfc4",
  "previous_status": "Active",
  "current_status": "requirements_due",
  "requirements_due": [
    "individual.identification.document"
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.