Skip to main content
POST
/
v1
/
portfolios
/
{portfolio_id}
/
transactions
/
{transaction_id}
/
travel_rule
/
deposit
Submit Deposit Travel Rule Data
curl --request POST \
  --url https://api.prime.coinbase.com/v1/portfolios/{portfolio_id}/transactions/{transaction_id}/travel_rule/deposit \
  --header 'Content-Type: application/json' \
  --data '
{
  "originator": {
    "name": "<string>",
    "natural_person_name": {
      "first_name": "<string>",
      "middle_name": "<string>",
      "last_name": "<string>"
    },
    "address": {
      "address_1": "<string>",
      "address_2": "<string>",
      "address_3": "<string>",
      "city": "<string>",
      "state": "<string>",
      "country_code": "<string>",
      "postal_code": "<string>"
    },
    "wallet_type": "TRAVEL_RULE_WALLET_TYPE_UNSPECIFIED",
    "vasp_id": "<string>",
    "vasp_name": "<string>",
    "personal_id": "<string>",
    "date_of_birth": {
      "year": 123,
      "month": 123,
      "day": 123
    },
    "telephone_number": "<string>",
    "account_id": "<string>"
  },
  "beneficiary": {
    "name": "<string>",
    "natural_person_name": {
      "first_name": "<string>",
      "middle_name": "<string>",
      "last_name": "<string>"
    },
    "address": {
      "address_1": "<string>",
      "address_2": "<string>",
      "address_3": "<string>",
      "city": "<string>",
      "state": "<string>",
      "country_code": "<string>",
      "postal_code": "<string>"
    },
    "wallet_type": "TRAVEL_RULE_WALLET_TYPE_UNSPECIFIED",
    "vasp_id": "<string>",
    "vasp_name": "<string>",
    "personal_id": "<string>",
    "date_of_birth": {
      "year": 123,
      "month": 123,
      "day": 123
    },
    "telephone_number": "<string>",
    "account_id": "<string>"
  },
  "is_self": true,
  "opt_out_of_ownership_verification": true
}
'
import requests

url = "https://api.prime.coinbase.com/v1/portfolios/{portfolio_id}/transactions/{transaction_id}/travel_rule/deposit"

payload = {
    "originator": {
        "name": "<string>",
        "natural_person_name": {
            "first_name": "<string>",
            "middle_name": "<string>",
            "last_name": "<string>"
        },
        "address": {
            "address_1": "<string>",
            "address_2": "<string>",
            "address_3": "<string>",
            "city": "<string>",
            "state": "<string>",
            "country_code": "<string>",
            "postal_code": "<string>"
        },
        "wallet_type": "TRAVEL_RULE_WALLET_TYPE_UNSPECIFIED",
        "vasp_id": "<string>",
        "vasp_name": "<string>",
        "personal_id": "<string>",
        "date_of_birth": {
            "year": 123,
            "month": 123,
            "day": 123
        },
        "telephone_number": "<string>",
        "account_id": "<string>"
    },
    "beneficiary": {
        "name": "<string>",
        "natural_person_name": {
            "first_name": "<string>",
            "middle_name": "<string>",
            "last_name": "<string>"
        },
        "address": {
            "address_1": "<string>",
            "address_2": "<string>",
            "address_3": "<string>",
            "city": "<string>",
            "state": "<string>",
            "country_code": "<string>",
            "postal_code": "<string>"
        },
        "wallet_type": "TRAVEL_RULE_WALLET_TYPE_UNSPECIFIED",
        "vasp_id": "<string>",
        "vasp_name": "<string>",
        "personal_id": "<string>",
        "date_of_birth": {
            "year": 123,
            "month": 123,
            "day": 123
        },
        "telephone_number": "<string>",
        "account_id": "<string>"
    },
    "is_self": True,
    "opt_out_of_ownership_verification": True
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    originator: {
      name: '<string>',
      natural_person_name: {first_name: '<string>', middle_name: '<string>', last_name: '<string>'},
      address: {
        address_1: '<string>',
        address_2: '<string>',
        address_3: '<string>',
        city: '<string>',
        state: '<string>',
        country_code: '<string>',
        postal_code: '<string>'
      },
      wallet_type: 'TRAVEL_RULE_WALLET_TYPE_UNSPECIFIED',
      vasp_id: '<string>',
      vasp_name: '<string>',
      personal_id: '<string>',
      date_of_birth: {year: 123, month: 123, day: 123},
      telephone_number: '<string>',
      account_id: '<string>'
    },
    beneficiary: {
      name: '<string>',
      natural_person_name: {first_name: '<string>', middle_name: '<string>', last_name: '<string>'},
      address: {
        address_1: '<string>',
        address_2: '<string>',
        address_3: '<string>',
        city: '<string>',
        state: '<string>',
        country_code: '<string>',
        postal_code: '<string>'
      },
      wallet_type: 'TRAVEL_RULE_WALLET_TYPE_UNSPECIFIED',
      vasp_id: '<string>',
      vasp_name: '<string>',
      personal_id: '<string>',
      date_of_birth: {year: 123, month: 123, day: 123},
      telephone_number: '<string>',
      account_id: '<string>'
    },
    is_self: true,
    opt_out_of_ownership_verification: true
  })
};

fetch('https://api.prime.coinbase.com/v1/portfolios/{portfolio_id}/transactions/{transaction_id}/travel_rule/deposit', 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.prime.coinbase.com/v1/portfolios/{portfolio_id}/transactions/{transaction_id}/travel_rule/deposit",
  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([
    'originator' => [
        'name' => '<string>',
        'natural_person_name' => [
                'first_name' => '<string>',
                'middle_name' => '<string>',
                'last_name' => '<string>'
        ],
        'address' => [
                'address_1' => '<string>',
                'address_2' => '<string>',
                'address_3' => '<string>',
                'city' => '<string>',
                'state' => '<string>',
                'country_code' => '<string>',
                'postal_code' => '<string>'
        ],
        'wallet_type' => 'TRAVEL_RULE_WALLET_TYPE_UNSPECIFIED',
        'vasp_id' => '<string>',
        'vasp_name' => '<string>',
        'personal_id' => '<string>',
        'date_of_birth' => [
                'year' => 123,
                'month' => 123,
                'day' => 123
        ],
        'telephone_number' => '<string>',
        'account_id' => '<string>'
    ],
    'beneficiary' => [
        'name' => '<string>',
        'natural_person_name' => [
                'first_name' => '<string>',
                'middle_name' => '<string>',
                'last_name' => '<string>'
        ],
        'address' => [
                'address_1' => '<string>',
                'address_2' => '<string>',
                'address_3' => '<string>',
                'city' => '<string>',
                'state' => '<string>',
                'country_code' => '<string>',
                'postal_code' => '<string>'
        ],
        'wallet_type' => 'TRAVEL_RULE_WALLET_TYPE_UNSPECIFIED',
        'vasp_id' => '<string>',
        'vasp_name' => '<string>',
        'personal_id' => '<string>',
        'date_of_birth' => [
                'year' => 123,
                'month' => 123,
                'day' => 123
        ],
        'telephone_number' => '<string>',
        'account_id' => '<string>'
    ],
    'is_self' => true,
    'opt_out_of_ownership_verification' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$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.prime.coinbase.com/v1/portfolios/{portfolio_id}/transactions/{transaction_id}/travel_rule/deposit"

	payload := strings.NewReader("{\n  \"originator\": {\n    \"name\": \"<string>\",\n    \"natural_person_name\": {\n      \"first_name\": \"<string>\",\n      \"middle_name\": \"<string>\",\n      \"last_name\": \"<string>\"\n    },\n    \"address\": {\n      \"address_1\": \"<string>\",\n      \"address_2\": \"<string>\",\n      \"address_3\": \"<string>\",\n      \"city\": \"<string>\",\n      \"state\": \"<string>\",\n      \"country_code\": \"<string>\",\n      \"postal_code\": \"<string>\"\n    },\n    \"wallet_type\": \"TRAVEL_RULE_WALLET_TYPE_UNSPECIFIED\",\n    \"vasp_id\": \"<string>\",\n    \"vasp_name\": \"<string>\",\n    \"personal_id\": \"<string>\",\n    \"date_of_birth\": {\n      \"year\": 123,\n      \"month\": 123,\n      \"day\": 123\n    },\n    \"telephone_number\": \"<string>\",\n    \"account_id\": \"<string>\"\n  },\n  \"beneficiary\": {\n    \"name\": \"<string>\",\n    \"natural_person_name\": {\n      \"first_name\": \"<string>\",\n      \"middle_name\": \"<string>\",\n      \"last_name\": \"<string>\"\n    },\n    \"address\": {\n      \"address_1\": \"<string>\",\n      \"address_2\": \"<string>\",\n      \"address_3\": \"<string>\",\n      \"city\": \"<string>\",\n      \"state\": \"<string>\",\n      \"country_code\": \"<string>\",\n      \"postal_code\": \"<string>\"\n    },\n    \"wallet_type\": \"TRAVEL_RULE_WALLET_TYPE_UNSPECIFIED\",\n    \"vasp_id\": \"<string>\",\n    \"vasp_name\": \"<string>\",\n    \"personal_id\": \"<string>\",\n    \"date_of_birth\": {\n      \"year\": 123,\n      \"month\": 123,\n      \"day\": 123\n    },\n    \"telephone_number\": \"<string>\",\n    \"account_id\": \"<string>\"\n  },\n  \"is_self\": true,\n  \"opt_out_of_ownership_verification\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	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.prime.coinbase.com/v1/portfolios/{portfolio_id}/transactions/{transaction_id}/travel_rule/deposit")
  .header("Content-Type", "application/json")
  .body("{\n  \"originator\": {\n    \"name\": \"<string>\",\n    \"natural_person_name\": {\n      \"first_name\": \"<string>\",\n      \"middle_name\": \"<string>\",\n      \"last_name\": \"<string>\"\n    },\n    \"address\": {\n      \"address_1\": \"<string>\",\n      \"address_2\": \"<string>\",\n      \"address_3\": \"<string>\",\n      \"city\": \"<string>\",\n      \"state\": \"<string>\",\n      \"country_code\": \"<string>\",\n      \"postal_code\": \"<string>\"\n    },\n    \"wallet_type\": \"TRAVEL_RULE_WALLET_TYPE_UNSPECIFIED\",\n    \"vasp_id\": \"<string>\",\n    \"vasp_name\": \"<string>\",\n    \"personal_id\": \"<string>\",\n    \"date_of_birth\": {\n      \"year\": 123,\n      \"month\": 123,\n      \"day\": 123\n    },\n    \"telephone_number\": \"<string>\",\n    \"account_id\": \"<string>\"\n  },\n  \"beneficiary\": {\n    \"name\": \"<string>\",\n    \"natural_person_name\": {\n      \"first_name\": \"<string>\",\n      \"middle_name\": \"<string>\",\n      \"last_name\": \"<string>\"\n    },\n    \"address\": {\n      \"address_1\": \"<string>\",\n      \"address_2\": \"<string>\",\n      \"address_3\": \"<string>\",\n      \"city\": \"<string>\",\n      \"state\": \"<string>\",\n      \"country_code\": \"<string>\",\n      \"postal_code\": \"<string>\"\n    },\n    \"wallet_type\": \"TRAVEL_RULE_WALLET_TYPE_UNSPECIFIED\",\n    \"vasp_id\": \"<string>\",\n    \"vasp_name\": \"<string>\",\n    \"personal_id\": \"<string>\",\n    \"date_of_birth\": {\n      \"year\": 123,\n      \"month\": 123,\n      \"day\": 123\n    },\n    \"telephone_number\": \"<string>\",\n    \"account_id\": \"<string>\"\n  },\n  \"is_self\": true,\n  \"opt_out_of_ownership_verification\": true\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.prime.coinbase.com/v1/portfolios/{portfolio_id}/transactions/{transaction_id}/travel_rule/deposit")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"originator\": {\n    \"name\": \"<string>\",\n    \"natural_person_name\": {\n      \"first_name\": \"<string>\",\n      \"middle_name\": \"<string>\",\n      \"last_name\": \"<string>\"\n    },\n    \"address\": {\n      \"address_1\": \"<string>\",\n      \"address_2\": \"<string>\",\n      \"address_3\": \"<string>\",\n      \"city\": \"<string>\",\n      \"state\": \"<string>\",\n      \"country_code\": \"<string>\",\n      \"postal_code\": \"<string>\"\n    },\n    \"wallet_type\": \"TRAVEL_RULE_WALLET_TYPE_UNSPECIFIED\",\n    \"vasp_id\": \"<string>\",\n    \"vasp_name\": \"<string>\",\n    \"personal_id\": \"<string>\",\n    \"date_of_birth\": {\n      \"year\": 123,\n      \"month\": 123,\n      \"day\": 123\n    },\n    \"telephone_number\": \"<string>\",\n    \"account_id\": \"<string>\"\n  },\n  \"beneficiary\": {\n    \"name\": \"<string>\",\n    \"natural_person_name\": {\n      \"first_name\": \"<string>\",\n      \"middle_name\": \"<string>\",\n      \"last_name\": \"<string>\"\n    },\n    \"address\": {\n      \"address_1\": \"<string>\",\n      \"address_2\": \"<string>\",\n      \"address_3\": \"<string>\",\n      \"city\": \"<string>\",\n      \"state\": \"<string>\",\n      \"country_code\": \"<string>\",\n      \"postal_code\": \"<string>\"\n    },\n    \"wallet_type\": \"TRAVEL_RULE_WALLET_TYPE_UNSPECIFIED\",\n    \"vasp_id\": \"<string>\",\n    \"vasp_name\": \"<string>\",\n    \"personal_id\": \"<string>\",\n    \"date_of_birth\": {\n      \"year\": 123,\n      \"month\": 123,\n      \"day\": 123\n    },\n    \"telephone_number\": \"<string>\",\n    \"account_id\": \"<string>\"\n  },\n  \"is_self\": true,\n  \"opt_out_of_ownership_verification\": true\n}"

response = http.request(request)
puts response.read_body
{
  "ownership_verification_required": true
}

Path Parameters

​
portfolio_id
string
required

The portfolio ID that owns the transaction

​
transaction_id
string
required

The transaction ID associated with the entry

Body

application/json
​
originator
object

Represents a party in a travel rule transfer (originator or beneficiary).

​
beneficiary
object

Represents a party in a travel rule transfer (originator or beneficiary).

​
is_self
boolean
​
opt_out_of_ownership_verification
boolean

Response

200 - application/json

A successful response.

​
ownership_verification_required
boolean
required