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. The originator data must definitely include the name and wallet address. In the originator data, you must send one of the following data: date of birth, identity information, address or customer number. On the beneficiary side, it is sufficient to send only the name and wallet address data.
Body
transaction_ref
string
Transaction reference number from your system. (Required)
transaction_asset
string
Asset Symbol (Required)
transaction_network
string
Asset Network
transaction_amount
string
Asset Amount (Required)
transaction_asset_decimals
string
Asset Decimals (Required)
originator
object
Originator Data (Required)
persons
array
Originator Person Data (Required)
name
object
Originator Person Name (Required)
dateAndPlaceOfBirth
object
Originator Person birthplace or birthday
nationalIdentifier
object
Originator Person national identifier
customerIdenficiation
object
Originator Person customer ID
geographicAddress
object
Originator Person's Address
accountNumber
array
Originator Wallet Address (Required)
beneficiary
object
Beneficiary Data (Required)
persons
array
Beneficiary Person Data (Required)
name
object
Beneficiary Person Name (Required)
dateAndPlaceOfBirth
object
Beneficiary Person birthplace or birthday
nationalIdenficiation
object
Beneficiary Person national identifier
customerIdenficiation
object
Beneficiary Person customer ID
geographicAddress
object
Beneficiary Person's Address
accountNumber
array
Beneficiary Wallet Address (Required)
const axios = require('axios');
const data = JSON.stringify({
"transaction_ref": "a4de3f3f-668f-4844-995a-03ad1b73a52f",
"transaction_asset": "ETH",
"transaction_amount": "20000000000000000000",
"transaction_asset_decimals": "18",
"beneficiary_vasp_id": "3651dcbf-b41f-4f68-b79b-7ce794caf233",
"originator": {
"persons": [
{
"naturalPerson": {
"name": {
"nameIdentifier": [
{
"primaryIdentifier": "Merve",
"secondaryIdentifier": "Güler",
"nameIdentifierType": "LEGL"
}
]
},
"dateAndPlaceOfBirth": {
"dateOfBirth": "1990-02-24",
"placeOfBirth": "Singapore"
},
"nationalIdentification": {
"nationalIdentifier": "12345678910",
"nationalIdentifierType": "CCPT",
"countryOfIssue": "TR"
},
"geographicAddress": [
{
"addressType": "GEOG",
"streetName": "Potential Street",
"buildingNumber": "123",
"buildingName": "Cheese Hut",
"postCode": "91361",
"townName": "Thousand Oaks",
"countrySubDivision": "California",
"country": "US"
}
],
"customerIdentification": "01010101"
}
}
],
"accountNumber": [
"0x1d0d2d8c85441050abc9eb654399fa198fbd5720"
]
},
"beneficiary": {
"persons": [
{
"naturalPerson": {
"name": {
"nameIdentifier": [
{
"primaryIdentifier": "Merve",
"secondaryIdentifier": "Güler",
"nameIdentifierType": "LEGL"
}
]
}
}
}
],
"accountNumber": [
"0x1d0d2d8c85441050abc9eb654399fa198fbd5722"
]
}
});
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);
});Send Transaction Hash
POST /travelrule/send_tx_hash
This service is sending transaction hash to us for travel rule protocol.
Body
transaction_ref
string
Your transaction reference number. (Required)
transaction_hash
string
On-Chain Transaction Hash (Required)
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);
});List Available VASPs
GET /travelrule/list_vasps
This service is listing available vasps for travel rule withdrawal.
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);
});
Send Wallet Address
POST /travelrule/send_address
This service is sending wallet address to us for travel rule protocol.
Body
transaction_ref
string
Your transaction reference number. (Required)
address
string
Wallet Address (Required)
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);
});Receive Transaction Without Protocol
POST /travelrule/receive_tx_without_protocol
This service is there to allow you to receive a transaction when without protocol.
const axios = require('axios');
const data = JSON.stringify({
"transaction_ref": "a4de3f3f-668f-4844-995a-03ad1b73a51f",
"transaction_asset": "ETH",
"transaction_hash": "0xTest",
"transaction_amount": "20000000000000000000",
"transaction_asset_decimals": "18",
"originator": {
"persons": [
{
"naturalPerson": {
"name": {
"nameIdentifier": [
{
"primaryIdentifier": "Merve",
"secondaryIdentifier": "Güler",
"nameIdentifierType": "LEGL"
}
]
},
"dateAndPlaceOfBirth": {
"dateOfBirth": "1990-02-24",
"placeOfBirth": "Singapore"
},
"nationalIdentification": {
"nationalIdentifier": "12345678910",
"nationalIdentifierType": "CCPT",
"countryOfIssue": "TR"
},
"geographicAddress": [
{
"addressType": "GEOG",
"streetName": "Potential Street",
"buildingNumber": "123",
"buildingName": "Cheese Hut",
"postCode": "91361",
"townName": "Thousand Oaks",
"countrySubDivision": "California",
"country": "US"
}
],
"customerIdentification": "01010101"
}
}
],
"accountNumber": [
"0x1d0d2d8c85441050abc9eb654399fa198fbd5722"
]
},
"beneficiary": {
"persons": [
{
"naturalPerson": {
"name": {
"nameIdentifier": [
{
"primaryIdentifier": "Merve",
"secondaryIdentifier": "Güler",
"nameIdentifierType": "LEGL"
}
]
}
}
}
],
"accountNumber": [
"0x1d0d2d8c85441050abc9eb654399fa198fbd5722"
]
},
"created_at": "2025-02-10T14:16:03.544Z"
});
const config = {
method: 'post',
url: 'https://api.getdefy.co/v2/travelrule/receive_tx_without_protocol',
headers: {
'apikey': 'APIKEY'
},
data : data
};
axios.request(config)
.then((response) => {
console.log(JSON.stringify(response.data));
})
.catch((error) => {
console.log(error);
});
Notes
You need to enter the network parameter to get clearer data. If you do not enter the network parameter, we add the default network according to the wallet address.
Last updated
Was this helpful?