cURL

curl --request POST --fail-with-body --max-time 30 \
  "${AMLOK_API_BASE_URL}/v1/webhook-endpoints" \
  --header "Authorization: Bearer ${AMLOK_API_KEY}" \
  --header "Accept: application/json" \
  --header 'Idempotency-Key: idem_example_1001' \
  --header 'Content-Type: application/json' \
  --data '{
  "url": "https://client.example.com/amlok-events",
  "event_types": [
    "verification.completed"
  ],
  "description": "Application events for the underwriting service"
}'

import os
import requests

base_url = os.environ["AMLOK_API_BASE_URL"].rstrip("/")
headers = {'Accept': 'application/json',
 'Idempotency-Key': 'idem_example_1001',
 'Content-Type': 'application/json'}
headers["Authorization"] = "Bearer " + os.environ["AMLOK_API_KEY"]

response = requests.request(
    "POST", base_url + "/v1/webhook-endpoints",
    headers=headers, timeout=30, allow_redirects=False,
    json={'url': 'https://client.example.com/amlok-events',
 'event_types': ['verification.completed'],
 'description': 'Application events for the underwriting '
                'service'},
)
response.raise_for_status()
print(response.json())

const baseUrl = process.env.AMLOK_API_BASE_URL;
const apiKey = process.env.AMLOK_API_KEY;
if (!baseUrl || !apiKey) throw new Error("Configure AMLOK_API_BASE_URL and AMLOK_API_KEY");
const headers = {
  "Accept": "application/json",
  "Idempotency-Key": "idem_example_1001",
  "Content-Type": "application/json"
};
headers.Authorization = `Bearer ${apiKey}`;
const response = await fetch(baseUrl.replace(/\/$/, "") + "/v1/webhook-endpoints", {
  method: "POST", headers,
  redirect: "error", signal: AbortSignal.timeout(30000),
  body: JSON.stringify({
  "url": "https://client.example.com/amlok-events",
  "event_types": [
    "verification.completed"
  ],
  "description": "Application events for the underwriting service"
}),
});
if (!response.ok) throw new Error(`AMLOK returned HTTP ${response.status}`);
console.log(await response.json());

{
  "data": {
    "id": "whk_example",
    "url": "https://client.example.com/amlok-events",
    "event_types": [
      "verification.completed"
    ],
    "status": "active",
    "secret": "synthetic_webhook_secret_replace_on_provisioning"
  },
  "meta": {
    "request_id": "req_example",
    "schema_version": "1.4.2",
    "generated_at": "2026-10-23T14:00:00Z",
    "data_status": "partial"
  }
}

Webhooks

Create webhook endpoint

Required scope: webhooks:write. Return signing secret only once; validate destination against SSRF and tenant rules. Once account cancellation is submitted, processing and usage deductions stop immediately. Reject new operational commands with 409 invalid_state; pending work is cancelled without another debit. Read-only reporting remains available until workspace deletion. Accepted commands have a durable request receipt. Full response replay lasts 24 hours; afterward the same key and target return 409 idempotency_result_expired without re-execution. Different payloads return 409 idempotency_conflict. Use GET /v1/request-receipts/lookup to find the original resource. The fingerprint includes the resolved target path and intended payload; a key used on another target is rejected rather than replayed onto it. Pre-execution validation or insufficient-credit rejection creates no accepted receipt.

POST

webhook-endpoints

cURL

curl --request POST --fail-with-body --max-time 30 \
  "${AMLOK_API_BASE_URL}/v1/webhook-endpoints" \
  --header "Authorization: Bearer ${AMLOK_API_KEY}" \
  --header "Accept: application/json" \
  --header 'Idempotency-Key: idem_example_1001' \
  --header 'Content-Type: application/json' \
  --data '{
  "url": "https://client.example.com/amlok-events",
  "event_types": [
    "verification.completed"
  ],
  "description": "Application events for the underwriting service"
}'

import os
import requests

base_url = os.environ["AMLOK_API_BASE_URL"].rstrip("/")
headers = {'Accept': 'application/json',
 'Idempotency-Key': 'idem_example_1001',
 'Content-Type': 'application/json'}
headers["Authorization"] = "Bearer " + os.environ["AMLOK_API_KEY"]

response = requests.request(
    "POST", base_url + "/v1/webhook-endpoints",
    headers=headers, timeout=30, allow_redirects=False,
    json={'url': 'https://client.example.com/amlok-events',
 'event_types': ['verification.completed'],
 'description': 'Application events for the underwriting '
                'service'},
)
response.raise_for_status()
print(response.json())

const baseUrl = process.env.AMLOK_API_BASE_URL;
const apiKey = process.env.AMLOK_API_KEY;
if (!baseUrl || !apiKey) throw new Error("Configure AMLOK_API_BASE_URL and AMLOK_API_KEY");
const headers = {
  "Accept": "application/json",
  "Idempotency-Key": "idem_example_1001",
  "Content-Type": "application/json"
};
headers.Authorization = `Bearer ${apiKey}`;
const response = await fetch(baseUrl.replace(/\/$/, "") + "/v1/webhook-endpoints", {
  method: "POST", headers,
  redirect: "error", signal: AbortSignal.timeout(30000),
  body: JSON.stringify({
  "url": "https://client.example.com/amlok-events",
  "event_types": [
    "verification.completed"
  ],
  "description": "Application events for the underwriting service"
}),
});
if (!response.ok) throw new Error(`AMLOK returned HTTP ${response.status}`);
console.log(await response.json());

{
  "data": {
    "id": "whk_example",
    "url": "https://client.example.com/amlok-events",
    "event_types": [
      "verification.completed"
    ],
    "status": "active",
    "secret": "synthetic_webhook_secret_replace_on_provisioning"
  },
  "meta": {
    "request_id": "req_example",
    "schema_version": "1.4.2",
    "generated_at": "2026-10-23T14:00:00Z",
    "data_status": "partial"
  }
}

Required scope: webhooks:write Register an HTTPS event destination. Required scope: webhooks:write. Return signing secret only once; validate destination against SSRF and tenant rules. Once account cancellation is submitted, processing and usage deductions stop immediately. Reject new operational commands with 409 invalid_state; pending work is cancelled without another debit. Read-only reporting remains available until workspace deletion. Accepted commands have a durable request receipt. Full response replay lasts 24 hours; afterward the same key and target return 409 idempotency_result_expired without re-execution. Different payloads return 409 idempotency_conflict. Use GET /v1/request-receipts/lookup to find the original resource. The fingerprint includes the resolved target path and intended payload; a key used on another target is rejected rather than replayed onto it. Pre-execution validation or insufficient-credit rejection creates no accepted receipt. Product scope · Processing lifecycle · Errors

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

X-Request-ID

string

Optional caller correlation ID; the response includes AMLOK request_id.

Idempotency-Key

string

required

Reuse for retries of the same intended command and identical payload. Retention: 24 hours.

Body

application/json

url

string<uri>

required

HTTPS destination permitted for this tenant.

Minimum string length: 1

Pattern: ^https://

event_types

enum<string>[]

required

Subscribed keys from Events.

Minimum array length: 1

Available options:

business.created,

person.created,

connection.updated,

consent.updated,

sync.completed,

sync.failed,

verification.updated,

verification.completed,

document.processed,

lien_search.completed,

lien_search.failed,

lien.updated,

application.updated,

decision.created,

loan.updated,

repayment.updated,

attributes.calculated,

risk_snapshot.created,

monitor.updated,

alert.created,

alert.updated,

workflow.completed,

workflow.failed,

resource.deleted

description

string

Request field from the endpoint contract.

Minimum string length: 1

Response

data

object

required

Show child attributes

Get started

Endpoints

Essentials

Create webhook endpoint

Authorizations

Headers

Body

Response