Skip to main content
POST
cURL
Enroll a funded deal in Signal with an existing risk package or approved portfolio baseline. AMLOK schedules refreshes and change-driven reassessments. All IDs and cursors must belong to the authorized workspace and environment. Required scope: signal: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
borrower_id
string
required

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

Minimum string length: 1
deal
object
required

Deal for CreateMonitor. Constraints, requiredness and allowed values are defined by this schema.

baseline
Existing risk package · object
required

Baseline for CreateMonitor. Constraints, requiredness and allowed values are defined by this schema.

risk_policy_version_id
string
required

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

Minimum string length: 1
cadence_id
string
required

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

Minimum string length: 1
connection_ids
string[]
required

Connection ids for CreateMonitor. 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

Accepted asynchronously; inspect status, not just HTTP success.

data
object
required
meta
object
required