Create travel rule entry
curl --request POST \
--url https://api.exchange.coinbase.com/travel-rules \
--header 'Content-Type: application/json' \
--header 'cb-access-key: <api-key>' \
--header 'cb-access-passphrase: <api-key>' \
--header 'cb-access-sign: <api-key>' \
--header 'cb-access-timestamp: <api-key>' \
--data '
{
"address": "<string>",
"originator_name": "<string>",
"originator_country": "<string>",
"vasp_id": "<string>",
"vasp_country": "<string>",
"lei_number": "<string>",
"originator_address": {
"address_1": "<string>",
"address_2": "<string>",
"address_3": "<string>",
"city": "<string>",
"state": "<string>",
"country": "<string>",
"postal_code": "<string>"
},
"wallet_type": "UNKNOWN_WALLET_TYPE",
"is_self_certified": true
}
'import requests
url = "https://api.exchange.coinbase.com/travel-rules"
payload = {
"address": "<string>",
"originator_name": "<string>",
"originator_country": "<string>",
"vasp_id": "<string>",
"vasp_country": "<string>",
"lei_number": "<string>",
"originator_address": {
"address_1": "<string>",
"address_2": "<string>",
"address_3": "<string>",
"city": "<string>",
"state": "<string>",
"country": "<string>",
"postal_code": "<string>"
},
"wallet_type": "UNKNOWN_WALLET_TYPE",
"is_self_certified": True
}
headers = {
"cb-access-key": "<api-key>",
"cb-access-passphrase": "<api-key>",
"cb-access-sign": "<api-key>",
"cb-access-timestamp": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'cb-access-key': '<api-key>',
'cb-access-passphrase': '<api-key>',
'cb-access-sign': '<api-key>',
'cb-access-timestamp': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
address: '<string>',
originator_name: '<string>',
originator_country: '<string>',
vasp_id: '<string>',
vasp_country: '<string>',
lei_number: '<string>',
originator_address: {
address_1: '<string>',
address_2: '<string>',
address_3: '<string>',
city: '<string>',
state: '<string>',
country: '<string>',
postal_code: '<string>'
},
wallet_type: 'UNKNOWN_WALLET_TYPE',
is_self_certified: true
})
};
fetch('https://api.exchange.coinbase.com/travel-rules', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.exchange.coinbase.com/travel-rules",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'address' => '<string>',
'originator_name' => '<string>',
'originator_country' => '<string>',
'vasp_id' => '<string>',
'vasp_country' => '<string>',
'lei_number' => '<string>',
'originator_address' => [
'address_1' => '<string>',
'address_2' => '<string>',
'address_3' => '<string>',
'city' => '<string>',
'state' => '<string>',
'country' => '<string>',
'postal_code' => '<string>'
],
'wallet_type' => 'UNKNOWN_WALLET_TYPE',
'is_self_certified' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"cb-access-key: <api-key>",
"cb-access-passphrase: <api-key>",
"cb-access-sign: <api-key>",
"cb-access-timestamp: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.exchange.coinbase.com/travel-rules"
payload := strings.NewReader("{\n \"address\": \"<string>\",\n \"originator_name\": \"<string>\",\n \"originator_country\": \"<string>\",\n \"vasp_id\": \"<string>\",\n \"vasp_country\": \"<string>\",\n \"lei_number\": \"<string>\",\n \"originator_address\": {\n \"address_1\": \"<string>\",\n \"address_2\": \"<string>\",\n \"address_3\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"<string>\",\n \"postal_code\": \"<string>\"\n },\n \"wallet_type\": \"UNKNOWN_WALLET_TYPE\",\n \"is_self_certified\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("cb-access-key", "<api-key>")
req.Header.Add("cb-access-passphrase", "<api-key>")
req.Header.Add("cb-access-sign", "<api-key>")
req.Header.Add("cb-access-timestamp", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.exchange.coinbase.com/travel-rules")
.header("cb-access-key", "<api-key>")
.header("cb-access-passphrase", "<api-key>")
.header("cb-access-sign", "<api-key>")
.header("cb-access-timestamp", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"address\": \"<string>\",\n \"originator_name\": \"<string>\",\n \"originator_country\": \"<string>\",\n \"vasp_id\": \"<string>\",\n \"vasp_country\": \"<string>\",\n \"lei_number\": \"<string>\",\n \"originator_address\": {\n \"address_1\": \"<string>\",\n \"address_2\": \"<string>\",\n \"address_3\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"<string>\",\n \"postal_code\": \"<string>\"\n },\n \"wallet_type\": \"UNKNOWN_WALLET_TYPE\",\n \"is_self_certified\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.exchange.coinbase.com/travel-rules")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["cb-access-key"] = '<api-key>'
request["cb-access-passphrase"] = '<api-key>'
request["cb-access-sign"] = '<api-key>'
request["cb-access-timestamp"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"address\": \"<string>\",\n \"originator_name\": \"<string>\",\n \"originator_country\": \"<string>\",\n \"vasp_id\": \"<string>\",\n \"vasp_country\": \"<string>\",\n \"lei_number\": \"<string>\",\n \"originator_address\": {\n \"address_1\": \"<string>\",\n \"address_2\": \"<string>\",\n \"address_3\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"<string>\",\n \"postal_code\": \"<string>\"\n },\n \"wallet_type\": \"UNKNOWN_WALLET_TYPE\",\n \"is_self_certified\": true\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"address": "<string>",
"originator_name": "<string>",
"originator_country": "<string>",
"vasp_id": "<string>",
"vasp_country": "<string>",
"lei_number": "<string>",
"originator_address": {
"address_1": "<string>",
"address_2": "<string>",
"address_3": "<string>",
"city": "<string>",
"state": "<string>",
"country": "<string>",
"postal_code": "<string>"
}
}{
"message": "<string>"
}{
"message": "<string>"
}Travel Rules
Create travel rule entry
Create travel rule entry for sending address
POST
/
travel-rules
Create travel rule entry
curl --request POST \
--url https://api.exchange.coinbase.com/travel-rules \
--header 'Content-Type: application/json' \
--header 'cb-access-key: <api-key>' \
--header 'cb-access-passphrase: <api-key>' \
--header 'cb-access-sign: <api-key>' \
--header 'cb-access-timestamp: <api-key>' \
--data '
{
"address": "<string>",
"originator_name": "<string>",
"originator_country": "<string>",
"vasp_id": "<string>",
"vasp_country": "<string>",
"lei_number": "<string>",
"originator_address": {
"address_1": "<string>",
"address_2": "<string>",
"address_3": "<string>",
"city": "<string>",
"state": "<string>",
"country": "<string>",
"postal_code": "<string>"
},
"wallet_type": "UNKNOWN_WALLET_TYPE",
"is_self_certified": true
}
'import requests
url = "https://api.exchange.coinbase.com/travel-rules"
payload = {
"address": "<string>",
"originator_name": "<string>",
"originator_country": "<string>",
"vasp_id": "<string>",
"vasp_country": "<string>",
"lei_number": "<string>",
"originator_address": {
"address_1": "<string>",
"address_2": "<string>",
"address_3": "<string>",
"city": "<string>",
"state": "<string>",
"country": "<string>",
"postal_code": "<string>"
},
"wallet_type": "UNKNOWN_WALLET_TYPE",
"is_self_certified": True
}
headers = {
"cb-access-key": "<api-key>",
"cb-access-passphrase": "<api-key>",
"cb-access-sign": "<api-key>",
"cb-access-timestamp": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'cb-access-key': '<api-key>',
'cb-access-passphrase': '<api-key>',
'cb-access-sign': '<api-key>',
'cb-access-timestamp': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
address: '<string>',
originator_name: '<string>',
originator_country: '<string>',
vasp_id: '<string>',
vasp_country: '<string>',
lei_number: '<string>',
originator_address: {
address_1: '<string>',
address_2: '<string>',
address_3: '<string>',
city: '<string>',
state: '<string>',
country: '<string>',
postal_code: '<string>'
},
wallet_type: 'UNKNOWN_WALLET_TYPE',
is_self_certified: true
})
};
fetch('https://api.exchange.coinbase.com/travel-rules', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.exchange.coinbase.com/travel-rules",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'address' => '<string>',
'originator_name' => '<string>',
'originator_country' => '<string>',
'vasp_id' => '<string>',
'vasp_country' => '<string>',
'lei_number' => '<string>',
'originator_address' => [
'address_1' => '<string>',
'address_2' => '<string>',
'address_3' => '<string>',
'city' => '<string>',
'state' => '<string>',
'country' => '<string>',
'postal_code' => '<string>'
],
'wallet_type' => 'UNKNOWN_WALLET_TYPE',
'is_self_certified' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"cb-access-key: <api-key>",
"cb-access-passphrase: <api-key>",
"cb-access-sign: <api-key>",
"cb-access-timestamp: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.exchange.coinbase.com/travel-rules"
payload := strings.NewReader("{\n \"address\": \"<string>\",\n \"originator_name\": \"<string>\",\n \"originator_country\": \"<string>\",\n \"vasp_id\": \"<string>\",\n \"vasp_country\": \"<string>\",\n \"lei_number\": \"<string>\",\n \"originator_address\": {\n \"address_1\": \"<string>\",\n \"address_2\": \"<string>\",\n \"address_3\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"<string>\",\n \"postal_code\": \"<string>\"\n },\n \"wallet_type\": \"UNKNOWN_WALLET_TYPE\",\n \"is_self_certified\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("cb-access-key", "<api-key>")
req.Header.Add("cb-access-passphrase", "<api-key>")
req.Header.Add("cb-access-sign", "<api-key>")
req.Header.Add("cb-access-timestamp", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.exchange.coinbase.com/travel-rules")
.header("cb-access-key", "<api-key>")
.header("cb-access-passphrase", "<api-key>")
.header("cb-access-sign", "<api-key>")
.header("cb-access-timestamp", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"address\": \"<string>\",\n \"originator_name\": \"<string>\",\n \"originator_country\": \"<string>\",\n \"vasp_id\": \"<string>\",\n \"vasp_country\": \"<string>\",\n \"lei_number\": \"<string>\",\n \"originator_address\": {\n \"address_1\": \"<string>\",\n \"address_2\": \"<string>\",\n \"address_3\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"<string>\",\n \"postal_code\": \"<string>\"\n },\n \"wallet_type\": \"UNKNOWN_WALLET_TYPE\",\n \"is_self_certified\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.exchange.coinbase.com/travel-rules")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["cb-access-key"] = '<api-key>'
request["cb-access-passphrase"] = '<api-key>'
request["cb-access-sign"] = '<api-key>'
request["cb-access-timestamp"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"address\": \"<string>\",\n \"originator_name\": \"<string>\",\n \"originator_country\": \"<string>\",\n \"vasp_id\": \"<string>\",\n \"vasp_country\": \"<string>\",\n \"lei_number\": \"<string>\",\n \"originator_address\": {\n \"address_1\": \"<string>\",\n \"address_2\": \"<string>\",\n \"address_3\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"<string>\",\n \"postal_code\": \"<string>\"\n },\n \"wallet_type\": \"UNKNOWN_WALLET_TYPE\",\n \"is_self_certified\": true\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"address": "<string>",
"originator_name": "<string>",
"originator_country": "<string>",
"vasp_id": "<string>",
"vasp_country": "<string>",
"lei_number": "<string>",
"originator_address": {
"address_1": "<string>",
"address_2": "<string>",
"address_3": "<string>",
"city": "<string>",
"state": "<string>",
"country": "<string>",
"postal_code": "<string>"
}
}{
"message": "<string>"
}{
"message": "<string>"
}Authorizations
Body
application/json
Crypto address where funds will be deposited from
Name of the originator of the funds
ISO 3166-1 alpha-2 formatted country code of the originator of the funds
VASP-uuid
ISO 3166-1 alpha-2 formatted country code of the VASP
Legal Entity Identifier (LEI) of the VASP
Show child attributes
Show child attributes
Available options:
UNKNOWN_WALLET_TYPE, EXCHANGE, SELF_HOSTED True if the user owns the wallet
Response
Travel rule identifier
Timestamp of when entry was added
Crypto address where funds will be deposited from
Name of the originator of the funds
country code (ISO 3166-1 alpha-2) of the originator of the funds
VASP-uuid
ISO 3166-1 alpha-2 formatted country code of the VASP
Legal Entity Identifier (LEI) of the VASP
Show child attributes
Show child attributes
Was this page helpful?
⌘I