Create Address Book Entry
Copy
Ask AI
curl --request POST \
--url https://api.prime.coinbase.com/v1/portfolios/{portfolio_id}/address_book \
--header 'Content-Type: application/json' \
--data '
{
"address": "<string>",
"currency_symbol": "<string>",
"name": "<string>",
"account_identifier": "<string>",
"chain_ids": [
"<string>"
],
"travel_rule_data": {
"id": "<string>",
"blockchain_address": {
"address": "<string>",
"account_identifier": "<string>",
"network": {
"id": "<string>",
"type": "<string>"
}
},
"originator": {
"name": "<string>",
"detailed_address": {
"address_1": "<string>",
"address_2": "<string>",
"address_3": "<string>",
"city": "<string>",
"state": "<string>",
"country_code": "<string>",
"postal_code": "<string>"
},
"natural_person_name": {
"first_name": "<string>",
"middle_name": "<string>",
"last_name": "<string>"
},
"date_of_birth": {
"year": 123,
"month": 123,
"day": 123
},
"telephone_number": "<string>"
},
"beneficiary": {
"name": "<string>",
"detailed_address": {
"address_1": "<string>",
"address_2": "<string>",
"address_3": "<string>",
"city": "<string>",
"state": "<string>",
"country_code": "<string>",
"postal_code": "<string>"
},
"natural_person_name": {
"first_name": "<string>",
"middle_name": "<string>",
"last_name": "<string>"
},
"date_of_birth": {
"year": 123,
"month": 123,
"day": 123
},
"telephone_number": "<string>"
},
"vasp": {
"id": "<string>",
"country_code": "<string>",
"lei_number": "<string>"
},
"wallet_details": {
"wallet_type": "TRAVEL_RULE_WALLET_TYPE_UNSPECIFIED",
"wallet_address": {
"address": "<string>",
"account_identifier": "<string>",
"network": {
"id": "<string>",
"type": "<string>"
}
}
},
"transfer_purpose": "<string>",
"is_self_certified": true,
"is_intermediary": true,
"is_self": true
}
}
'Copy
Ask AI
{
"activity_type": "ACTIVITY_TYPE_GOVERNANCE_VOTE",
"num_approvals_remaining": 123,
"activity_id": "<string>"
}Address Book
Create Address Book Entry
Creates an entry for a portfolio’s trusted addresses.
POST
/
v1
/
portfolios
/
{portfolio_id}
/
address_book
Create Address Book Entry
Copy
Ask AI
curl --request POST \
--url https://api.prime.coinbase.com/v1/portfolios/{portfolio_id}/address_book \
--header 'Content-Type: application/json' \
--data '
{
"address": "<string>",
"currency_symbol": "<string>",
"name": "<string>",
"account_identifier": "<string>",
"chain_ids": [
"<string>"
],
"travel_rule_data": {
"id": "<string>",
"blockchain_address": {
"address": "<string>",
"account_identifier": "<string>",
"network": {
"id": "<string>",
"type": "<string>"
}
},
"originator": {
"name": "<string>",
"detailed_address": {
"address_1": "<string>",
"address_2": "<string>",
"address_3": "<string>",
"city": "<string>",
"state": "<string>",
"country_code": "<string>",
"postal_code": "<string>"
},
"natural_person_name": {
"first_name": "<string>",
"middle_name": "<string>",
"last_name": "<string>"
},
"date_of_birth": {
"year": 123,
"month": 123,
"day": 123
},
"telephone_number": "<string>"
},
"beneficiary": {
"name": "<string>",
"detailed_address": {
"address_1": "<string>",
"address_2": "<string>",
"address_3": "<string>",
"city": "<string>",
"state": "<string>",
"country_code": "<string>",
"postal_code": "<string>"
},
"natural_person_name": {
"first_name": "<string>",
"middle_name": "<string>",
"last_name": "<string>"
},
"date_of_birth": {
"year": 123,
"month": 123,
"day": 123
},
"telephone_number": "<string>"
},
"vasp": {
"id": "<string>",
"country_code": "<string>",
"lei_number": "<string>"
},
"wallet_details": {
"wallet_type": "TRAVEL_RULE_WALLET_TYPE_UNSPECIFIED",
"wallet_address": {
"address": "<string>",
"account_identifier": "<string>",
"network": {
"id": "<string>",
"type": "<string>"
}
}
},
"transfer_purpose": "<string>",
"is_self_certified": true,
"is_intermediary": true,
"is_self": true
}
}
'Copy
Ask AI
{
"activity_type": "ACTIVITY_TYPE_GOVERNANCE_VOTE",
"num_approvals_remaining": 123,
"activity_id": "<string>"
}Use the Prime SDK or CLI to test this endpoint by following the quickstart guide and running with the following examples
For more information, please visit the Prime Java SDK.For more information, please visit the Prime .NET SDK.For more information, please visit the Prime Go SDK.For more information, please visit the Prime Python SDK.For more information, please visit the Prime CLI.For more information, please visit the Prime TS SDK.
- Java
- .NET
- Go
- Python
- CLI
- TS/JS
Report incorrect code
Copy
Ask AI
AddressBookService addressBookService = PrimeServiceFactory.createAddressBookService(client);
CreateAddressBookEntryRequest request = new CreateAddressBookEntryRequest.Builder("portfolio_id")
.accountIdentifier("account_identifier")
.address("address")
.currencySymbol("currency_symbol")
.name("name")
.build();
CreateAddressBookEntryResponse response = addressBookService.createAddressBookEntry(request);
Report incorrect code
Copy
Ask AI
var addressBookService = new AddressBookService(client);
var request = new CreateAddressBookEntryRequest("portfolio_id")
{
Address = "address",
CurrencySymbol = "currency_symbol",
Name = "name",
AccountIdentifier = "account_identifier",
};
var response = addressBookService.CreateAddressBookEntry(request);
Report incorrect code
Copy
Ask AI
addressBookService := addressbook.NewAddressBookService(client)
request := &addressbook.CreateAddressBookEntryRequest{
PortfolioId: "portfolio-id",
Address: "address",
Symbol: "currency_symbol",
Name: "name",
AccountIdentifier: "account_identifier",
}
response, err := addressBookService.CreateAddressBookEntry(context.Background(), request)
Report incorrect code
Copy
Ask AI
prime_client = PrimeClient(credentials)
request = CreateAddressBookEntryRequest(
portfolio_id="portfolio_id",
address="address",
currency_symbol="currency_symbol",
name="name",
account_identifier="account_identifier",
)
response = prime_client.get_address_book(request)
Report incorrect code
Copy
Ask AI
primectl create-address-book-entry --help
Report incorrect code
Copy
Ask AI
const addressBooksService = new AddressBooksService(client);
addressBooksService.createAddressBook({
portfolioId: 'PORTFOLIO_ID_HERE',
address: 'ADDRESS_HERE',
currencySymbol: 'ETH',
name: 'XYZ Address',
}).then(async (response) => {
console.log('Address Book: ', response);
})
Path Parameters
Portfolio ID
Body
application/json
Crypto address to add
Currency symbol of address to add
Name of address book entry
Account Identifier (memo/destination tag)
List of compatible chain IDs for the address, empty for Solana
Travel Rule Entry for sending addresses.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
The address on the network
The account identifier (used on some chains to distinguish accounts using the same address)
Represents one of the Transmittal Parties involved in a Travel Rule transfer, either originator or beneficiary.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Represents one of the Transmittal Parties involved in a Travel Rule transfer, either originator or beneficiary.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Details about the custody wallet used in the transfer.
Show child attributes
Show child attributes
- TRAVEL_RULE_WALLET_TYPE_UNSPECIFIED: Default unspecified wallet type
- TRAVEL_RULE_WALLET_TYPE_VASP: Centralized exchange wallet
- TRAVEL_RULE_WALLET_TYPE_SELF_CUSTODIED: Self-hosted/custodial wallet
Available options:
TRAVEL_RULE_WALLET_TYPE_UNSPECIFIED, TRAVEL_RULE_WALLET_TYPE_VASP, TRAVEL_RULE_WALLET_TYPE_SELF_CUSTODIED Show child attributes
Show child attributes
The address on the network
The account identifier (used on some chains to distinguish accounts using the same address)
Response
200 - application/json
A successful response.
Available options:
ACTIVITY_TYPE_GOVERNANCE_VOTE, ACTIVITY_TYPE_INVITATION, ACTIVITY_TYPE_WALLET_CHANGE, ACTIVITY_TYPE_API_KEY_CHANGE, ACTIVITY_TYPE_SETTINGS_CHANGE, ACTIVITY_TYPE_BILLING_PREFERENCE_CHANGE, ACTIVITY_TYPE_PAYMENT_METHOD_CHANGE, ACTIVITY_TYPE_WITHDRAWAL, ACTIVITY_TYPE_DEPOSIT, ACTIVITY_TYPE_CREATE_WALLET, ACTIVITY_TYPE_REMOVE_WALLET, ACTIVITY_TYPE_UPDATE_WALLET, ACTIVITY_TYPE_CAST_VOTE, ACTIVITY_TYPE_ENABLE_VOTING, ACTIVITY_TYPE_STAKE, ACTIVITY_TYPE_UNSTAKE, ACTIVITY_TYPE_CHANGE_VALIDATOR, ACTIVITY_TYPE_RESTAKE, ACTIVITY_TYPE_ADDRESS_BOOK, ACTIVITY_TYPE_TEAM_MEMBERS, ACTIVITY_TYPE_BILLING, ACTIVITY_TYPE_SECURITY, ACTIVITY_TYPE_API, ACTIVITY_TYPE_SETTINGS, ACTIVITY_TYPE_SMART_CONTRACT, ACTIVITY_TYPE_USER_CHANGE_REQUEST_NO_PAS, ACTIVITY_TYPE_WEB3_TRANSACTION, ACTIVITY_TYPE_WEB3_MESSAGE, ACTIVITY_TYPE_CLAIM_REWARDS Was this page helpful?
⌘I