Skip to main content
POST
cURL
Register a business or consumer borrower. Registration records institution-supplied identity; it does not assert successful KYB or KYC. All IDs and cursors must belong to the authorized workspace and environment. Required scope: borrowers: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
type
any
required
business
object
required

Response

Successful response.

data
object
required
meta
object
required