Accounts

Simulate status transitions for a sandbox account

Changed on

Simulate the status transitions for sandbox accounts. This endpoint can only be used for sandbox accounts.

post/v1/accounts/{account_id}/simulate

Request

  • Base URL
    https://sandbox.straddle.com
  • URL
    https://sandbox.straddle.com/v1/accounts/{account_id}/simulate
  • Auth
    HTTP bearer

Path parameters

account_idstring uuid required

Query parameters

final_status'onboarding' | 'active'

Headers

request-idstring

Optional client generated identifier to trace and debug a request.

correlation-idstring

Optional client generated identifier to trace and debug a series of requests.

idempotency-keystring

Optional client generated value to use for idempotent requests.

Response

Created

response_type'object' | 'array' | 'error' | 'none' required

Indicates the structure of the returned content.

  • "object" means the data field contains a single JSON object.
  • "array" means the data field contains an array of objects.
  • "error" means the data field contains an error object with details of the issue.
  • "none" means no data is returned.

Changes

  • de39a60c562eRevision changes
    • breaking

      removed the required property /// from the response with the status (media type: text/plain)

    • breaking

      removed the required property /// from the response with the status (media type: application/json)

    • breaking

      removed the required property /// from the response with the status (media type: text/json)

    • breaking

      removed the required property /// from the response with the status (media type: text/plain)

    • breaking

      removed the required property /// from the response with the status (media type: application/json)

    • breaking

      removed the required property /// from the response with the status (media type: text/json)

    • warning

      removed the optional property /// from the response with the status (media type: text/plain)

    • warning

      removed the optional property /// from the response with the status (media type: application/json)

    • warning

      removed the optional property /// from the response with the status (media type: text/json)

  • 6e13cd88cda9Revision changes
    • info

      added the optional property /// to the response with the status (media type: text/plain)

    • info

      added the optional property /// to the response with the status (media type: application/json)

    • info

      added the optional property /// to the response with the status (media type: text/json)

    • info

      added the required property /// to the response with the status (media type: text/plain)

    • info

      added the required property /// to the response with the status (media type: application/json)

    • info

      added the required property /// to the response with the status (media type: text/json)

    • info

      added the required property /// to the response with the status (media type: text/plain)

    • info

      added the required property /// to the response with the status (media type: application/json)

    • info

      added the required property /// to the response with the status (media type: text/json)