GET

List on-chain destinations for a given asset/network

Mirrors VAS's GET /on-chain-destinations. Given a (genericAsset, network) pair, returns enterprise Link accounts the caller has link.account.view on that can on-chain-deposit at that asset/network. Has no source — used by the BitGo-wallet source flow, where the source has no Link venue context. Excludes accounts with status != active.

Path Params

enterpriseId string required

Your enterprise id.

at least 1 characters · matches ^[0-9a-f]{32}$

Query Params

genericAsset string required

Network-agnostic asset family.

at least 1 characters
network string required

Network identifier.

at least 1 characters
name string

Filter destinations by name (case-insensitive partial match).

at least 1 characters

Header Params

user-id string required

User id of the user making the request.

at least 1 characters

Responses

200

Response Body

object

Response for GET /api/link/v1/enterprises/{enterpriseId}/on-chain-destinations.

Mirrors VAS's GET /on-chain-destinations — given a (genericAsset, network) pair, return the enterprise Link accounts the caller can link.account.view that can on-chain-deposit at that asset/network. Has no source, so no hierarchy suppression and no sourceSupportsOnChainWithdrawal flag.

Reuses LinkExternalDestinationRow from /transfer-destinations — on-chain destinations are subtype-less in both responses (the receiving venue routes the deposit internally).

Not paginated — same rationale as /transfer-destinations.

accounts array of objects required
accounts object
- id string required
- name string required
  
  at least 1 characters
- venueId string required
  
  at least 1 characters
- venueName string required
  
  at least 1 characters
- whitelistingEnabled boolean required
- subAccounts array of objects
  subAccounts object
  - id string required
  - name string required
    
    at least 1 characters
  - venueId string required
    
    at least 1 characters
  - venueName string required
    
    at least 1 characters
  - whitelistingEnabled boolean required

400

Bad Request

No response body

401

Unauthorized

Response Body

object

errorName string required
error string required

403

Forbidden

Response Body

object

errorName string required
error string required

500

Internal Server Error

Response Body

object

errorName string required
error string required

curl --request GET \ --url 'https://app.bitgo-test.com/api/link/v1/enterprises/enterpriseId/on-chain-destinations?genericAsset=usdc&network=sol&name=My Coinbase' \ --header 'accept: application/json' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ --header 'user-id: string'

const url = 'https://app.bitgo-test.com/api/link/v1/enterprises/enterpriseId/on-chain-destinations?genericAsset=usdc&network=sol&name=My Coinbase'; const options = {method: 'GET', headers: {accept: 'application/json', 'Authorization': 'Bearer YOUR_ACCESS_TOKEN', 'user-id': 'string'}}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error(err));

require 'uri' require 'net/http' url = URI("https://app.bitgo-test.com/api/link/v1/enterprises/enterpriseId/on-chain-destinations?genericAsset=usdc&network=sol&name=My Coinbase") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["accept"] = 'application/json' request["Authorization"] = 'Bearer YOUR_ACCESS_TOKEN' request["user-id"] = 'string' response = http.request(request) puts response.read_body

<?php require_once('vendor/autoload.php'); $client = new \GuzzleHttp\Client(); $response = $client->request('GET', 'https://app.bitgo-test.com/api/link/v1/enterprises/enterpriseId/on-chain-destinations?genericAsset=usdc&network=sol&name=My Coinbase', [ 'headers' => [ 'accept' => 'application/json', 'Authorization' => 'Bearer YOUR_ACCESS_TOKEN', 'user-id' => 'string', ], ]); echo $response->getBody();

import requests url = "https://app.bitgo-test.com/api/link/v1/enterprises/enterpriseId/on-chain-destinations?genericAsset=usdc&network=sol&name=My Coinbase" headers = { "accept": "application/json", "Authorization": "Bearer YOUR_ACCESS_TOKEN", "user-id": "string" } response = requests.get(url, headers=headers) print(response.text)

{ "accounts": [ { "id": "string", "name": "string", "venueId": "string", "venueName": "string", "whitelistingEnabled": true, "subAccounts": [ { "id": "string", "name": "string", "venueId": "string", "venueName": "string", "whitelistingEnabled": true } ] } ] }