FIfireblocks
Travel Rule

Validate Travel Rule Transaction

Validate Travel Rule transactions. Checks what beneficiary VASP details are required by your jurisdiction and the beneficiary's jurisdiction. Deprecation Notice This endpoint will be deprecated soon in favor of the validate full endpoint. Please update your integrations to use the validate full endpoint to ensure compatibility with future releases. Checks what beneficiary VASP details are required by your jurisdiction and the beneficiary's jurisdiction. Learn more about Fireblocks Travel Rule management in the following guide.

Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.

post/screening/travel_rule/transaction/validate

Request

Query parameters

notationstring[]

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.

Headers

Idempotency-Keystring

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.

Request body

transactionAssetstring required

Transaction asset symbol (BTC,ETH)

destinationstring required

Transaction destination address

transactionAmountstring required

Transaction amount in the transaction asset

transactionAssetDecimalsnumber

Number of decimals in the transaction asset. This is used to convert the transaction amount to the smallest unit of the asset

originatorVASPdidstring required

This is the identifier assigned to your VASP

originatorEqualsBeneficiaryboolean required

"True" if the originator and beneficiary is the same person and you therefore do not need to collect any information. "False" if it is a third-party transfer.

travelRuleBehaviorboolean

This will also check if the transaction is a TRAVEL_RULE in the beneficiary VASP's jurisdiction

beneficiaryVASPdidstring

This is the identifier assigned to the VASP the funds are being sent to

beneficiaryVASPnamestring

Beneficiary VASP name

beneficiaryNamestring

Beneficiary name

beneficiaryAccountNumberstring

Beneficiary name

Example request

{
  "transactionAsset": "BTC",
  "destination": "bc1qxy2kgdygjrsqtzq2n0yrf1234p83kkfjhx0wlh",
  "transactionAmount": "10",
  "transactionAssetDecimals": 8,
  "originatorVASPdid": "did:ethr:0x44957e75d6ce4a5bf37aae117da86422c848f7c2",
  "travelRuleBehavior": true,
  "beneficiaryVASPdid": "did:ethr:0x46a7ed5813ce735387df2bfb245bd7722e0de992",
  "beneficiaryVASPname": "HelloCrypto",
  "beneficiaryName": "John Doe",
  "beneficiaryAccountNumber": "1234-1234-1234-12234",
  "beneficiaryAddress": {
    "street": "1234 Example St",
    "city": "New York",
    "state": "NY",
    "postalCode": "10001"
  }
}

Response

Transaction validated successfully

isValidboolean required

"isValid" will tell you if you have collected all the information needed for the travel rule data transfer. Once this field = "true", you can move on to the next step which is to transfer the front-end information to your back-end and perform Travel Rule Transaction create

typestring required

"type" will tell you if the virtual asset value converted to FIAT value of the withdrawal request is above (=TRAVELRULE) or below (=BELOW_THRESHOLD) the threshold in your jurisdiction. If it is to an unhosted wallet which does not require travel rule information to be sent and only collected, it will say NON_CUSTODIAL.

beneficiaryAddressType'UNKNOWN' | 'HOSTED' | 'UNHOSTED' required

"beneficiaryAddressType" will tell you if your blockchain analytics provider or internal address book has been able to identify the wallet address.

addressSource'UNKNOWN' | 'ADDRESS_HASH' | 'ADDRESS_GRAPH' | 'CHAINALYSIS' | 'ELLIPTIC' | 'CRYSTAL' required

"addressSource" will tell you if the address was found in your internal address book or identified by the blockchain analytics provider.

beneficiaryVASPdidstring required

The VASP DID of the beneficiary VASP

beneficiaryVASPnamestring required

"beneficiaryVASPname" will tell you the name of the VASP that has been identified as the owner of the wallet address. This name is used in a subsequent call to get its DID.

warningsstring[] required

"errors/warnings" will tell you what information about the beneficiary you need to collect from the sender.

Example response

{
  "isValid": true,
  "type": "TRAVELRULE",
  "beneficiaryAddressType": "UNKNOWN",
  "addressSource": "UNKNOWN",
  "beneficiaryVASPdid": "did:ethr:0x46a7ed5813ce735387df2bfb245bd7722e0de992",
  "beneficiaryVASPname": "Fireblocks",
  "warnings": [
    "optional-beneficiaryAccountNumber"
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.