---
title: "Get requirement details"
method: GET
path: "/accounts/entities/{id}/requirements/{requirementId}"
tags: ["Onboarding", "Platforms"]
---

# Get requirement details

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

## Request

- Base URL: `https://{prefix}.api.sandbox.checkout.com`
- URL: `https://{prefix}.api.sandbox.checkout.com/accounts/entities/{id}/requirements/{requirementId}`
- 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/:requirementId/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieve detailed information for a single requirement, including the JSON Schema that defines the shape of the value expected when resolving it.

Once a response has been submitted for a requirement (see `PUT /accounts/entities/{id}/requirements/{requirementId}`), that requirement is no longer retrievable via this endpoint until it is re-issued or cleared.

## Response `200`

Requirement details retrieved successfully

- EntityRequirementDetails: Detailed information about a single requirement.
  - `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.
  - `message` string: A user-facing explanation of what is needed to resolve the requirement.
  - `_schema` object, nullable: JSON Schema that the value supplied to `PUT /accounts/entities/{id}/requirements/{requirementId}` must conform to. The shape varies by requirement type (for example: an identity document upload, a free-text response, or a structured object). Validate the value client-side against this schema before submitting. May be `null` if no schema is registered for the requirement's field.

## Other responses

- `401`: Unauthorized
- `404`: Requirement not found, or a response has already been submitted for it.

---

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