Connected Accounts

Get connected account

Retrieve detailed information about a specific connected account by ID.

get/connected_accounts/{accountId}

Request

Path parameters

accountIdstring required

The ID of the account to fetch.

Response

Account response

idstring required

Unique identifier of the connected account.

namestring required

Human-readable name of the connected account.

providerIdstring required

The ID of the venue the account belongs to.

status'WAITING_FOR_APPROVAL' | 'APPROVED' | 'REJECTED' | 'CANCELLED' | 'FAILED' required
parentIdstring

The ID of the parent main account, if this is a sub account.

apiKeystring

The API key identifier used to connect this account.

providerAccountNamestring

The account name provided by the provider.

accountType'EXCHANGE' | 'FIAT' | 'CONNECTED_ACCOUNT' required
subAccountsIdsstring[]

IDs of sub-accounts associated with this connected account.

Example response

{
  "id": "acc-123456",
  "name": "Main Venue Account",
  "providerId": "BRIDGE",
  "totalBalance": {
    "amount": "1201.15",
    "denominatedAssetId": "ea6c3cb7-355a-4ee3-82ff-267c69970214",
    "hasFullAssetCoverage": true
  },
  "manifest": {
    "assetTypes": [],
    "capabilities": [
      "WITHDRAWALS"
    ]
  },
  "parentId": "acc-parent-001",
  "apiKey": "rk_live_abc123",
  "providerAccountName": "Main Account",
  "accountType": "CONNECTED_ACCOUNT",
  "subAccountsIds": [
    "acc-sub-001",
    "acc-sub-002"
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.