Skip to main content
POST
cURL
Queue a repeatable versioned scenario. Each run owns a new set of resources and preserves other runs. Uses the initiating key permissions; product flows also need borrower, connection, configuration, evidence, Insights, Signal, results and export scopes. Billing scenarios and sample pack require Owner authority and billing:read. Outbound webhooks are disabled unless explicitly requested; webhook scenarios require an enabled endpoint in this Sandbox. Inspect the run steps for real API requests, responses and request IDs. No real provider calls or payments occur. See Sandbox scenarios for permissions, fixture coverage, expected results, delivery controls and limitations. A maximum of three runs may be queued or running per workspace environment. Additional runs return 429 with Retry-After. Enabling delivery requires endpoint_id; only that destination is used. Webhook scenarios also require events:write. Examples use synthetic IDs. Replace them with values returned by your environment.

Authorizations

Authorization
string
header
required

Server-to-server API key bound to exactly one workspace, institution tenant and environment. No caller-supplied workspace override is accepted. Do not use in public browser code.

Headers

Idempotency-Key
string
required

Stable for one intended command and its retries, scoped to key workspace/environment and operation. Mismatched body returns 409. Full response replay 24 hours; durable receipt remains.

Minimum string length: 1
X-AMLOK-Sandbox-Scenario
enum<string>

Sandbox-only deterministic test scenario on borrower creation, persisted for that borrower. On other operations or any Live request, reject before side effects with 400 sandbox_only. Omit for happy_path.

Available options:
happy_path,
source_reauthorization,
document_required,
missing_financial_input,
restricted_report,
provider_failure,
insufficient_credits,
monitoring_alert,
payment_return,
export_failure

Body

application/json
scenario_id
enum<string>
required

Stable scenario identifier from the versioned catalog.

Available options:
sample_pack,
healthy,
outside_policy,
manual_review,
document_required,
document_recovery,
source_reauthorization,
source_recovery,
consent_cancelled,
consent_revoked,
provider_failure,
insufficient_credits,
monitoring_alert,
monitoring_recovery,
monitoring_lifecycle,
card_success,
card_declined,
ach_pending,
ach_settled,
ach_returned,
payment_refund,
autopay,
export_success,
export_failure,
idempotency,
validation_error,
pagination,
webhook_delivery,
webhook_duplicate,
webhook_out_of_order
fixture_id
enum<string>
required

Fictional business definition used to create this run.

Available options:
maple-retail,
harbor-logistics,
cedar-software,
prairie-manufacturing,
summit-hospitality,
atlas-wholesale
catalog_version
any
required

Exact catalog version; reject mismatches rather than silently changing test behavior.

endpoint_id
string

Enabled webhook destination in this Sandbox. Required when send_webhooks is true.

send_webhooks
boolean
default:false

Defaults to false. Explicitly opt in to signed HTTP delivery to the selected endpoint.

Response

Successful request

data
object
required
meta
object
required