API Reference

All services for Travel Rule are listed here. You can search for services from the indicator on the right.

Create Transaction

POST /travelrule/create_tx

This service is there to allow you to create a transaction when sending money of the endpoint.

Request

const axios = require('axios');

const data = JSON.stringify({
  "transaction_ref": "a4de3f3f-668f-4844-995a-03ad1b73a54d",
  "transaction_asset": "ETH",
  "transaction_amount": "2000000000",
  "transaction_asset_decimals": "18",
  "originator_vasp_id": "adbacc97-6f65-49e8-b746-5699e1c3abd7",
  "beneficiary_vasp_id": "573f97ad-831d-4563-96a1-117256d3705d",
  "originator": {
    "wallet_address": "0x1d0d2d8c85441050abc9eb654399fa198fbd5722",
    "persons": [
      {
        "naturalPerson": {
          "name": {
            "nameIdentifier": [
              {
                "primaryIdentifier": "Post",
                "secondaryIdentifier": "Johnny",
                "nameIdentifierType": "LEGL"
              }
            ]
          },
          "geographicAddress": [
            {
              "addressType": "GEOG",
              "streetName": "Potential Street",
              "buildingNumber": "123",
              "buildingName": "Cheese Hut",
              "postCode": "91361",
              "townName": "Thousand Oaks",
              "countrySubDivision": "California",
              "country": "US"
            }
          ],
          "customerIdentification": "1002390"
        }
      }
    ]
  },
  "beneficiary": {
    "wallet_address": "0x1d0d2d8c85441050abc9eb654399fa198fbd5722",
    "persons": [
      {
        "naturalPerson": {
          "name": {
            "nameIdentifier": [
              {
                "primaryIdentifier": "MachuPichu",
                "secondaryIdentifier": "Freddie",
                "nameIdentifierType": "LEGL"
              }
            ]
          }
        }
      }
    ]
  }
});

const config = {
  method: 'post',
  url: 'https://api.getdefy.co/v2/travelrule/create_tx',
  headers: { 
    'Content-Type': 'application/json', 
    'apikey': 'APIKEY'
  },
  data : data
};

axios.request(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});

Response

{
    "code": 0,
    "message": "OK",
    "data": "PENDING"
}

Send Transaction Hash

POST /travelrule/send_tx_hash

This service is sending transaction hash to us for travel rule protocol.

Request

const axios = require('axios');

const data = JSON.stringify({
  "transaction_ref": "a4de3f3f-668f-4844-995a-03ad1b73a54d",
  "transaction_hash": "0xETH"
});

const config = {
  method: 'post',
  url: 'https://api.getdefy.co/v2/travelrule/send_tx_hash',
  headers: { 
    'Content-Type': 'application/json', 
    'apikey': 'APIKEY'
  },
  data : data
};

axios.request(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});

Response

{
    "code": 0,
    "message": "OK",
    "data": null
}

List Available VASPs

GET /travelrule/list_vasps

This service is listing available vasps for travel rule withdrawal.

Request

const axios = require('axios');

const config = {
  method: 'get',
  url: 'https://api.getdefy.co/v2/travelrule/list_vasps?page=1&limit=10',
  headers: { 
    'apikey': 'APIKEY'
  }
};

axios.request(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});

Response

{
    "code": 0,
    "message": "OK",
    "data": [
        {
            "id": "3",
            "uid": "573f97ad-831d-4563-96a1-117256d3705d",
            "legal_name": "Vasp B",
            "lei": "654321",
            "country": "TR",
            "url": "https://vaspb.net",
            "email": "[e-mail]",
            "tr_url": "https://webhook.site/69a7d6e0-3af4-491d-b190-37e5fe370bc6",
            "created_at": "2025-01-16T10:10:34.780Z",
            "updated_at": "2025-01-16T10:10:34.780Z"
        },
        {
            "id": "2",
            "uid": "adbacc97-6f65-49e8-b746-5699e1c3abd7",
            "legal_name": "Vasp A",
            "lei": "123456",
            "country": "TR",
            "url": "https://vaspa.net",
            "email": "[e-mail]",
            "tr_url": "https://api.vaspa.net",
            "created_at": "2025-01-16T10:09:46.192Z",
            "updated_at": "2025-01-16T10:09:46.192Z"
        }
    ],
    "page_count": 1
}

Receive Transaction

POST /travelrule/receive_tx

This service is receiving transaction for counter VASP.

Request

const axios = require('axios');

const data = JSON.stringify({
  "asset": "ETH",
  "amount": 2000000000000000,
  "callback": "https://originator.com/implementation/defined/path/for/inquiryResolution",
  "IVMS101": {
    "originator": {
      "originatorPersons": [
        {
          "naturalPerson": {
            "name": {
              "nameIdentifier": [
                {
                  "primaryIdentifier": "Post",
                  "secondaryIdentifier": "Johnny",
                  "nameIdentifierType": "LEGL"
                }
              ]
            },
            "geographicAddress": [
              {
                "addressType": "GEOG",
                "streetName": "Potential Street",
                "buildingNumber": "123",
                "buildingName": "Cheese Hut",
                "postCode": "91361",
                "townName": "Thousand Oaks",
                "countrySubDivision": "California",
                "country": "US"
              }
            ],
            "customerIdentification": "0x1d0d2d8c85441050abc9eb654399fa198fbd5722"
          }
        }
      ]
    },
    "beneficiary": {
      "beneficiaryPersons": [
        {
          "naturalPerson": {
            "name": {
              "nameIdentifier": [
                {
                  "primaryIdentifier": "MachuPichu",
                  "secondaryIdentifier": "Freddie",
                  "nameIdentifierType": "LEGL"
                }
              ]
            }
          }
        }
      ]
    },
    "originatingVASP": {
      "originatingVASP": {
        "legalPerson": {
          "name": {
            "nameIdentifier": [
              {
                "legalPersonName": "VASP A",
                "legalPersonNameIdentifierType": "LEGL"
              }
            ]
          },
          "nationalIdentification": {
            "nationalIdentifier": "506700T7Z685VUOZL877",
            "nationalIdentifierType": "LEIX"
          }
        }
      }
    }
  }
});

const config = {
  method: 'post',
  url: 'https://api.getdefy.co/v2/travelrule/receive_tx',
  headers: { 
    'Content-Type': 'application/json', 
    'apikey': 'APIKEY'
  },
  data : data
};

axios.request(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});

Response

{
    "code": 0,
    "message": "OK",
    "data": "PENDING"
}

Send Wallet Address

POST /travelrule/send_address

This service is sending wallet address to us for travel rule protocol.

Request

const axios = require('axios');

const data = JSON.stringify({
  "transaction_ref": "a4de3f3f-668f-4844-995a-03ad1b73a54d",
  "address": "0x1d0d2d8c85441050abc9eb654399fa198fbd5722"
});

const config = {
  method: 'post',
  url: 'https://api.getdefy.co/v2/travelrule/send_address',
  headers: { 
    'Content-Type': 'application/json', 
    'apikey': 'APIKEY'
  },
  data : data
};

axios.request(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});

Response

{
    "code": 0,
    "message": "OK",
    "data": null
}