Sign in

v5

latestOpenAPI 3.1.02026-07-262421791.5 MB
webhook-event
recipient

Recipient state change

Triggered when a recipient account created or changed through hosted recipient creation changes state. See the Embedded Flows guide for an example recipient creation flow.

Events may not be delivered in the order they occurred. Use data.resource.occurred_at to reconcile the order. See the Event Ordering guide for details.

  • Event type: recipients#state-change
  • Profile level subscriptions: Supported
  • Application level subscriptions: Supported
postWebhookrecipients#state-change

Headers

X-Signature-SHA256string

RSA-SHA256 signature of the request body, Base64 encoded. Verify this against the Wise public key to ensure the request is authentic and has not been tampered with.

X-Delivery-Idstring uuid

Unique identifier for this webhook delivery attempt.

X-Test-Notificationboolean

Present with the value true if this is a test notification sent to verify your callback URL during subscription setup.

Payload

schema_version'4.0.0' required

Version of the event schema. Determined by the schema_version on your webhook subscription.

subscription_idstring uuid required

ID of the webhook subscription that triggered this event.

event_type'recipients#state-change' required

Event type identifier.

sent_atstring date-time required

Timestamp when the event was sent.

Example payload

{
  "schema_version": "4.0.0",
  "subscription_id": "ced03af9-be76-46ac-ada8-7fe935792290",
  "event_type": "recipients#state-change",
  "sent_at": "2026-06-15T13:18:20.265Z",
  "data": {
    "resource": {
      "id": "700525176",
      "occurred_at": "2026-06-15T13:18:20.265Z",
      "data": {
        "recipientId": 700525176,
        "profileId": 14966143,
        "currency": "EUR",
        "state": "CREATE",
        "clientId": "hosted-kyc-test-client"
      }
    }
  }
}

Response

Return any 2xx status to acknowledge receipt of the event.

statusstring

Example response

{
  "status": "ok"
}