Client Activation

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

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

Path parameters

enterpriseIdstring required

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

Response

OK

Changes

No recorded changes to this endpoint across all 16 revisions of this API.