Skip to main content
POST
cURL
Store an immutable policy version. AMLOK validates typed rules and units; attached policy documents provide context and do not become executable rules automatically. All IDs and cursors must belong to the authorized workspace and environment. Required scope: configuration: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

Body

application/json

Validated against authorized dimensions and the institution-approved policy before use. Documents provide context; they are not automatically executable policies.

external_id
string
required

External id for RiskPolicyInput. Constraints, requiredness and allowed values are defined by this schema.

Minimum string length: 1
version
string
required

Version for RiskPolicyInput. Constraints, requiredness and allowed values are defined by this schema.

Minimum string length: 1
name
string
required

Name for RiskPolicyInput. Constraints, requiredness and allowed values are defined by this schema.

Minimum string length: 1
borrower_type
enum<string>
required

Borrower type for RiskPolicyInput. Constraints, requiredness and allowed values are defined by this schema.

Available options:
business,
person
market
enum<string>
required

Market for RiskPolicyInput. Constraints, requiredness and allowed values are defined by this schema.

Available options:
US,
CA
rules
object[]
required

Rules for RiskPolicyInput. Constraints, requiredness and allowed values are defined by this schema.

Minimum array length: 1
policy_document_ids
string[]
required

Policy document ids for RiskPolicyInput. Constraints, requiredness and allowed values are defined by this schema.

Opaque identifier, authorized within the API key workspace and environment.

Minimum string length: 1

Response

Successful response.

data
object
required
meta
object
required