CHcheckout
Onboarding
Platforms

Resolve a requirement

Submit a response to resolve a requirement. The shape of value is defined by the requirement's _schema, returned from GET /accounts/entities/{id}/requirements/{requirementId}.

The response is accepted for processing and applied asynchronously. While processing, the requirement is no longer retrievable via the GET endpoints; if validation fails downstream the requirement may reappear.

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

Request

Request body

Response

Response accepted for processing

idstring

The unique identifier of the requirement.

status'processing'

Processing status of the submitted response. While the response is processing, the requirement is no longer retrievable via the GET endpoints; if validation fails downstream the requirement may reappear.

submitted_atstring date-time

The date and time, in ISO 8601 UTC format, the response was accepted.

_linksobject

Example response

{
  "id": "req_5wmacwhrhbzhqkhx5hlqmzje44",
  "status": "processing",
  "submitted_at": "2026-05-05T10:15:30.0000000+00:00",
  "_links": {
    "self": {
      "href": "https://{prefix}.api.checkout.com/accounts/entities/ent_wxglze3wwywujg4nna5fb7ldli/requirements/req_5wmacwhrhbzhqkhx5hlqmzje44"
    },
    "collection": {
      "href": "https://{prefix}.api.checkout.com/accounts/entities/ent_wxglze3wwywujg4nna5fb7ldli/requirements"
    }
  }
}

Changes

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