CHcheckout
Onboarding
Platforms

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.

get/accounts/entities/{id}/requirements

Request

Response

Requirements retrieved successfully

Example response

{
  "data": [
    {
      "id": "req_5wmacwhrhbzhqkhx5hlqmzje44",
      "resource": "ent_wxglze3wwywujg4nna5fb7ldli",
      "resource_type": "company",
      "reason": "periodic_review",
      "priority": "high",
      "deadline": "2026-06-01T00:00:00.0000000+00:00",
      "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"
        }
      }
    }
  ]
}

Changes

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