Client Activation

Get Signing Payload for Client Connections (Post variant)

This API call allows clients to get the client connections payload for signing. This endpoint is effectively the same as the GET endpoint, but is helpful if your HTTP client doesn't support sending a request body on a get request.

Error scenarios:

  • 400: Invalid Request Error

  • Occurs when the request parameters are invalid or malformed

  • Examples: Empty string provided for entepriseId, missing required fields in request body.

  • 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 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.

  • 500: Internal Server Error

  • Occurs when there's an unexpected server error processing the request.

  • Examples: Database connection issues. Transient network errors.

Requires access token scopes: settlement_network_read, settlement_network_write

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

Request

  • Base URL
    https://developers.bitgo.com
  • URL
    https://developers.bitgo.com/api/network/v1/enterprises/{enterpriseId}/clients/connections/signing
  • Auth
    none declared

Path parameters

enterpriseIdstring required

Request body

partnerIdstring required
namestring required
noncestring required

Response

OK

payloadstring required

Changes

No operation changes recorded.