Skip to main content
POST
cURL
Persist a workspace-wide initial choice. Samples queue six businesses and associated records. Empty preserves existing data and provides synthetic credits. The choice cannot erase data. Owners can load samples; Owners and Developers can choose empty. Concurrent setup requests return the existing choice. See Sandbox scenarios for permissions, fixture coverage, expected results, delivery controls and limitations. 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
choice
enum<string>
required

The workspace-wide first-use choice. Null means no choice has been saved.

Available options:
empty,
samples

Response

Successful request

data
object
required
meta
object
required