/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.
enterpriseId
stringRequired>= 1 characters
name
string required >= 1 characters
broker
boolean required institutionId
string institutionIdentifier
string >= 1 characters
connectionKeySchema
string required token
tokenAndSignature
apiKeyAndSecret
clearloop
clientDisputeWindowMinutes
number topUpWindowMinutes
number partner
object required id
string required enterpriseId
string required >= 1 characters
trustOrg
string required 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 >= 1 characters
connectionKeySchema
string required token
tokenAndSignature
apiKeyAndSecret
clearloop
createdAt
string <date-time>
required updatedAt
string <date-time>
required clientId
string required broker
boolean required active
boolean required settlementTransactionRouteId
string clientDisputeWindowMinutes
number topUpWindowMinutes
number publicKey
string error
string required error
string required error
string required