CHcheckout
Onboarding
Platforms

Get requirement details

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.

get/accounts/entities/{id}/requirements/{requirementId}

Request

Response

Requirement details retrieved successfully

idstring

The unique identifier of the requirement.

resourcestring

The ID of the resource (sub-entity or representative) the requirement applies to.

resource_typestring

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.

deadlinestring date-time

The date and time, in ISO 8601 UTC format, by which the requirement must be resolved.

urnstring

The schema-registry URN identifying the field this requirement applies to. Format: urn:object:{resource_type}#{resource_id}#field:{field_name}.

field_pathstring 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_urnstring nullable

The schema-registry URN of the field, from the public mapping definition. May be null if no mapping exists.

metadataobject nullable

Optional metadata from the property mapping definition. Shape varies by requirement.

_linksobject

Links to related resources.

messagestring

A user-facing explanation of what is needed to resolve the requirement.

_schemaobject 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.

Example response

{
  "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"
    }
  },
  "message": "Please confirm your legal company name."
}

Changes

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