Resolve pending requirements
Beta
Last updated: June 3, 2026
Checkout.com may raise requirements on a sub-entity at any point in its lifecycle. This could be during initial onboarding, after account change requests, or as part of periodic reviews.
Each requirement represents a single piece of information or document we need to collect. We return a priority and deadline for each requirement so you can surface the most urgent items to your sub-entities first.
Note
To resolve a requirement, you can:
- List all pending requirements for the sub-entity.
- Retrieve each requirement's details, including the JSON schema that defines the expected response.
- Submit a value that satisfies the schema.
To retrieve all pending requirements for a sub-entity, call the List requirements endpoint and provide the sub-entity ID as the {id} path parameter.
Information
Your base URL's {prefix} value is unique to your account and environment. To learn how to retrieve your base URLs for the sandbox and production environments, see API endpoints.
get
https://{prefix}.api.checkout.com/accounts/entities/{id}/requirements
The response returns a data array of pending requirements. The array is empty when the sub-entity has no outstanding requirements.
To retrieve the full details of a single requirement, call the Get requirement details endpoint and provide the following path parameters:
id– The sub-entity's IDrequirementId– The requirement's ID, prefixed withreq_, as returned by the List requirements endpoint.
get
https://{prefix}.api.checkout.com/accounts/entities/{id}/requirements/{requirementId}
To submit a response to a requirement, call the Resolve a requirement endpoint, and provide the following path parameters:
id– The sub-entity's IDrequirementId– The requirement's ID, prefixed withreq_, as returned by the List requirements endpoint.
put
https://{prefix}.api.checkout.com/accounts/entities/{id}/requirements/{requirementId}
The expected format of value is determined by the requirement's _schema. Depending on the requirement, value can be a simple value (such as text, a number, or a boolean), a file reference, or a structured object. Before submitting, validate that value matches the _schema.
While your submission is processing, the requirement is no longer retrievable using the List pending requirements or Get requirement details endpoints. If the response validation fails, we re-issue the requirement and it reappears in the list.