compliance.freeze.provisional
A subject's holding of an asset was frozen in an included block; the freeze may be retracted until the chain finality watermark reaches it.
Delivery contract
| Field | Value |
|---|---|
| Event type | compliance.freeze.provisional |
| Version | 1 |
| Lifecycle state | provisional |
| Counter-signed receipts | No event-specific advice |
| SDK type | Webhook.ComplianceFreezeProvisionalV1 |
The receipt recommendation does not change delivery behavior. DALP waits for a counter-signed receipt only if the webhook endpoint's counterSignedReceipts value is true when DALP queues the delivery. When the value is false, a normal 2xx response completes the delivery.
Related references:
idxr_token
Payload schema
The schema and examples describe the full payload. Thin delivery omits personal data fields. Use the payload-shape guidance to choose the endpoint configuration.
{
"type": "object",
"properties": {
"chainId": {
"type": "integer",
"exclusiveMinimum": 0
},
"transactionHash": {
"type": "string",
"pattern": "^0x[a-fA-F0-9]{64}$"
},
"blockNumber": {
"type": "integer",
"minimum": 0
},
"logIndex": {
"type": "integer",
"minimum": 0
},
"tokenAddress": {
"type": "string",
"minLength": 42,
"maxLength": 42,
"pattern": "^0x[a-fA-F0-9]{40}$",
"description": "A valid Ethereum address (42 characters, starting with 0x)",
"examples": ["0x71C7656EC7ab88b098defB751B7401B5f6d8976F"]
},
"subjectAddress": {
"type": "string",
"minLength": 42,
"maxLength": 42,
"pattern": "^0x[a-fA-F0-9]{40}$",
"description": "A valid Ethereum address (42 characters, starting with 0x)",
"examples": ["0x71C7656EC7ab88b098defB751B7401B5f6d8976F"]
},
"scope": {
"type": "string",
"enum": ["address", "amount"]
},
"amount": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"operator": {
"anyOf": [
{
"type": "string",
"minLength": 42,
"maxLength": 42,
"pattern": "^0x[a-fA-F0-9]{40}$",
"description": "A valid Ethereum address (42 characters, starting with 0x)",
"examples": ["0x71C7656EC7ab88b098defB751B7401B5f6d8976F"]
},
{
"type": "null"
}
]
}
},
"required": [
"chainId",
"transactionHash",
"blockNumber",
"logIndex",
"tokenAddress",
"subjectAddress",
"scope",
"amount",
"operator"
],
"additionalProperties": true
}TypeScript SDK example
Use the request's raw body and headers with your endpoint's webhook secret. This handler illustrates verification and event selection. Before writing downstream state, deduplicate deliveries by evt_id and recognize replayed outcomes by their domain identifiers.
const result = await verifyWebhook({
rawBody,
headers,
secret: process.env.DALP_WEBHOOK_SECRET!,
});
if (!result.ok) {
throw new Error(`Webhook verification failed: ${result.code}`);
}
if (result.event.type === "compliance.freeze.provisional") {
const event: Webhook.Event<"compliance.freeze.provisional"> = result.event;
console.log(event.payload);
}HTTP delivery example
This illustrative request shows the delivery shape. Its timestamp and signature are placeholders; a verifier rejects them. Use a signed platform delivery to verify your endpoint.
curl -X POST https://consumer.example.com/dalp/webhooks \
-H "content-type: application/json" \
-H "webhook-id: evt_3d0de239bb829ac0c239b0ac027955a6" \
-H "webhook-timestamp: 1778112000" \
-H "webhook-signature: v1,docs-example-signature" \
--data '{"evt_id":"evt_3d0de239bb829ac0c239b0ac027955a6","source_id":"example:compliance.freeze.provisional@1:0","lifecycle_state":"provisional","payload":{"tokenAddress":"0x3333333333333333333333333333333333333333","chainId":537001,"subjectAddress":"0x4444444444444444444444444444444444444444","scope":"amount","amount":"500000000000000000000","operator":"0x2222222222222222222222222222222222222222","transactionHash":"0xdddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddd","blockNumber":18445280,"logIndex":1},"related":{"idxr_token":"idxr_token_example"},"type":"compliance.freeze.provisional","version":1,"request":{"idempotency_key":"idem_01JZP7R5W8M9N0P1Q2R3S4T5"}}'Version and manifest
This page documents version 1 of compliance.freeze.provisional. This event type is not deprecated. The DALP events manifest contains the machine-readable AsyncAPI entry.
compliance.freeze.final
A subject's holding of an asset was frozen, sent once the chain finality watermark reaches the source block. `address` scope blocks every movement of the subject's balance; `amount` scope holds `amount` token units.
compliance.freeze.retracted
A provisional compliance freeze was retracted because a reorg invalidated the source log.