REST API›Link›Link Accounts

GET

List destinations reachable from a Link-account source

Returns enterprise Link accounts the caller has link.account.view on that the given Link-account source can transfer to, split into two segments: off-chain (internalDestinations, with subtype entries) and on-chain (externalDestinations, no subtype). Same-hierarchy accounts are excluded from the external segment since they are already covered by the internal segment. The response envelope carries sourceSupportsOnChainWithdrawal to indicate whether BitGo-wallet / external-address destinations can also be used alongside the Link-account destinations returned here. Excludes accounts with status != active.

Path Params

  • enterpriseId string required
    Your enterprise id.

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

Query Params

  • sourceLinkAccountId string required
    The Link account id of the source.

    at least 1 characters

  • sourceAccountSubType string required
    The source's account subtype.

    at least 1 characters

  • genericAsset string required
    Network-agnostic asset family.

    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
OK

Response Body

object

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

Given a Link-account source, returns the destinations it can transfer to.

Segments:

  • internalDestinations — off-chain reachable accounts (same-venue), grouped by account with subtype entries. May be empty when no same-venue rail qualifies.
  • externalDestinations — on-chain reachable accounts. May be cross-venue or same- venue but in a different account hierarchy from the source. Same-hierarchy entries are suppressed since they're already covered by the internal segment.

sourceSupportsOnChainWithdrawal indicates whether BitGo wallet / external-address destinations can also be used alongside the Link-account destinations returned here. It is a property of the source venue, not of the caller's permission scope — always present, even when the caller's link.account.view scope yields no Link-account rows.

Not paginated — the candidate set (enterprise Link accounts at a small number of candidate venues) is bounded and returned in full in one response.

  • internalDestinations object required
    internalDestinations object
    • 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
      • accountSubTypes array of objects required
        accountSubTypes object
        • accountSubType string required

          at least 1 characters

        • accountSubTypeLabel string

          at least 1 characters

      • 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
        • accountSubTypes array of objects required
          accountSubTypes object
          • accountSubType string required

            at least 1 characters

          • accountSubTypeLabel string

            at least 1 characters

  • externalDestinations object required
    externalDestinations object
    • 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
  • sourceSupportsOnChainWithdrawal 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
404
Not Found

Response Body

object

  • errorName string required
  • error string required
500
Internal Server Error

Response Body

object

  • errorName string required
  • error string required