Trusset Protocol - Infrastructure for Asset Tokenization

POST

lending-external-securities

api

hooks

{marketId}

curl -X POST "https://api.trusset.org/lending-external-securities/api/hooks/{marketId}" \
  -H "X-API-Key: trusset_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "hookType": "monitorRisk",
    "name": "NAV Publication Monitor",
    "riskUri": "https://nav.example.com/funds/NYF1",
    "riskFields": [{ "path": "ageHours", "operator": "<", "threshold": 36 }],
    "checkFrequency": "6h"
  }'

const res = await fetch(
  `https://api.trusset.org/lending-external-securities/api/hooks/${marketId}`,
  {
    method: 'POST',
    headers: {
      'X-API-Key': 'trusset_your_key_here',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      hookType: 'afterLiquidation',
      name: 'Desk notification',
      actionType: 'inform',
      webhookUrl: 'https://ops.example.com/hooks/liquidation'
    })
  }
);
const { data } = await res.json();

{
  "success": true,
  "data": {
    "id": "hook_003",
    "marketId": "clx_secmarket_001",
    "hookType": "monitorRisk",
    "name": "NAV Publication Monitor",
    "riskUri": "https://nav.example.com/funds/NYF1",
    "riskFields": [{ "path": "ageHours", "operator": "<", "threshold": 36 }],
    "checkFrequency": "6h",
    "parameterChecks": [],
    "triggerHookIds": [],
    "actionType": null,
    "signerAddress": "0x123...456",
    "active": true,
    "executionCount": 0,
    "createdAt": "2025-06-15T12:00:00.000Z"
  }
}

{
  "success": false,
  "error": {
    "code": "MISSING_RISK_FIELDS",
    "message": "At least one risk field is required for monitor hooks"
  }
}

{
  "success": false,
  "error": {
    "code": "INVALID_TRIGGER_HOOKS",
    "message": "One or more trigger hook IDs are invalid"
  }
}

Creates a hook on an external securities lending market. Hooks let you attach off-platform risk data and automated reactions to a market without running your own poller. Three hook types are available:

`hookType`	Runs when	Purpose
`monitorRisk`	On the `checkFrequency` schedule	Polls `riskUri` and evaluates `riskFields` against the response
`beforeLiquidation`	Immediately before a liquidation is attempted	Evaluates `parameterChecks` against live loan state
`afterLiquidation`	Immediately after a liquidation completes	Runs the `actionType`, either `buy` or `inform`

riskUri and webhookUrl must be publicly resolvable http or https URLs. Loopback addresses, private ranges, link-local addresses, and .local or .internal hostnames are rejected at validation time and on every outbound call.

Path Parameters

string

required

Market ID.

Body Parameters

string

required

One of monitorRisk, beforeLiquidation, or afterLiquidation.

string

Display name, 1 to 128 characters. Defaults to Risk Monitor, Pre-Liquidation Check, or Post-Liquidation Action based on the hook type.

string

URL polled on each run. Required for monitorRisk. Max 2048 characters.

array

Field checks applied to the riskUri JSON response. Max 20 entries. Required for monitorRisk on create.

Show child attributes

string

required

Dot-notation path into the response body, 1 to 256 characters.

string

One of >, >=, <, <=, ==, !=.

number

Value compared against the resolved field.

number

Optional global threshold stored alongside the hook.

string

Polling interval for monitorRisk. One of 1m, 5m, 15m, 30m, 1h, 6h, 12h, 24h. A hook without a checkFrequency is never scheduled and only runs when triggered manually.

array

On-chain loan checks for beforeLiquidation. Max 10 entries.

Show child attributes

string

required

One of healthFactor, collateralValue, debtValue, collateralRatio, interestAccrued.

string

required

One of >, >=, <, <=, ==, !=.

string

required

Comparison value, max 64 characters.

string

Required for afterLiquidation. buy places a bid on the resulting Dutch auction through the registered wallet. inform posts to webhookUrl.

string

Price ceiling per collateral unit for buy actions, in the market’s borrow asset. The hook skips the bid when the live auction price is above this value.

string

Destination for inform actions. Required when actionType is inform. Max 2048 characters.

object

Additional fields merged into the outbound webhook body.

array

Hook IDs whose failure chains into this hook. Max 10. Every ID must belong to the same market.

curl -X POST "https://api.trusset.org/lending-external-securities/api/hooks/{marketId}" \
  -H "X-API-Key: trusset_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "hookType": "monitorRisk",
    "name": "NAV Publication Monitor",
    "riskUri": "https://nav.example.com/funds/NYF1",
    "riskFields": [{ "path": "ageHours", "operator": "<", "threshold": 36 }],
    "checkFrequency": "6h"
  }'

const res = await fetch(
  `https://api.trusset.org/lending-external-securities/api/hooks/${marketId}`,
  {
    method: 'POST',
    headers: {
      'X-API-Key': 'trusset_your_key_here',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      hookType: 'afterLiquidation',
      name: 'Desk notification',
      actionType: 'inform',
      webhookUrl: 'https://ops.example.com/hooks/liquidation'
    })
  }
);
const { data } = await res.json();

{
  "success": true,
  "data": {
    "id": "hook_003",
    "marketId": "clx_secmarket_001",
    "hookType": "monitorRisk",
    "name": "NAV Publication Monitor",
    "riskUri": "https://nav.example.com/funds/NYF1",
    "riskFields": [{ "path": "ageHours", "operator": "<", "threshold": 36 }],
    "checkFrequency": "6h",
    "parameterChecks": [],
    "triggerHookIds": [],
    "actionType": null,
    "signerAddress": "0x123...456",
    "active": true,
    "executionCount": 0,
    "createdAt": "2025-06-15T12:00:00.000Z"
  }
}

{
  "success": false,
  "error": {
    "code": "MISSING_RISK_FIELDS",
    "message": "At least one risk field is required for monitor hooks"
  }
}

{
  "success": false,
  "error": {
    "code": "INVALID_TRIGGER_HOOKS",
    "message": "One or more trigger hook IDs are invalid"
  }
}

Validation Errors

Code	Cause
`MISSING_RISK_URI`	`hookType` is `monitorRisk` and `riskUri` is absent
`MISSING_RISK_FIELDS`	`hookType` is `monitorRisk` and `riskFields` is empty
`MISSING_ACTION_TYPE`	`hookType` is `afterLiquidation` and `actionType` is absent
`MISSING_WEBHOOK_URL`	`actionType` is `inform` and `webhookUrl` is absent
`INVALID_TRIGGER_HOOKS`	One or more `triggerHookIds` do not exist on this market
`VALIDATION_ERROR`	Schema violation. `error.details` lists the offending fields

Get Hook

Update Hook

curl -X POST "https://api.trusset.org/lending-external-securities/api/hooks/{marketId}" \
  -H "X-API-Key: trusset_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "hookType": "monitorRisk",
    "name": "NAV Publication Monitor",
    "riskUri": "https://nav.example.com/funds/NYF1",
    "riskFields": [{ "path": "ageHours", "operator": "<", "threshold": 36 }],
    "checkFrequency": "6h"
  }'

const res = await fetch(
  `https://api.trusset.org/lending-external-securities/api/hooks/${marketId}`,
  {
    method: 'POST',
    headers: {
      'X-API-Key': 'trusset_your_key_here',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      hookType: 'afterLiquidation',
      name: 'Desk notification',
      actionType: 'inform',
      webhookUrl: 'https://ops.example.com/hooks/liquidation'
    })
  }
);
const { data } = await res.json();

{
  "success": true,
  "data": {
    "id": "hook_003",
    "marketId": "clx_secmarket_001",
    "hookType": "monitorRisk",
    "name": "NAV Publication Monitor",
    "riskUri": "https://nav.example.com/funds/NYF1",
    "riskFields": [{ "path": "ageHours", "operator": "<", "threshold": 36 }],
    "checkFrequency": "6h",
    "parameterChecks": [],
    "triggerHookIds": [],
    "actionType": null,
    "signerAddress": "0x123...456",
    "active": true,
    "executionCount": 0,
    "createdAt": "2025-06-15T12:00:00.000Z"
  }
}

{
  "success": false,
  "error": {
    "code": "MISSING_RISK_FIELDS",
    "message": "At least one risk field is required for monitor hooks"
  }
}

{
  "success": false,
  "error": {
    "code": "INVALID_TRIGGER_HOOKS",
    "message": "One or more trigger hook IDs are invalid"
  }
}

Overview

MiCA Register

Customers

Stock Tokenization

Trading

Stock Lending

External Securities Lending

Create Hook

Path Parameters

Body Parameters

Validation Errors

​Path Parameters

​Body Parameters

​Validation Errors

Path Parameters

Body Parameters

Validation Errors