REST API›Settle (Off Exchange)›Client Activation

POST

Create client

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.

Requires access token scopes: settlement_network_read, settlement_network_write

Path Params

  • enterpriseId string required
    Enterprise ID that this client will be associated with. The client will be created under this enterprise's context.

    at least 1 characters

Responses

200
OK

Response Body

object

  • client object required
    The complete client object that was successfully created.
    client object
    • id string required
      The id of the client.
    • enterpriseId string required
      The enterprise ID that this client is associated with.

      at least 1 characters

    • trustOrg string enum required
      The trust organization that this client is associated with.
      BitGo TrustBitGo New YorkBitGo GermanyBitGo SwitzerlandBitGo Europe ApSFrankfurt DE TrustBitGo SingaporeBitGo KoreaBitGo Custody MENA FZEBitGo IndiaBitGo Sister Trust 1
    • walletId string required
      The Go Account ID that the client is associated with

      at least 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
Bad Request
No response body
401
Unauthorized

Response Body

object

  • error string required
403
Forbidden

Response Body

object

  • error string required
500
Internal Server Error

Response Body

object

  • error string required