Ctrl+K

Create Partner

post/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.

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.

  • 500: Internal Server Error

  • Occurs when there's an unexpected error processing the request

  • Examples: Database connection failure, transient network error.

Path Parameters

  • enterpriseIdstringRequired
    The enterprise identifier of the partner. This identifies the partner enterprise making the API request.
    Min length: >= 1 characters

Request Body

name string required
The name of the partner. This identifies the partner in the BitGo system and will be displayed in the UI.
Min length: >= 1 characters
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
Optional external identifier for the partner's institution. Provides an alternative way to identify the institution.
Min length: >= 1 characters
connectionKeySchema string required
The key schema used for partner connections. Defines the structure and validation rules for connection keys.
Allowed values: token tokenAndSignature apiKeyAndSecret clearloop
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.

200 Response

partner object required
The complete partner object that was successfully created.
id string required
enterpriseId string required
Min length: >= 1 characters
trustOrg string required
Allowed values: BitGo Trust BitGo New York BitGo Germany BitGo Switzerland BitGo Europe ApS Frankfurt DE Trust BitGo Singapore BitGo Korea BitGo Custody MENA FZE BitGo Sister Trust 1
institutionId string
institutionIdentifier string
name string required
Min length: >= 1 characters
connectionKeySchema string required
Allowed values: token tokenAndSignature apiKeyAndSecret clearloop
createdAt string <date-time>required
Timestamp when the partner was created in the system.
updatedAt string <date-time>required
Timestamp of the most recent update to the partner record.
clientId string required
broker boolean required
active boolean required
settlementTransactionRouteId string
clientDisputeWindowMinutes number
topUpWindowMinutes number
publicKey string
Optional RSA public key associated with the partner. This key is used for secure communication and encrypting connection keys. If not supplied, encryption is not required for the partner.

400 Response

401 Response

error string required

403 Response

error string required

500 Response

error string required