Action required
Last updated: November 18, 2026
This event occurs when Checkout.com raises a new requirement on a sub-entity, and you or your sub-entity need to provide information or take action.
We send one webhook for each new requirement. To resolve it, use _links.requirement.href to get the requirement details, then submit a response.
Information
We send Action required webhooks for requirements raised during onboarding or after an account change request. We do not send them for requirements raised during a periodic review.
1{2"id": "evt_5ayz3p4kq6gelgvzdpw7mpwcxe",3"type": "action_required",4"version": "1.0.0",5"created_on": "2026-10-28T10:15:01.4825173Z",6"data": {7"sub_entity_id": "ent_wxglze3wwywujg4nna5fb7ldli",8"reference": "SUB_ENTITY_01234",9"legal_name": "The Online Retailer",10"requirement": {11"id": "req_lg7k2n9xba4htpqz3we6cmj5vu"12}13},14"_links": {15"self": {16"href": "https://{prefix}.api.checkout.com/workflows/events/evt_5ayz3p4kq6gelgvzdpw7mpwcxe"17},18"requirement": {19"href": "https://{prefix}.api.checkout.com/accounts/entities/ent_wxglze3wwywujg4nna5fb7ldli/requirements/req_lg7k2n9xba4htpqz3we6cmj5vu"20}21}22}
| Field name | Description |
|---|---|
string | The event's unique identifier, prefixed with |
string | The event type. This value is always |
string | The webhook's version. |
date-time | The date and time when the event occurred, in UTC. |
object | The webhook message. |
string | The unique identifier of the sub-entity, prefixed with |
string | The unique reference you assigned to the sub-entity. |
string | The sub-entity's legal name. |
string | The unique identifier of the requirement, prefixed with |
string | The URL to the event. |
string | The URL to the requirement. Use it to get the requirement details. |