---
title: "Get a list of requirements"
method: GET
path: "/accounts/entities/{id}/requirements"
tags: ["Onboarding", "Platforms"]
---

# Get a list of requirements

`GET /accounts/entities/{id}/requirements`

## Request

- Base URL: `https://{prefix}.api.sandbox.checkout.com`
- URL: `https://{prefix}.api.sandbox.checkout.com/accounts/entities/{id}/requirements`
- Auth: one of:
  - OAuth 2
    - Client credentials
    - Token URL: `string` scopes: `accounts`
  - API key in header `Authorization`
- TypeScript: <https://skmtc.dev/checkout/apis/checkout-com-api-reference/docs/accounts/entities/:id/requirements/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieve the list of pending requirements that the sub-entity must resolve. Requirements may be raised as part of onboarding, periodic AML reviews, or ongoing compliance checks. Each item in the response includes a `priority` and `deadline` to help you surface the most urgent items first.

## Response `200`

Requirements retrieved successfully

- EntityRequirementListResponse: The list of pending requirements for a sub-entity.
  - `data` EntityRequirementListItem[]: The list of pending requirements for the sub-entity. Empty when no requirements are outstanding.
    - `id` string: The unique identifier of the requirement.
    - `resource` string: The ID of the resource (sub-entity or representative) the requirement applies to.
    - `resource_type` string: The type of resource the requirement applies to derived from the resource's URN. Common values include `company`, `individual`, and `representative`. Defaults to `entity` if the URN cannot be parsed.
    - `reason` 'periodic_review' | 'attestation': The reason the requirement was raised.
    - `priority` 'high' | 'critical': Priority level of this requirement. "high" by default, "critical" if deadline is within 7 days.
    - `deadline` string, date-time: The date and time, in ISO 8601 UTC format, by which the requirement must be resolved.
    - `urn` string: The schema-registry URN identifying the field this requirement applies to. Format: `urn:object:{resource_type}#{resource_id}#field:{field_name}`.
    - `field_path` string, nullable: Dot-notation path of the field on the resource that needs to be supplied or updated. May be `null` for ad-hoc requirements (such as additional documents or free-text responses) that do not map to a specific field on the entity.
    - `field_urn` string, nullable: The schema-registry URN of the field, from the public mapping definition. May be `null` if no mapping exists.
    - `metadata` object, nullable: Optional metadata from the property mapping definition. Shape varies by requirement.
    - `_links` object: Links to related resources.

## Other responses

- `401`: Unauthorized
- `404`: Sub-entity not found

---

[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)