REST API›Settle (Off Exchange)›Onboarding

POST

Create Partner

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: go-network-eng@bitgo.com.

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.

Requires access token scopes: settlement_network_read, settlement_network_write

Path Params

  • enterpriseId string required
    The enterprise identifier of the partner. This identifies the partner enterprise making the API request.

    at least 1 characters

Body Params

object

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

    at least 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 required
    External identifier for the partner's institution. Provides an alternative way to identify the institution.

    at least 1 characters

  • connectionKeySchema string enum required
    The key schema used for partner connections. Defines the structure and validation rules for connection keys.
    tokentokenAndSignatureapiKeyAndSecretclearloop
  • 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

200
OK

Response Body

object

  • partner object required
    The complete partner object that was successfully created.
    partner object
    • id string required
    • enterpriseId string required

      at least 1 characters

    • trustOrg string enum required
      BitGo TrustBitGo New YorkBitGo GermanyBitGo SwitzerlandBitGo Europe ApSFrankfurt DE TrustBitGo SingaporeBitGo KoreaBitGo Custody MENA FZEBitGo IndiaBitGo Sister Trust 1
    • institutionId string
    • institutionIdentifier string required

      at least 1 characters

    • name string required

      at least 1 characters

    • connectionKeySchema string enum required
      tokentokenAndSignatureapiKeyAndSecretclearloop
    • 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
    • allocationPoliciesEnabled boolean required
    • 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
Bad Request
No response body
401
Unauthorized

Response Body

object

  • error string required
403
Forbidden

Response Body

object

  • error string required
422
Unprocessable Entity

Response Body

object

  • error string required
500
Internal Server Error

Response Body

object

  • error string required