Skip to main content
This webhook is sent when an account restriction has been successfully created.

​
Webhook Structure

​
id
string (UUID)
required
Unique identifier for this event
​
time
string (ISO 8601)
required
Timestamp of when the event occurred
​
correlationId
string
Identifier to correlate the request with the response. Present when provided in the original request.
​
type
string
required
The type of event. Value: account.restriction-created
​
data
object
required
The event data containing the details below

​
Data Fields

​
data.accountId
string (UUID)
required
Unique identifier of the restricted account
​
data.restrictionId
string (UUID)
required
Unique identifier of the created restriction
​
data.status
string
required
Current restriction status. Available values: ACTIVE, LIFTED
​
data.type
string
required
Restriction type. Available values: REJECT_OUTBOUND, REJECT_INBOUND, HOLD_INBOUND
​
data.source
string
required
Restriction source. Available values: CLIENT, PLAIS
​
data.reason
string
Free-text reason for the restriction
​
data.externalRef
string
External reference associated with the restriction
​
data.createdAt
string (ISO 8601)
required
Timestamp of when the restriction was created
​
data.updatedAt
string (ISO 8601)
required
Timestamp of when the restriction was last updated

​
Request Example

Last modified on July 20, 2026