Skip to content

Latest commit

 

History

History
46 lines (34 loc) · 4.51 KB

TravelRuleValidateFullTransactionRequest.md

File metadata and controls

46 lines (34 loc) · 4.51 KB

TravelRuleValidateFullTransactionRequest

Properties

Name Type Description Notes
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. [optional]
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. [optional]
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. [optional]
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. [optional]
originatorVASPname String The name of the VASP acting as the transaction originator. [optional]
beneficiaryVASPname String The name of the VASP acting as the transaction beneficiary. [optional]
transactionBlockchainInfo TravelRuleTransactionBlockchainInfo [optional]
originator TravelRuleValidatePiiIVMS
beneficiary TravelRuleValidatePiiIVMS
encrypted String Encrypted data related to the transaction. [optional]
protocol ProtocolEnum The protocol used to perform the travel rule. [optional]
skipBeneficiaryDataValidation Boolean Whether to skip validation of beneficiary data. [optional]
travelRuleBehavior Boolean Whether to check if the transaction complies with the travel rule in the beneficiary VASP's jurisdiction. [optional]
originatorRef String A reference ID related to the originator of the transaction. [optional]
beneficiaryRef String A reference ID related to the beneficiary of the transaction. [optional]
travelRuleBehaviorRef String A reference ID related to the travel rule behavior. [optional]
originatorProof TravelRuleOwnershipProof [optional]
beneficiaryProof TravelRuleOwnershipProof [optional]
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. [optional]
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. [optional]
isNonCustodial Boolean Indicates if the transaction involves a non-custodial wallet. [optional]
notificationEmail String The email address where a notification should be sent upon completion of the travel rule [optional]
pii TravelRulePiiIVMS [optional]
piiUrl String The URL of the personal identifiable information related to the transaction [optional]

Enum: ProtocolEnum

Name Value
TRLIGHT "TRLight"
TRP "TRP"
OPENVASP "OpenVASP"