Get a list of requirements

​

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.

Path Parameters
  • id
    Type: string
    required

    The sub-entity's ID.

Headers
  • Accept
    Type: string
    required

    Used to describe the type of content the client can interpret. Use the schema_version value to specify the payload format. The latest version is 3.0.

Responses
  • application/json
  • 401

    Unauthorized

  • 404

    Sub-entity not found

Request Example for get/accounts/entities/{id}/requirements
Shell Curl
curl 'https://{prefix}.api.sandbox.checkout.com/accounts/entities/ent_w4jelhppmfiufdnatam37wrfc4/requirements' \
  --header 'Accept: application/json;schema_version=3.0' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

{
  "data": [
    {
      "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"
        }
      }
    }
  ]
}

Requirements retrieved successfully