Create Partner

post

https://app.bitgo-test.com/api/network/v1/enterprises/{enterpriseId}/partners

Create a new OES Partner. This endpoint allows enterprise users to add themselves as a partner in OES for clients to connect to.

Before calling this endpoint, a configuration for the partner must exist.

If a config is not present for the partner, the request will fail with a 422 error.

To initiate the creation of a partner config, please reach out to the Go Network Engineering team at: [email protected].

Error scenarios:

400: Invalid Request Error
Occurs when the request parameters are invalid or incomplete.
Examples: Empty string supplied for enterpriseId, invalid connection key schema.
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.
422: Unprocessable Entity Error
Returned when a required partner configuration is missing.
Examples: Partner configuration is missing.
500: Internal Server Error
Occurs when there's an unexpected error processing the request
Examples: Database connection failure, transient network error.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

enterpriseId

string

required

length ≥ 1

The enterprise identifier of the partner. This identifies the partner enterprise making the API request.

Body Params

name

string

required

length ≥ 1

The name of the partner. This will be displayed in the UI.

broker

boolean

required

Indicates whether the partner is a broker. If true, the partner can facilitate trading between clients. If false, the partner acts as an exchange with its own trading accounts.

institutionId

string

Optional UUID for the partner's institution record. Links the partner to an institution in the BitGo system.

institutionIdentifier

string

required

length ≥ 1

External identifier for the partner's institution. Provides an alternative way to identify the institution.

connectionKeySchema

string

enum

required

The key schema used for partner connections. Defines the structure and validation rules for connection keys.

Allowed:

clientDisputeWindowMinutes

number

Optional window (in minutes) for clients to dispute settlements. Defines how long after a settlement clients have to raise disputes. Null means no dispute window is configured.

topUpWindowMinutes

number

Optional window (in minutes) for topping up settlements. Defines the period during which a settlement can be topped up. Null means no top-up window is configured.

allocationPoliciesEnabled

boolean

Optional flag to enable or disable allocation policies for the partner. When true, policy evaluation features (allocation/deallocation) are enabled. When false or not provided, defaults to false for backward compatibility.

Responses

200OK

400Bad Request

401Unauthorized

403Forbidden

422Unprocessable Entity

500Internal Server Error