CHcheckout
Onboarding Simulator

List available requirements

Sandbox only — not available in Production.

Returns all requirement fields that can be set as due on an entity. Use the field values when calling the Set requirements due endpoint.

get/simulate/requirements-due

Request

Response

Requirements listed successfully

fieldstring

The public path of the requirement field.

typestring

The data type of the field.

Example response

[
  {
    "field": "individual.identification.document",
    "type": "string"
  }
]

Changes

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