/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,
enterpriseId
stringRequired>= 1 characters
partnerId
string required name
string required >= 1 characters
connectionKey
One ofrequired schema
string required token
connectionToken
string required >= 1 characters
nonce
string required >= 1 characters
payload
string required >= 1 characters
signature
string required >= 1 characters
connection
object required id
string required name
string required >= 1 characters
clientId
string required partnerId
string required networkAccountId
string required createdAt
string <date-time>
required updatedAt
string <date-time>
required active
boolean required proof
string required >= 1 characters
nonce
string required >= 1 characters
partnersConnectionId
>= 1 characters
partnersClientId
>= 1 characters
initialized
boolean required error
string required error
string required error
string required error
string required error
string required