Ctrl+K

Create client

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

Create a new OES client for the specified enterprise. This endpoint allows enterprise users to create a new client within the OES system, establishing the foundation for future trading activities. The client will be automatically associated with the enterprise specified in the path parameter.

Error scenarios:

  • 400: Invalid Request Error

  • Occurs when the request parameters are invalid or incomplete/

  • Examples: Empty string supplied for enterpriseId.

  • 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 user does not have permission to create a client for this enterprise.

  • 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
    Enterprise ID that this client will be associated with. The client will be created under this enterprise's context.
    Min length: >= 1 characters

200 Response

client object required
The complete client object that was successfully created.
id string required
The id of the client.
enterpriseId string required
The enterprise ID that this client is associated with.
Min length: >= 1 characters
trustOrg string required
The trust organization that this client is associated with.
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
walletId string required
The Go Account ID that the client is associated with
Min length: >= 1 characters
createdAt string <date-time>required
The timestamp when the client was created. (ISO 8601 format)
updatedAt string <date-time>required
The timestamp when the client was last updated. (ISO 8601 format)
balanceAlertLastSent string
Last time a balance alert was sent. Typically will be undefined.

400 Response

401 Response

error string required

403 Response

error string required

500 Response

error string required