Validate Full Travel Rule Transaction

post

https://api.fireblocks.io/v1/screening/travel_rule/transaction/validate/full

Validate Full Travel Rule transactions.

Checks for all required information on the originator and beneficiary VASPs.

Query Params

notation

array of strings

Specifies the notation of the transaction. Possible values are: - notabene: Uses Notabene notation (default behavior). - fireblocks: Uses Fireblocks notation, with automatic translation of asset tickers and amounts. - <none>: Defaults to notabene for backward compatibility. Note: The default value for the notation parameter will change from notabene to fireblocks Update your integrations accordingly.

notation

Body Params

originatorVASPdid

string

The Decentralized Identifier (DID) of the exchange (VASP) that is sending the virtual assets. This identifier is unique to the exchange and is generated when the exchange's account is created in the Notabene network.

beneficiaryVASPdid

string

The Decentralized Identifier (DID) of the exchange (VASP) that is receiving the virtual assets. This identifier is unique to the exchange and is generated when the exchange's account is created in the Notabene network.

transactionAsset

string

Transaction asset symbol (e.g., BTC, ETH, USDC). By using the notation query string, users can select the type of asset notation: - fireblocks: Converts asset symbols to Fireblocks notation. - notabene: Retains the original Notabene asset symbol format.

transactionAmount

string

Transaction amount in the transaction asset. For example, if the asset is BTC, the amount is the value in BTC units. By using the notation query string, users can select the type of amount notation: - fireblocks: Converts the amount to Fireblocks notation (e.g., adjusted for decimals). - notabene: Retains the original Notabene amount format.

originatorVASPname

string

The name of the VASP acting as the transaction originator.

beneficiaryVASPname

string

The name of the VASP acting as the transaction beneficiary.

transactionBlockchainInfo

object

Information about the blockchain transaction.

originator

object

required

Information about the originator of the transaction.

beneficiary

object

required

Information about the originator of the transaction.

encrypted

string

Encrypted data related to the transaction.

protocol

string

enum

The protocol used to perform the travel rule.

Allowed:

skipBeneficiaryDataValidation

boolean

Whether to skip validation of beneficiary data.

travelRuleBehavior

boolean

Whether to check if the transaction complies with the travel rule in the beneficiary VASP's jurisdiction.

originatorRef

string

A reference ID related to the originator of the transaction.

beneficiaryRef

string

A reference ID related to the beneficiary of the transaction.

travelRuleBehaviorRef

string

A reference ID related to the travel rule behavior.

originatorProof

object

Ownership proof related to the originator of the transaction.

beneficiaryProof

object

Ownership proof related to the originator of the transaction.

beneficiaryDid

string

The Decentralized Identifier (DID) of the person at the receiving exchange (VASP). This identifier is generated when the customer is registered in the Notabene network, or automatically created based on the beneficiaryRef. - If neither beneficiaryRef nor beneficiaryDid is provided in the txCreate payload, a new random DID is generated for every transaction.

originatorDid

string

The Decentralized Identifier (DID) of the person at the exchange (VASP) who is requesting the withdrawal. This identifier is generated when the customer is registered in the Notabene network or automatically created based on the originatorRef. - If neither originatorRef nor originatorDid is provided in the txCreate payload, a new random DID is generated for every transaction.

isNonCustodial

boolean

Indicates if the transaction involves a non-custodial wallet.

notificationEmail

string

The email address where a notification should be sent upon completion of the travel rule

pii

object

Personal identifiable information related to the transaction

pii_url

string

The URL of the personal identifiable information related to the transaction

Headers

Idempotency-Key

string

A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.

Responses

200Transaction validated successfully

defaultError Response