FIfireblocks
Travel Rule

Validate Full Travel Rule Transaction

Validate Full Travel Rule transactions.

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

post/screening/travel_rule/transaction/validate/full

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

originatorVASPdidstring

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.

beneficiaryVASPdidstring

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.

transactionAssetstring

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.

transactionAmountstring

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.

originatorVASPnamestring

The name of the VASP acting as the transaction originator.

beneficiaryVASPnamestring

The name of the VASP acting as the transaction beneficiary.

encryptedstring

Encrypted data related to the transaction.

protocol'TRLight' | 'TRP' | 'OpenVASP' | 'GTR'

The protocol used to perform the travel rule.

skipBeneficiaryDataValidationboolean

Whether to skip validation of beneficiary data.

travelRuleBehaviorboolean

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

originatorRefstring

A reference ID related to the originator of the transaction.

beneficiaryRefstring

A reference ID related to the beneficiary of the transaction.

travelRuleBehaviorRefstring

A reference ID related to the travel rule behavior.

beneficiaryDidstring

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.

originatorDidstring

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.

isNonCustodialboolean

Indicates if the transaction involves a non-custodial wallet.

notificationEmailstring

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

pii_urlstring

The URL of the personal identifiable information related to the transaction

Example request

{
  "originatorVASPdid": "did:ethr:0x44957e75d6ce4a5bf37aae117da86422c848f7c2",
  "beneficiaryVASPdid": "did:ethr:0x17fe2dd11a2daa7f6c1fdf22532a4763f963aea6",
  "transactionAsset": "BTC",
  "transactionAmount": "10",
  "originatorVASPname": "Originator VASP Ltd.",
  "beneficiaryVASPname": "Beneficiary VASP Inc.",
  "originator": {
    "originatorPersons": [
      {
        "naturalPerson": {
          "name": [
            {
              "nameIdentifier": [
                {
                  "primaryIdentifier": "John",
                  "secondaryIdentifier": "Doe",
                  "nameIdentifierType": "LEGL"
                }
              ],
              "localNameIdentifier": [
                {
                  "primaryIdentifier": "John",
                  "secondaryIdentifier": "Doe",
                  "nameIdentifierType": "LEGL"
                }
              ],
              "phoneticNameIdentifier": [
                {
                  "primaryIdentifier": "John",
                  "secondaryIdentifier": "Doe",
                  "nameIdentifierType": "LEGL"
                }
              ]
            }
          ],
          "geographicAddress": [
            {
              "streetName": "123 Main St",
              "townName": "New York",
              "country": "US",
              "addressType": "HOME",
              "department": "IT",
              "subDepartment": "Security",
              "buildingName": "Acme Building",
              "townLocationName": "Downtown",
              "districtName": "Manhattan",
              "countrySubDivision": "New York",
              "addressLine": [
                "123 Main St",
                "New York",
                "NY 12345"
              ]
            }
          ],
          "nationalIdentification": {
            "countryOfIssue": "US",
            "nationalIdentifierType": "NATIONAL_ID",
            "registrationAuthority": "RA123456"
          },
          "dateAndPlaceOfBirth": {
            "dateOfBirth": "1990-01-01",
            "placeOfBirth": "New York, USA"
          },
          "customerIdentification": "CUST123456",
          "countryOfResidence": "US"
        },
        "legalPerson": {
          "name": {
            "nameIdentifier": [
              {
                "legalPersonName": "Acme Corporation",
                "legalPersonNameIdentifierType": "LEGL"
              }
            ],
            "localNameIdentifier": [
              {
                "legalPersonName": "アクメ株式会社",
                "legalPersonNameIdentifierType": "LEGL"
              }
            ],
            "phoneticNameIdentifier": [
              {
                "legalPersonName": "Akume Kabushiki Gaisha",
                "legalPersonNameIdentifierType": "LEGL"
              }
            ]
          },
          "geographicAddress": [
            {
              "streetName": "123 Main St",
              "townName": "New York",
              "country": "US",
              "addressType": "HOME",
              "department": "IT",
              "subDepartment": "Security",
              "buildingName": "Acme Building",
              "townLocationName": "Downtown",
              "districtName": "Manhattan",
              "countrySubDivision": "New York",
              "addressLine": [
                "123 Main St",
                "New York",
                "NY 12345"
              ]
            }
          ],
          "nationalIdentification": {
            "countryOfIssue": "US",
            "nationalIdentifierType": "NATIONAL_ID",
            "registrationAuthority": "RA123456"
          },
          "customerIdentification": "CUST987654",
          "countryOfRegistration": "US"
        }
      }
    ],
    "beneficiaryPersons": [
      {
        "naturalPerson": {
          "name": [
            {
              "nameIdentifier": [
                {
                  "primaryIdentifier": "John",
                  "secondaryIdentifier": "Doe",
                  "nameIdentifierType": "LEGL"
                }
              ],
              "localNameIdentifier": [
                {
                  "primaryIdentifier": "John",
                  "secondaryIdentifier": "Doe",
                  "nameIdentifierType": "LEGL"
                }
              ],
              "phoneticNameIdentifier": [
                {
                  "primaryIdentifier": "John",
                  "secondaryIdentifier": "Doe",
                  "nameIdentifierType": "LEGL"
                }
              ]
            }
          ],
          "geographicAddress": [
            {
              "streetName": "123 Main St",
              "townName": "New York",
              "country": "US",
              "addressType": "HOME",
              "department": "IT",
              "subDepartment": "Security",
              "buildingName": "Acme Building",
              "townLocationName": "Downtown",
              "districtName": "Manhattan",
              "countrySubDivision": "New York",
              "addressLine": [
                "123 Main St",
                "New York",
                "NY 12345"
              ]
            }
          ],
          "nationalIdentification": {
            "countryOfIssue": "US",
            "nationalIdentifierType": "NATIONAL_ID",
            "registrationAuthority": "RA123456"
          },
          "dateAndPlaceOfBirth": {
            "dateOfBirth": "1990-01-01",
            "placeOfBirth": "New York, USA"
          },
          "customerIdentification": "CUST123456",
          "countryOfResidence": "US"
        },
        "legalPerson": {
          "name": {
            "nameIdentifier": [
              {
                "legalPersonName": "Acme Corporation",
                "legalPersonNameIdentifierType": "LEGL"
              }
            ],
            "localNameIdentifier": [
              {
                "legalPersonName": "アクメ株式会社",
                "legalPersonNameIdentifierType": "LEGL"
              }
            ],
            "phoneticNameIdentifier": [
              {
                "legalPersonName": "Akume Kabushiki Gaisha",
                "legalPersonNameIdentifierType": "LEGL"
              }
            ]
          },
          "geographicAddress": [
            {
              "streetName": "123 Main St",
              "townName": "New York",
              "country": "US",
              "addressType": "HOME",
              "department": "IT",
              "subDepartment": "Security",
              "buildingName": "Acme Building",
              "townLocationName": "Downtown",
              "districtName": "Manhattan",
              "countrySubDivision": "New York",
              "addressLine": [
                "123 Main St",
                "New York",
                "NY 12345"
              ]
            }
          ],
          "nationalIdentification": {
            "countryOfIssue": "US",
            "nationalIdentifierType": "NATIONAL_ID",
            "registrationAuthority": "RA123456"
          },
          "customerIdentification": "CUST987654",
          "countryOfRegistration": "US"
        }
      }
    ]
  },
  "beneficiary": {
    "originatorPersons": [
      {
        "naturalPerson": {
          "name": [
            {
              "nameIdentifier": [
                {
                  "primaryIdentifier": "John",
                  "secondaryIdentifier": "Doe",
                  "nameIdentifierType": "LEGL"
                }
              ],
              "localNameIdentifier": [
                {
                  "primaryIdentifier": "John",
                  "secondaryIdentifier": "Doe",
                  "nameIdentifierType": "LEGL"
                }
              ],
              "phoneticNameIdentifier": [
                {
                  "primaryIdentifier": "John",
                  "secondaryIdentifier": "Doe",
                  "nameIdentifierType": "LEGL"
                }
              ]
            }
          ],
          "geographicAddress": [
            {
              "streetName": "123 Main St",
              "townName": "New York",
              "country": "US",
              "addressType": "HOME",
              "department": "IT",
              "subDepartment": "Security",
              "buildingName": "Acme Building",
              "townLocationName": "Downtown",
              "districtName": "Manhattan",
              "countrySubDivision": "New York",
              "addressLine": [
                "123 Main St",
                "New York",
                "NY 12345"
              ]
            }
          ],
          "nationalIdentification": {
            "countryOfIssue": "US",
            "nationalIdentifierType": "NATIONAL_ID",
            "registrationAuthority": "RA123456"
          },
          "dateAndPlaceOfBirth": {
            "dateOfBirth": "1990-01-01",
            "placeOfBirth": "New York, USA"
          },
          "customerIdentification": "CUST123456",
          "countryOfResidence": "US"
        },
        "legalPerson": {
          "name": {
            "nameIdentifier": [
              {
                "legalPersonName": "Acme Corporation",
                "legalPersonNameIdentifierType": "LEGL"
              }
            ],
            "localNameIdentifier": [
              {
                "legalPersonName": "アクメ株式会社",
                "legalPersonNameIdentifierType": "LEGL"
              }
            ],
            "phoneticNameIdentifier": [
              {
                "legalPersonName": "Akume Kabushiki Gaisha",
                "legalPersonNameIdentifierType": "LEGL"
              }
            ]
          },
          "geographicAddress": [
            {
              "streetName": "123 Main St",
              "townName": "New York",
              "country": "US",
              "addressType": "HOME",
              "department": "IT",
              "subDepartment": "Security",
              "buildingName": "Acme Building",
              "townLocationName": "Downtown",
              "districtName": "Manhattan",
              "countrySubDivision": "New York",
              "addressLine": [
                "123 Main St",
                "New York",
                "NY 12345"
              ]
            }
          ],
          "nationalIdentification": {
            "countryOfIssue": "US",
            "nationalIdentifierType": "NATIONAL_ID",
            "registrationAuthority": "RA123456"
          },
          "customerIdentification": "CUST987654",
          "countryOfRegistration": "US"
        }
      }
    ],
    "beneficiaryPersons": [
      {
        "naturalPerson": {
          "name": [
            {
              "nameIdentifier": [
                {
                  "primaryIdentifier": "John",
                  "secondaryIdentifier": "Doe",
                  "nameIdentifierType": "LEGL"
                }
              ],
              "localNameIdentifier": [
                {
                  "primaryIdentifier": "John",
                  "secondaryIdentifier": "Doe",
                  "nameIdentifierType": "LEGL"
                }
              ],
              "phoneticNameIdentifier": [
                {
                  "primaryIdentifier": "John",
                  "secondaryIdentifier": "Doe",
                  "nameIdentifierType": "LEGL"
                }
              ]
            }
          ],
          "geographicAddress": [
            {
              "streetName": "123 Main St",
              "townName": "New York",
              "country": "US",
              "addressType": "HOME",
              "department": "IT",
              "subDepartment": "Security",
              "buildingName": "Acme Building",
              "townLocationName": "Downtown",
              "districtName": "Manhattan",
              "countrySubDivision": "New York",
              "addressLine": [
                "123 Main St",
                "New York",
                "NY 12345"
              ]
            }
          ],
          "nationalIdentification": {
            "countryOfIssue": "US",
            "nationalIdentifierType": "NATIONAL_ID",
            "registrationAuthority": "RA123456"
          },
          "dateAndPlaceOfBirth": {
            "dateOfBirth": "1990-01-01",
            "placeOfBirth": "New York, USA"
          },
          "customerIdentification": "CUST123456",
          "countryOfResidence": "US"
        },
        "legalPerson": {
          "name": {
            "nameIdentifier": [
              {
                "legalPersonName": "Acme Corporation",
                "legalPersonNameIdentifierType": "LEGL"
              }
            ],
            "localNameIdentifier": [
              {
                "legalPersonName": "アクメ株式会社",
                "legalPersonNameIdentifierType": "LEGL"
              }
            ],
            "phoneticNameIdentifier": [
              {
                "legalPersonName": "Akume Kabushiki Gaisha",
                "legalPersonNameIdentifierType": "LEGL"
              }
            ]
          },
          "geographicAddress": [
            {
              "streetName": "123 Main St",
              "townName": "New York",
              "country": "US",
              "addressType": "HOME",
              "department": "IT",
              "subDepartment": "Security",
              "buildingName": "Acme Building",
              "townLocationName": "Downtown",
              "districtName": "Manhattan",
              "countrySubDivision": "New York",
              "addressLine": [
                "123 Main St",
                "New York",
                "NY 12345"
              ]
            }
          ],
          "nationalIdentification": {
            "countryOfIssue": "US",
            "nationalIdentifierType": "NATIONAL_ID",
            "registrationAuthority": "RA123456"
          },
          "customerIdentification": "CUST987654",
          "countryOfRegistration": "US"
        }
      }
    ]
  },
  "encrypted": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "protocol": "TRLight",
  "travelRuleBehavior": true,
  "originatorRef": "ORG123456",
  "beneficiaryRef": "BEN654321",
  "travelRuleBehaviorRef": "TRB987654",
  "originatorProof": {
    "type": "eip-191",
    "proof": "0x3dd4a17a...ce4a2bcd1b",
    "attestation": "I certify that ETH account 0x896B...0b9b belongs to me.",
    "address": "0x896B...0b9b",
    "wallet_provider": "Metamask",
    "url": "https://example.com/uploaded_image.png",
    "did": "did:key:z6Mkf12345Zabcdef12345",
    "status": "verified",
    "confirmed": true
  },
  "beneficiaryProof": {
    "type": "eip-191",
    "proof": "0x3dd4a17a...ce4a2bcd1b",
    "attestation": "I certify that ETH account 0x896B...0b9b belongs to me.",
    "address": "0x896B...0b9b",
    "wallet_provider": "Metamask",
    "url": "https://example.com/uploaded_image.png",
    "did": "did:key:z6Mkf12345Zabcdef12345",
    "status": "verified",
    "confirmed": true
  },
  "beneficiaryDid": "did:key:z6Mkf67890Zghijkl67890",
  "originatorDid": "did:key:z6Mkf12345Zabcdef12345",
  "isNonCustodial": true,
  "pii": {
    "originatorPersons": [
      {
        "naturalPerson": {
          "name": [
            {
              "nameIdentifier": [
                {
                  "primaryIdentifier": "QmP6wx8bx3SVNG3hd3SZKnS5pDjUan4y9H1VtyRqu7tsAv",
                  "secondaryIdentifier": "QmP6wx8bx3SVNG3hd3SZKnS5pDjUan4y9H1VtyRqu7tsAv",
                  "nameIdentifierType": "QmP6wx8bx3SVNG3hd3SZKnS5pDjUan4y9H1VtyRqu7tsAv"
                }
              ],
              "localNameIdentifier": [
                {
                  "primaryIdentifier": "QmP6wx8bx3SVNG3hd3SZKnS5pDjUan4y9H1VtyRqu7tsAv",
                  "secondaryIdentifier": "QmP6wx8bx3SVNG3hd3SZKnS5pDjUan4y9H1VtyRqu7tsAv",
                  "nameIdentifierType": "QmP6wx8bx3SVNG3hd3SZKnS5pDjUan4y9H1VtyRqu7tsAv"
                }
              ],
              "phoneticNameIdentifier": [
                {
                  "primaryIdentifier": "QmP6wx8bx3SVNG3hd3SZKnS5pDjUan4y9H1VtyRqu7tsAv",
                  "secondaryIdentifier": "QmP6wx8bx3SVNG3hd3SZKnS5pDjUan4y9H1VtyRqu7tsAv",
                  "nameIdentifierType": "QmP6wx8bx3SVNG3hd3SZKnS5pDjUan4y9H1VtyRqu7tsAv"
                }
              ]
            }
          ],
          "geographicAddress": [
            {
              "streetName": "QmZGXXsKPk5iPS97LLjXB5e8Qs555ocdzcpbPMXvt84Ji9",
              "townName": "QmNkEt9VdnhjefQMXo3ZaZAs765ugoWiazaqcY9skHMjCt",
              "country": "QmRGHdoxQfSi6tevyvaYGzs8BVStfqJqEyrMYqUfzXxkmm",
              "buildingNumber": "QmUFpNkxdsVtebDSUz5eP51kzoysXmqj2gBgeH11PD7SVP",
              "postCode": "QmTJsK3sc3fPEVwvAp97UUiVoFhjzQhYX3sCda1JxuCnXj",
              "addressType": "Qmdr9LcChZsoivS6uAhe7Qk7cGLDAx73wBZTVvq4WoU71H",
              "department": "QmN7fb65x5MyA7RKyhbXaUKvJ7U4Y9eqpEZTmJYpNyEG8",
              "subDepartment": "QmTkfyGh54tXNqFxyEGK9NyTJZYpQ6RZ9zpNykxykME8s",
              "buildingName": "QmXJfGk85t6RKyhbXaEK9Nz4MEeMKypq6EY9zpJyC9nM9",
              "floor": "QmZP5G7fhZpMyQxXnT9KyR6ybXaEM9zpJy4ME9MkTJGE1",
              "postBox": "QmTkfYRGK54xFqXyJYNZyE9kY9zpMKytJnXy5z9EME9sJ",
              "room": "QmRYXnT9KyhbXaEMZpMyxMkZ9zpYNYTJ4ME5kCGE7fhMJ",
              "townLocationName": "QmNpZTyXJXnT9K6EYZpQxYNYMkC5p4kGEfhnkMJzpYT9Jm",
              "districtName": "QmT9p6ERKyNYXnTyhbpMYJ4zpYT9kMJZT9QmEMGZ5kMhCy",
              "countrySubDivision": "QmK9yTbXaZpMYJYTYp6NT9QmEMGZT9p9kMJfhyGE4Z7k5C",
              "addressLine": [
                "QmNp9kMjfhGZ5kMJzpNYXZTy6NQmZYEMGZ4kZT9Y6pNYT"
              ]
            }
          ],
          "nationalIdentification": {
            "countryOfIssue": "QmRGHdoxQfSi6tevyvaYGzs8BVStfqJqEyrMYqUfzXxkmm",
            "nationalIdentifier": "QmdR6qLnZ7Kwf5cBaXG8QFQenEvRg9JNZeoPranVuGd63z",
            "nationalIdentifierType": "QmUKTg3aFJFhMz1o9gPqA3MgTRwd2LvDLwWTPHYUoMEYVi",
            "registrationAuthority": "QmV9KJMyT9RJzpYfhME5xNCZ4G67fEkzTpRMyJzp9kTNYk"
          },
          "dateAndPlaceOfBirth": {
            "dateOfBirth": "QmNkEt9VdnhjefQMXo3ZaZAs765ugoWiazaqcY9skHMjCt",
            "placeOfBirth": "QmNkEt9VdnhjefQMXo3ZaZAs765ugoWiazaqcY9skHMjCt"
          },
          "customerIdentification": "QmTJsK3sc3fPEVwvAp97UUiVoFhjzQhYX3sCda1JxuCnXj",
          "countryOfResidence": "QmTJsK3sc3fPEVwvAp97UUiVoFhjzQhYX3sCda1JxuCnXj",
          "customerNumber": "QmTJsK3sc3fPEVwvAp97UUiVoFhjzQhYX3sCda1JxuCnXj"
        },
        "legalPerson": {
          "name": {
            "nameIdentifier": [
              {
                "legalPersonName": "QmVXXj5BJchhqQTU27uEkeghYMnxR6aVjZxJP9jS6uCg9Q",
                "legalPersonNameIdentifierType": "QmPevsa5xdkxf6Lgt7f9YweRBdgseeAkWVaYyssKF3Q86e"
              }
            ],
            "localNameIdentifier": [
              {
                "legalPersonName": "QmVXXj5BJchhqQTU27uEkeghYMnxR6aVjZxJP9jS6uCg9Q",
                "legalPersonNameIdentifierType": "QmPevsa5xdkxf6Lgt7f9YweRBdgseeAkWVaYyssKF3Q86e"
              }
            ],
            "phoneticNameIdentifier": [
              {
                "legalPersonName": "QmVXXj5BJchhqQTU27uEkeghYMnxR6aVjZxJP9jS6uCg9Q",
                "legalPersonNameIdentifierType": "QmPevsa5xdkxf6Lgt7f9YweRBdgseeAkWVaYyssKF3Q86e"
              }
            ]
          },
          "geographicAddress": [
            {
              "streetName": "QmZGXXsKPk5iPS97LLjXB5e8Qs555ocdzcpbPMXvt84Ji9",
              "townName": "QmNkEt9VdnhjefQMXo3ZaZAs765ugoWiazaqcY9skHMjCt",
              "country": "QmRGHdoxQfSi6tevyvaYGzs8BVStfqJqEyrMYqUfzXxkmm",
              "buildingNumber": "QmUFpNkxdsVtebDSUz5eP51kzoysXmqj2gBgeH11PD7SVP",
              "postCode": "QmTJsK3sc3fPEVwvAp97UUiVoFhjzQhYX3sCda1JxuCnXj",
              "addressType": "Qmdr9LcChZsoivS6uAhe7Qk7cGLDAx73wBZTVvq4WoU71H",
              "department": "QmN7fb65x5MyA7RKyhbXaUKvJ7U4Y9eqpEZTmJYpNyEG8",
              "subDepartment": "QmTkfyGh54tXNqFxyEGK9NyTJZYpQ6RZ9zpNykxykME8s",
              "buildingName": "QmXJfGk85t6RKyhbXaEK9Nz4MEeMKypq6EY9zpJyC9nM9",
              "floor": "QmZP5G7fhZpMyQxXnT9KyR6ybXaEM9zpJy4ME9MkTJGE1",
              "postBox": "QmTkfYRGK54xFqXyJYNZyE9kY9zpMKytJnXy5z9EME9sJ",
              "room": "QmRYXnT9KyhbXaEMZpMyxMkZ9zpYNYTJ4ME5kCGE7fhMJ",
              "townLocationName": "QmNpZTyXJXnT9K6EYZpQxYNYMkC5p4kGEfhnkMJzpYT9Jm",
              "districtName": "QmT9p6ERKyNYXnTyhbpMYJ4zpYT9kMJZT9QmEMGZ5kMhCy",
              "countrySubDivision": "QmK9yTbXaZpMYJYTYp6NT9QmEMGZT9p9kMJfhyGE4Z7k5C",
              "addressLine": [
                "QmNp9kMjfhGZ5kMJzpNYXZTy6NQmZYEMGZ4kZT9Y6pNYT"
              ]
            }
          ],
          "nationalIdentification": {
            "countryOfIssue": "QmRGHdoxQfSi6tevyvaYGzs8BVStfqJqEyrMYqUfzXxkmm",
            "nationalIdentifier": "QmdR6qLnZ7Kwf5cBaXG8QFQenEvRg9JNZeoPranVuGd63z",
            "nationalIdentifierType": "QmUKTg3aFJFhMz1o9gPqA3MgTRwd2LvDLwWTPHYUoMEYVi",
            "registrationAuthority": "QmV9KJMyT9RJzpYfhME5xNCZ4G67fEkzTpRMyJzp9kTNYk"
          },
          "customerIdentification": "QmRY9AA4Uit2JRTxDzfzshrJdTK86Kf5HriA3dXDnihDmy",
          "customerNumber": "QmXvyML3AJUFpBbJqL5NVp7Vn7xNkuedTsSMk93duLCNW8",
          "countryOfRegistration": "QmeoTk6UPruEAYNbJEAHdQYc53ap9BXmpnPMcuvs8wutdr"
        }
      }
    ],
    "beneficiaryPersons": [
      {
        "naturalPerson": {
          "name": [
            {
              "nameIdentifier": [
                {
                  "primaryIdentifier": "QmP6wx8bx3SVNG3hd3SZKnS5pDjUan4y9H1VtyRqu7tsAv",
                  "secondaryIdentifier": "QmP6wx8bx3SVNG3hd3SZKnS5pDjUan4y9H1VtyRqu7tsAv",
                  "nameIdentifierType": "QmP6wx8bx3SVNG3hd3SZKnS5pDjUan4y9H1VtyRqu7tsAv"
                }
              ],
              "localNameIdentifier": [
                {
                  "primaryIdentifier": "QmP6wx8bx3SVNG3hd3SZKnS5pDjUan4y9H1VtyRqu7tsAv",
                  "secondaryIdentifier": "QmP6wx8bx3SVNG3hd3SZKnS5pDjUan4y9H1VtyRqu7tsAv",
                  "nameIdentifierType": "QmP6wx8bx3SVNG3hd3SZKnS5pDjUan4y9H1VtyRqu7tsAv"
                }
              ],
              "phoneticNameIdentifier": [
                {
                  "primaryIdentifier": "QmP6wx8bx3SVNG3hd3SZKnS5pDjUan4y9H1VtyRqu7tsAv",
                  "secondaryIdentifier": "QmP6wx8bx3SVNG3hd3SZKnS5pDjUan4y9H1VtyRqu7tsAv",
                  "nameIdentifierType": "QmP6wx8bx3SVNG3hd3SZKnS5pDjUan4y9H1VtyRqu7tsAv"
                }
              ]
            }
          ],
          "geographicAddress": [
            {
              "streetName": "QmZGXXsKPk5iPS97LLjXB5e8Qs555ocdzcpbPMXvt84Ji9",
              "townName": "QmNkEt9VdnhjefQMXo3ZaZAs765ugoWiazaqcY9skHMjCt",
              "country": "QmRGHdoxQfSi6tevyvaYGzs8BVStfqJqEyrMYqUfzXxkmm",
              "buildingNumber": "QmUFpNkxdsVtebDSUz5eP51kzoysXmqj2gBgeH11PD7SVP",
              "postCode": "QmTJsK3sc3fPEVwvAp97UUiVoFhjzQhYX3sCda1JxuCnXj",
              "addressType": "Qmdr9LcChZsoivS6uAhe7Qk7cGLDAx73wBZTVvq4WoU71H",
              "department": "QmN7fb65x5MyA7RKyhbXaUKvJ7U4Y9eqpEZTmJYpNyEG8",
              "subDepartment": "QmTkfyGh54tXNqFxyEGK9NyTJZYpQ6RZ9zpNykxykME8s",
              "buildingName": "QmXJfGk85t6RKyhbXaEK9Nz4MEeMKypq6EY9zpJyC9nM9",
              "floor": "QmZP5G7fhZpMyQxXnT9KyR6ybXaEM9zpJy4ME9MkTJGE1",
              "postBox": "QmTkfYRGK54xFqXyJYNZyE9kY9zpMKytJnXy5z9EME9sJ",
              "room": "QmRYXnT9KyhbXaEMZpMyxMkZ9zpYNYTJ4ME5kCGE7fhMJ",
              "townLocationName": "QmNpZTyXJXnT9K6EYZpQxYNYMkC5p4kGEfhnkMJzpYT9Jm",
              "districtName": "QmT9p6ERKyNYXnTyhbpMYJ4zpYT9kMJZT9QmEMGZ5kMhCy",
              "countrySubDivision": "QmK9yTbXaZpMYJYTYp6NT9QmEMGZT9p9kMJfhyGE4Z7k5C",
              "addressLine": [
                "QmNp9kMjfhGZ5kMJzpNYXZTy6NQmZYEMGZ4kZT9Y6pNYT"
              ]
            }
          ],
          "nationalIdentification": {
            "countryOfIssue": "QmRGHdoxQfSi6tevyvaYGzs8BVStfqJqEyrMYqUfzXxkmm",
            "nationalIdentifier": "QmdR6qLnZ7Kwf5cBaXG8QFQenEvRg9JNZeoPranVuGd63z",
            "nationalIdentifierType": "QmUKTg3aFJFhMz1o9gPqA3MgTRwd2LvDLwWTPHYUoMEYVi",
            "registrationAuthority": "QmV9KJMyT9RJzpYfhME5xNCZ4G67fEkzTpRMyJzp9kTNYk"
          },
          "dateAndPlaceOfBirth": {
            "dateOfBirth": "QmNkEt9VdnhjefQMXo3ZaZAs765ugoWiazaqcY9skHMjCt",
            "placeOfBirth": "QmNkEt9VdnhjefQMXo3ZaZAs765ugoWiazaqcY9skHMjCt"
          },
          "customerIdentification": "QmTJsK3sc3fPEVwvAp97UUiVoFhjzQhYX3sCda1JxuCnXj",
          "countryOfResidence": "QmTJsK3sc3fPEVwvAp97UUiVoFhjzQhYX3sCda1JxuCnXj",
          "customerNumber": "QmTJsK3sc3fPEVwvAp97UUiVoFhjzQhYX3sCda1JxuCnXj"
        },
        "legalPerson": {
          "name": {
            "nameIdentifier": [
              {
                "legalPersonName": "QmVXXj5BJchhqQTU27uEkeghYMnxR6aVjZxJP9jS6uCg9Q",
                "legalPersonNameIdentifierType": "QmPevsa5xdkxf6Lgt7f9YweRBdgseeAkWVaYyssKF3Q86e"
              }
            ],
            "localNameIdentifier": [
              {
                "legalPersonName": "QmVXXj5BJchhqQTU27uEkeghYMnxR6aVjZxJP9jS6uCg9Q",
                "legalPersonNameIdentifierType": "QmPevsa5xdkxf6Lgt7f9YweRBdgseeAkWVaYyssKF3Q86e"
              }
            ],
            "phoneticNameIdentifier": [
              {
                "legalPersonName": "QmVXXj5BJchhqQTU27uEkeghYMnxR6aVjZxJP9jS6uCg9Q",
                "legalPersonNameIdentifierType": "QmPevsa5xdkxf6Lgt7f9YweRBdgseeAkWVaYyssKF3Q86e"
              }
            ]
          },
          "geographicAddress": [
            {
              "streetName": "QmZGXXsKPk5iPS97LLjXB5e8Qs555ocdzcpbPMXvt84Ji9",
              "townName": "QmNkEt9VdnhjefQMXo3ZaZAs765ugoWiazaqcY9skHMjCt",
              "country": "QmRGHdoxQfSi6tevyvaYGzs8BVStfqJqEyrMYqUfzXxkmm",
              "buildingNumber": "QmUFpNkxdsVtebDSUz5eP51kzoysXmqj2gBgeH11PD7SVP",
              "postCode": "QmTJsK3sc3fPEVwvAp97UUiVoFhjzQhYX3sCda1JxuCnXj",
              "addressType": "Qmdr9LcChZsoivS6uAhe7Qk7cGLDAx73wBZTVvq4WoU71H",
              "department": "QmN7fb65x5MyA7RKyhbXaUKvJ7U4Y9eqpEZTmJYpNyEG8",
              "subDepartment": "QmTkfyGh54tXNqFxyEGK9NyTJZYpQ6RZ9zpNykxykME8s",
              "buildingName": "QmXJfGk85t6RKyhbXaEK9Nz4MEeMKypq6EY9zpJyC9nM9",
              "floor": "QmZP5G7fhZpMyQxXnT9KyR6ybXaEM9zpJy4ME9MkTJGE1",
              "postBox": "QmTkfYRGK54xFqXyJYNZyE9kY9zpMKytJnXy5z9EME9sJ",
              "room": "QmRYXnT9KyhbXaEMZpMyxMkZ9zpYNYTJ4ME5kCGE7fhMJ",
              "townLocationName": "QmNpZTyXJXnT9K6EYZpQxYNYMkC5p4kGEfhnkMJzpYT9Jm",
              "districtName": "QmT9p6ERKyNYXnTyhbpMYJ4zpYT9kMJZT9QmEMGZ5kMhCy",
              "countrySubDivision": "QmK9yTbXaZpMYJYTYp6NT9QmEMGZT9p9kMJfhyGE4Z7k5C",
              "addressLine": [
                "QmNp9kMjfhGZ5kMJzpNYXZTy6NQmZYEMGZ4kZT9Y6pNYT"
              ]
            }
          ],
          "nationalIdentification": {
            "countryOfIssue": "QmRGHdoxQfSi6tevyvaYGzs8BVStfqJqEyrMYqUfzXxkmm",
            "nationalIdentifier": "QmdR6qLnZ7Kwf5cBaXG8QFQenEvRg9JNZeoPranVuGd63z",
            "nationalIdentifierType": "QmUKTg3aFJFhMz1o9gPqA3MgTRwd2LvDLwWTPHYUoMEYVi",
            "registrationAuthority": "QmV9KJMyT9RJzpYfhME5xNCZ4G67fEkzTpRMyJzp9kTNYk"
          },
          "customerIdentification": "QmRY9AA4Uit2JRTxDzfzshrJdTK86Kf5HriA3dXDnihDmy",
          "customerNumber": "QmXvyML3AJUFpBbJqL5NVp7Vn7xNkuedTsSMk93duLCNW8",
          "countryOfRegistration": "QmeoTk6UPruEAYNbJEAHdQYc53ap9BXmpnPMcuvs8wutdr"
        }
      }
    ],
    "accountNumber": [
      "QmNkEt9VdnhjefQMXo3ZaZAs765ugoWiazaqcY9skHMjCt"
    ]
  }
}

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.