GET

List Partners

Lists all OES Partners associated with the specified enterprise. Returns a collection of partners with information required to connect to them.

Error scenarios:

400: Invalid Request Error
Occurs when the request parameters are invalid or incomplete.
Examples: Empty string supplied for enterpriseId.
401: Authentication Error
Occurs when the request is not authorized.
Examples: Caller is not a member of the enterprise.
403: Permission Denied Error
Occurs when the authenticated partner doesn't have access to create a partner.
Examples: Enterprise does not have OES license.
500: Internal Server Error
Occurs when there's an unexpected error processing the request
Examples: Database connection failure, transient network error.

Requires access token scope: settlement_network_read

Path Params

enterpriseId string required

The enterprise ID of the client making the request.

at least 1 characters

Query Params

pageNumber string integer

The page number (integer) you wish to fetch. When provided, the API will skip pageSize * pageNumber records. Page numbers are zero-based, so the first page is 0. If not provided, defaults to 0.
pageSize string

The page size (integer) you wish to fetch. When provided, the API will return at most pageSize records per page. If not provided, a default page size defined by the server will be used.
ids array of strings

Filter by specific partner IDs. When provided, only partners with these IDs will be returned.
names array of strings

Filter by partner names. When provided, only partners with these names will be returned.
institutionIds array of strings

Filter by institution IDs. When provided, only partners linked to these institutions will be returned.
institutionIdentifiers array of strings

Filter by institution identifiers. When provided, only partners with these institution identifiers will be returned.
active boolean

Filter by active status. When true, only active partners will be returned. When false, only inactive partners will be returned. When not provided, partners of any status will be returned.
filterByTrustOrg boolean

Filter by trust organization. When provided, only partners belonging to this trust organization will be returned.
allocationPoliciesEnabled boolean

Filter by allocation policies enabled. When true, only partners with allocation policies enabled will be returned. When false, only partners with allocation policies disabled will be returned. When not provided, partners with any allocation policies status will be returned.

Responses

200

Response Body

object

partners array of objects required
partners object
- id string required
  
  Unique identifier for the partner.
- name string required
  
  Display name of the partner.
  
  at least 1 characters
- institutionId string
  
  Optional identifier linking the partner to an institution in external systems.
- institutionIdentifier string required
  
  Optional string identifier for the institution.
  
  at least 1 characters
- connectionKeySchema string enum required
  
  Schema defining which connection request schema is required for this partner. Can be 'token', 'tokenAndSignature', 'apiKeyAndSecret', or 'clearloop'.
  
  tokentokenAndSignatureapiKeyAndSecretclearloop
- active boolean required
  
  Boolean flag indicating whether the partner is currently active in the system.
- settlementTransactionRouteId string
  
  Optional identifier for the settlement transaction route associated with this partner.
- publicKey string
  
  Optional RSA public key used for secure communication with the partner.
- enterpriseId string
  
  Enterprise ID associated with this partner, if any.
- clientDisputeWindowMinutes number
  
  Time window in minutes during which clients can dispute transactions.
- topUpWindowMinutes number
  
  Time window in minutes after which dispute window ends for processing top-up operations.
- trustOrg string enum required
  
  Identifier for the trust organization this partner belongs to. Used for filtering and categorization of partners.
  
  BitGo TrustBitGo New YorkBitGo GermanyBitGo SwitzerlandBitGo Europe ApSFrankfurt DE TrustBitGo SingaporeBitGo KoreaBitGo Custody MENA FZEBitGo IndiaBitGo Sister Trust 1
- stablePartner boolean required
  
  Flag indicating whether the partner has demonstrated operational stability. Used when partner is initially launched to demonstrate that the partner is still in beta and not yet stable.

400

Bad Request

No response body

401

Unauthorized

Response Body

object

error string required

403

Forbidden

Response Body

object

error string required

500

Internal Server Error

Response Body

object

error string required

curl --request GET \ --url 'https://app.bitgo-test.com/api/network/v1/enterprises/enterpriseId/partners&pageNumber=string&pageSize=string&ids=&names=&institutionIds=&institutionIdentifiers=&active=true&filterByTrustOrg=true&allocationPoliciesEnabled=true' \ --header 'accept: application/json' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

const url = 'https://app.bitgo-test.com/api/network/v1/enterprises/enterpriseId/partners&pageNumber=string&pageSize=string&ids=&names=&institutionIds=&institutionIdentifiers=&active=true&filterByTrustOrg=true&allocationPoliciesEnabled=true'; const options = {method: 'GET', headers: {accept: 'application/json', 'Authorization': 'Bearer YOUR_ACCESS_TOKEN'}}; 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/network/v1/enterprises/enterpriseId/partners&pageNumber=string&pageSize=string&ids=&names=&institutionIds=&institutionIdentifiers=&active=true&filterByTrustOrg=true&allocationPoliciesEnabled=true") 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' 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/network/v1/enterprises/enterpriseId/partners&pageNumber=string&pageSize=string&ids=&names=&institutionIds=&institutionIdentifiers=&active=true&filterByTrustOrg=true&allocationPoliciesEnabled=true', [ 'headers' => [ 'accept' => 'application/json', 'Authorization' => 'Bearer YOUR_ACCESS_TOKEN', ], ]); echo $response->getBody();

import requests url = "https://app.bitgo-test.com/api/network/v1/enterprises/enterpriseId/partners&pageNumber=string&pageSize=string&ids=&names=&institutionIds=&institutionIdentifiers=&active=true&filterByTrustOrg=true&allocationPoliciesEnabled=true" headers = { "accept": "application/json", "Authorization": "Bearer YOUR_ACCESS_TOKEN" } response = requests.get(url, headers=headers) print(response.text)

{ "partners": [ { "id": "string", "name": "string", "institutionId": "string", "institutionIdentifier": "string", "connectionKeySchema": "token", "active": true, "settlementTransactionRouteId": "string", "publicKey": "string", "enterpriseId": "string", "clientDisputeWindowMinutes": 0, "topUpWindowMinutes": 0, "trustOrg": "BitGo Trust", "stablePartner": true } ] }