Skip to main content
POST
cURL
Affects only resources owned by this run. Funding is synthetic and requires Owner billing authority. Receipt changes publish new normalized data versions. Evaluation advances the selected monitor to its next evaluation immediately without changing server time, token expiry or billing periods. resume_credits clears the explicit insufficient-credit test condition after simulated funding. See Sandbox scenarios for permissions, fixture coverage, expected results, delivery controls and limitations. The autopay payment outcome tests a synthetic balance of CAD 199 against a CAD 200 threshold, creating a CAD 1,000 simulated top-up. It does not change saved auto-pay settings or deduct funds to force the actual Sandbox balance below the threshold. Source changes require connections:write; evaluation requires signal:write; credit recovery requires insights:write and Owner billing authority. 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

Path Parameters

id
string
required
Minimum string length: 1

Body

application/json
action
enum<string>
required

Controlled Sandbox-only action. Referenced resources must belong to this run.

Available options:
funding,
receipts_drop,
receipts_recover,
evaluate_monitor,
resume_credits
resource_id
string

Resource id for this Sandbox fixture.

payment_outcome
enum<string>

Synthetic card, ACH, refund or auto-pay result. No real payment processor is contacted.

Available options:
card_success,
card_declined,
ach_pending,
ach_settled,
ach_returned,
payment_refund,
autopay

Response

Successful request

data
object
required
meta
object
required