Ctrl+K

Connect to partner

post/api/network/v1/enterprises/{enterpriseId}/clients/connections

Connect your OES client account to an OES partner account, enabling you to trade funds that you have custodied with BitGo. You must have an account on the partner's site. Clients can have multiple connections to the same partner.

Error scenarios:

  • 400: Invalid Request Error

  • Occurs when the request parameters are invalid or malformed.

  • Examples: Invalid UUID format for enterpriseId or partnerId, missing required fields, invalid payload format, invalid signature, payload doesn't match request data.

  • 401: Authentication Error

  • Occurs when the request is not authorized.

  • Examples: Caller is not a member of the enterprise. Payload/Signature are not valid.

  • 403: Permission Denied Error

  • Occurs when the authenticated client doesn't have necessary permissions.

  • Examples: Enterprise does not have OES license.

  • 404: Not Found Error

  • Occurs when the specified resources cannot be found.

  • Examples: Enterprise ID doesn't exist, specified partner ID doesn't exist.

  • 422: Unprocessable Content Error

  • Occurs when the request is valid but cannot be processed due to business rules.

  • Examples: Invalid connection key schema for partner, unsupported key schema, partner is inactive, client and partner belong to different trust organizations.

  • 500: Internal Server Error

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

  • Examples: Database connection issues. Transient network errors,

Path Parameters

  • enterpriseIdstringRequired
    Min length: >= 1 characters

Request Body

partnerId string required
name string required
Min length: >= 1 characters
connectionKeyOne ofrequired
schema string required
Allowed value: token
connectionToken string required
Min length: >= 1 characters
nonce string required
Min length: >= 1 characters
payload string required
Min length: >= 1 characters
signature string required
Min length: >= 1 characters

200 Response

connection object required
The connection details. Contains all information about a specific client-partner connection.
id string required
The unique identifier of the connection. This UUID uniquely identifies the connection between a client and partner.
name string required
A user-friendly name for the connection. This is a descriptive label provided by the client for this particular connection.
Min length: >= 1 characters
clientId string required
The unique identifier of the client associated with this connection. This UUID uniquely identifies the client organization within the BitGo system.
partnerId string required
The unique identifier of the partner associated with this connection. This UUID uniquely identifies the partner organization within the BitGo system.
networkAccountId string required
The unique identifier of the network account associated with this connection. This references the account where allocated funds are held for this connection.
createdAt string <date-time>required
The date and time when the connection was created. Represented as an ISO 8601 formatted date string.
updatedAt string <date-time>required
The date and time when the connection was last updated. Represented as an ISO 8601 formatted date string.
active boolean required
Indicates whether the connection is active. When false, the connection is deactivated and no operations (like allocations) can be performed on it. When true, the connection is active and operations can be performed on it.
proof string required
The cryptographic proof associated with the connection. This is used for verifying the authenticity of the connection. Derived from the payload and signature submitted when the connection was created.
Min length: >= 1 characters
nonce string required
A nonce value used in the connection cryptographic operations. This provides additional security for connection operations.
Min length: >= 1 characters
evaluationId string
The unique identifier of the policy evaluation for this connection.
Min length: >= 1 characters
pendingApprovalId string
The unique identifier of the pending approval for this connection.
Min length: >= 1 characters
policyResult string
The result of the policy evaluation for this connection. - 'approved': Policy evaluation passed and the operation was allowed - 'rejected': Policy evaluation failed and the operation was denied Not present if no policy evaluation was performed or if evaluation is still pending.
Allowed values: approved rejected
partnersConnectionId
string or null
required
The partner's identifier for this connection. This is the identifier used by the partner in their system to refer to this connection. Will be null if the connection hasn't been initialized by the partner.
Min length: >= 1 characters
partnersClientId
string or null
required
The partner's identifier for the client. This is the identifier used by the partner in their system to refer to the client. Will be null if the connection hasn't been initialized by the partner.
Min length: >= 1 characters
initialized boolean required
Indicates whether the connection has been initialized by the partner. When true, the partner has established this connection on their side. When false, the connection is pending initialization by the partner.

400 Response

401 Response

error string required

403 Response

error string required

404 Response

error string required

422 Response

error string required

500 Response

error string required