# Resolve pending requirements 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. The `reason` field indicates why we raised the requirement: - `onboarding` – Raised during the sub-entity's initial onboarding. We do not return a `priority` or `deadline`. - `change_request` – Raised after an account change request. We do not return a `priority` or `deadline`. - `periodic_review` – Raised as part of a [periodic review](https://www.checkout.com/docs/platforms/for-payfac/manage-sub-entities/manage-periodic-reviews.md). We return a `priority` and `deadline` so you can surface the most urgent items to your sub-entities first. > **Note** > > If a requirement with a deadline remains unresolved after that date, the sub-entity's status and payment capabilities may be affected. To resolve a requirement on behalf of a sub-entity, you can: 1. List all pending requirements for the sub-entity. 2. Retrieve each requirement's details, including the JSON schema that defines the expected response. 3. Submit a value that satisfies the schema. --- ## List all pending requirements To retrieve all pending requirements for a sub-entity, call the [List requirements](https://api-reference.checkout.com/tag/Platforms#operation/listEntityRequirements) 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](https://www.checkout.com/docs/developer-resources/api/api-endpoints.md). **Production** `GET` `https://{prefix}.api.checkout.com/accounts/entities/{id}/requirements` **Sandbox** `GET` `https://{prefix}.api.sandbox.checkout.com/accounts/entities/{id}/requirements` ### Response example ```json { "data": [ { "id": "req_lg7k2n9xba4htpqz3we6cmj5vu", "resource": "ent_wxglze3wwywujg4nna5fb7ldli", "resource_type": "company", "reason": "onboarding", "urn": "urn:object:company#ent_wxglze3wwywujg4nna5fb7ldli#field:registered-address", "field_path": "company.registered_address", "field_urn": "urn:field:companies/registered-address", "metadata": { "purpose": "company_verification" }, "_links": { "self": { "href": "https://{prefix}.api.checkout.com/accounts/entities/ent_wxglze3wwywujg4nna5fb7ldli/requirements/req_lg7k2n9xba4htpqz3we6cmj5vu" } } }, { "id": "req_5wmacwhrhbzhqkhx5hlqmzje44", "resource": "ent_wxglze3wwywujg4nna5fb7ldli", "resource_type": "company", "reason": "periodic_review", "priority": "critical", "deadline": "2026-05-10T00:00:00Z", "urn": "urn:object:company#ent_wxglze3wwywujg4nna5fb7ldli#field:legal-name", "field_path": "company.legal_name", "field_urn": "urn:field:companies/legal-name", "metadata": { "purpose": "company_verification" }, "_links": { "self": { "href": "https://{prefix}.api.checkout.com/accounts/entities/ent_wxglze3wwywujg4nna5fb7ldli/requirements/req_5wmacwhrhbzhqkhx5hlqmzje44" } } } ] } ``` The response returns a `data` array of pending requirements. The array is empty when the sub-entity has no outstanding requirements. --- ## Get requirement details To retrieve the full details of a single requirement, call the [Get requirement details](https://api-reference.checkout.com/tag/Platforms/#operation/getEntityRequirement) endpoint and provide the following path parameters: - `id` – The sub-entity's ID - `requirementId` – The requirement's ID, prefixed with `req_`, as returned by the [List requirements](https://api-reference.checkout.com/tag/Platforms/#operation/listEntityRequirements) endpoint. **Production** `GET` `https://{prefix}.api.checkout.com/accounts/entities/{id}/requirements/{requirementId}` **Sandbox** `GET` `https://{prefix}.api.sandbox.checkout.com/accounts/entities/{id}/requirements/{requirementId}` ### Response example ```json { "id": "req_5wmacwhrhbzhqkhx5hlqmzje44", "resource": "ent_wxglze3wwywujg4nna5fb7ldli", "resource_type": "company", "reason": "periodic_review", "priority": "high", "deadline": "2026-06-01T00:00:00Z", "urn": "urn:object:company#ent_wxglze3wwywujg4nna5fb7ldli#field:legal-name", "field_path": "company.legal_name", "field_urn": "urn:field:companies/legal-name", "metadata": { "purpose": "company_verification" }, "message": "Please confirm your legal company name.", "_schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "_links": { "self": { "href": "https://{prefix}.api.checkout.com/accounts/entities/ent_wxglze3wwywujg4nna5fb7ldli/requirements/req_5wmacwhrhbzhqkhx5hlqmzje44" }, "collection": { "href": "https://{prefix}.api.checkout.com/accounts/entities/ent_wxglze3wwywujg4nna5fb7ldli/requirements" } } } ``` --- ## Resolve a requirement To submit a response to a requirement, call the [Resolve a requirement](https://api-reference.checkout.com/tag/Platforms/#operation/resolveEntityRequirement) endpoint, and provide the following path parameters: - `id` – The sub-entity's ID - `requirementId` – The requirement's ID, prefixed with `req_`, as returned by the [List requirements](https://api-reference.checkout.com/tag/Platforms/#operation/listEntityRequirements) endpoint. **Production** `PUT` `https://{prefix}.api.checkout.com/accounts/entities/{id}/requirements/{requirementId}` **Sandbox** `PUT` `https://{prefix}.api.sandbox.checkout.com/accounts/entities/{id}/requirements/{requirementId}` ### Request example 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`. ```json { "value": "Acme Holdings Limited" } ``` ### Response example ```json { "id": "req_5wmacwhrhbzhqkhx5hlqmzje44", "status": "processing", "submitted_at": "2026-05-05T10:15:30Z", "_links": { "self": { "href": "https://{prefix}.api.checkout.com/accounts/entities/ent_wxglze3wwywujg4nna5fb7ldli/requirements/req_5wmacwhrhbzhqkhx5hlqmzje44" }, "collection": { "href": "https://{prefix}.api.checkout.com/accounts/entities/ent_wxglze3wwywujg4nna5fb7ldli/requirements" } } } ``` 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. --- ## Related topics **[Sub-entity status](https://www.checkout.com/docs/platforms/for-saas/manage-sub-entities/sub-entity-status.md)** Learn about the different sub-entity statuses, including requirements due. **[Update a sub-entity](https://www.checkout.com/docs/platforms/for-saas/manage-sub-entities/update-a-sub-entity.md)** Learn how a sub-entity can be updated on your platform.