Notabene

Notabene is a Travel Rule provider. It is a premium add-on that Fireblocks Support enables on Developer Sandbox, Testnet, and Mainnet workspaces. You connect it and build its policy in the Console, and send Travel Rule data through the Fireblocks API. Fireblocks does not store Travel Rule data permanently and does not hold the decryption keys.

What you can do through the API

Step	Task	Console	API
1	Get your VASP details	No	Get VASP details
1	Register your PII encryption key	No	`PUT /screening/travel_rule/vasp/update`
1	Assign or remove a VASP DID for a vault account	No	Assign VASP to vault
1	Get the VASP DID assigned to a vault account	No	Get assigned VASP to vault
1	Connect Notabene	Yes	No
2	Build the Trigger (Screening Policy) and Outcome (Post-Screening Policy)	Yes	No
3	Set up the Fireblocks SDK in your system	No	No API call; install the TypeScript SDK
4	Validate a transaction’s Travel Rule data	No	`POST /screening/travel_rule/transaction/validate/full`
4	Search the Notabene VASP directory	No	`GET /screening/travel_rule/vasp`
4	Attach the Travel Rule message to a transaction	No	`travelRuleMessage` in `POST /transactions`

To read a transaction’s Notabene result, use the tr field; see Transaction Screening Operations.

Step 1: Connect Notabene

You need a Notabene account. By default, your Notabene production environment connects to your Fireblocks production workspace, and your Notabene sandbox to your Fireblocks sandbox workspace; for any other pairing, contact Fireblocks Support.

Get your VASP DID, your Decentralized Identifier in the Notabene network, with Get VASP details.
Create an Ed25519 DID key with the Notabene CLI. Other VASPs use its public key to encrypt PII sent to you. See Notabene’s Fireblocks integration docs.
Register the key on your VASP details.
Assign your VASP DID to every receiving vault account. Incoming transactions to a vault account without an assigned DID cannot be screened.
In the Console, connect Notabene with your Notabene API key, secret, and VASP DID. You receive an email once the connection is approved.
In your Notabene dashboard, set the Notabene status a transaction must reach before Fireblocks treats screening as complete.

To switch to new API keys, submit a ticket to Fireblocks Support with the new API key, secret, and VASP DID.

Step 2: Build the policy

Build the Trigger and Outcome in the Console; default rules apply until you create your own. See Notabene on the Help Center. Notabene supports every Outcome action: Accept, Reject, Alert, Freeze, Wait, and Cancel. Outcome rules act on Notabene’s status:

Status	Meaning
Completed	Screening finished successfully.
Pending	Still in progress. Accept the transaction as it is, or wait up to four hours for a result before it is canceled automatically.
Rejected	The beneficiary VASP was not recognized, or declined the request.
Failed	Screening could not complete, for example because of incomplete Travel Rule data or a Notabene error.
Blocking time expired	The time configured for holding the transaction ran out.
Canceled	Screening was canceled. For outgoing transactions, you can choose whether to proceed anyway.

Step 3: Set up the Fireblocks SDK

Install the Fireblocks SDK in your system; Travel Rule data is validated and attached from your code. See TypeScript SDK.

Step 4: Send an outgoing transaction

An outgoing transaction without a travelRuleMessage bypasses Travel Rule screening.

Validate the Travel Rule data with the full validation endpoint, passing the transaction details and the originator and beneficiary data you have. Set the notation query parameter explicitly: it defaults to notabene, and the default will change to fireblocks, which translates asset tickers and amounts automatically. The basic Validate Travel Rule Transaction endpoint is being deprecated.

{
  "transactionAsset": "ETH",
  "transactionAmount": "10000000000000000000",
  "originatorVASPdid": "did:ethr:0x44957e75d6ce4a5bf37aae117da86422c848f7c2",
  "beneficiaryVASPdid": "did:ethr:0x47463999eb42dc2aaacb29624c512603221227a1",
  "transactionBlockchainInfo": { "destination": "0xDB6A31EC49D5FB35EF6BA6CE0A3B071C8BA7F7F0" },
  "originator": {},
  "beneficiary": {}
}

Response field	Values
`isValid`	`true` when all required data is present.
`type`	`BELOW_THRESHOLD`, `TRAVELRULE`, or `NON_CUSTODIAL`. If `BELOW_THRESHOLD`, you do not need Travel Rule data.
`beneficiaryAddressType`	`HOSTED`, `UNHOSTED`, or `UNKNOWN`.
`addressSource`	How the beneficiary address was identified, for example `ADDRESS_GRAPH`. `UNKNOWN` if it was not.
`beneficiaryVASPdid`, `beneficiaryVASPname`	The identified beneficiary VASP.
`warnings`	Beneficiary data that is missing and needs to be collected.

Identify the beneficiary VASP if it was not found automatically: search the VASP directory, for example ?search=Fireblocks, and pass its DID as beneficiaryVASPdid.
Collect the missing data listed in warnings, with Notabene’s widget or API, and validate again until isValid is true. See Notabene’s validation documentation.
Encrypt the PII with the Notabene PII SDK: end-to-end, which only the counterparty VASP can decrypt, or hybrid, which Notabene can decrypt as well.
Create the transaction with the encrypted message as travelRuleMessage:

const { data } = await fireblocks.transactions.createTransaction({
  transactionRequest: {
    assetId: "ETH",
    amount: "10",
    source: { type: "VAULT_ACCOUNT", id: "0" },
    destination: {
      type: "ONE_TIME_ADDRESS",
      oneTimeAddress: { address: "0xDB6A31EC49D5FB35EF6BA6CE0A3B071C8BA7F7F0" },
    },
    travelRuleMessage: {
      originatorVASPdid: "did:ethr:0x44957e75d6ce4a5bf37aae117da86422c848f7c2",
      beneficiaryVASPdid: "did:ethr:0x47463999eb42dc2aaacb29624c512603221227a1",
      originator: encryptedOriginator,   // from the Notabene PII SDK
      beneficiary: encryptedBeneficiary, // from the Notabene PII SDK
    },
  },
});

Incoming transactions

Fireblocks sends Notabene the destination address, the amount, and the VASP DID assigned to the receiving vault account. If no Travel Rule message is attached, Fireblocks creates a blank one so the transaction can still be screened. There is nothing for you to create or resolve: unlike Sumsub and GTR, Notabene does not use Travel Rule messages that you manage through the API.

Multiple legal entities

To map each vault account to the right legal entity, connect your entities as a Gateway VASP with subsidiary VASPs:

Create the entities in Notabene.
Ask Notabene to establish the Gateway and subsidiary relationship.
Generate a shared encryption key.
Assign each vault account to its VASP.

Each vault account maps to exactly one VASP; a VASP can cover many vault accounts.

Testing

Use Notabene’s test VASPs (RoboVASPs), test environment, and Postman collection. See Testing transactions and the Fireblocks–Notabene Postman collection. Some Notabene documentation is password-protected; for access, contact your Customer Success Manager.

Limitations

Unscreened routes: vault-to-vault, vault-to-exchange, vault-to-Gas Station, Gas Station-to-vault, and non-custodial wallet to non-custodial wallet within the same workspace.
Cannot run alongside Sumsub or GTR on the same workspace.
Assets: Fireblocks supports a subset of the assets Notabene supports (most CoinGecko-listed assets). On Testnet: BTC_TEST, ETH_TEST5, XRP_TEST. To request more, contact Fireblocks Support.
Incoming transfers from Fireblocks P2P Network connections default to an “Unsupported Asset” status.
Disconnecting Notabene does not remove addresses already registered in Notabene’s address book.

On the Help Center

To connect Notabene or build Travel Rule rules in the Console, see Notabene.

Get Started

Transactions

API Co-Signers

Webhooks

Workspace & Security

Identity & Compliance

Manage Wallets

Smart Contracts & Tokenization

Treasury & Trading

Gas Management

Payments

Embedded Wallets

Offchain Signing

Direct Custody Wallets

Integrations

Assets & NFTs

Canton

Key Link

What you can do through the API

Step 1: Connect Notabene

Step 2: Build the policy

Step 3: Set up the Fireblocks SDK

Step 4: Send an outgoing transaction

Incoming transactions

Multiple legal entities

Testing

Limitations

On the Help Center

​What you can do through the API

​Step 1: Connect Notabene

​Step 2: Build the policy

​Step 3: Set up the Fireblocks SDK

​Step 4: Send an outgoing transaction

​Incoming transactions

​Multiple legal entities

​Testing

​Limitations

​On the Help Center

What you can do through the API

Step 1: Connect Notabene

Step 2: Build the policy

Step 3: Set up the Fireblocks SDK

Step 4: Send an outgoing transaction

Incoming transactions

Multiple legal entities

Testing

Limitations

On the Help Center