curl --request POST --fail-with-body --max-time 30 \
"${AMLOK_API_BASE_URL}/v1/connections/cnn_example/sync" \
--header "Authorization: Bearer ${AMLOK_API_KEY}" \
--header "Accept: application/json" \
--header 'Idempotency-Key: idem_example_1001' \
--header 'Content-Type: application/json' \
--data '{
"resources": [
"bank_transaction"
],
"from": "2026-09-01",
"to": "2026-10-01"
}'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/connections/cnn_example/sync",
headers=headers, timeout=30, allow_redirects=False,
json={'resources': ['bank_transaction'],
'from': '2026-09-01',
'to': '2026-10-01'},
)
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/connections/cnn_example/sync", {
method: "POST", headers,
redirect: "error", signal: AbortSignal.timeout(30000),
body: JSON.stringify({
"resources": [
"bank_transaction"
],
"from": "2026-09-01",
"to": "2026-10-01"
}),
});
if (!response.ok) throw new Error(`AMLOK returned HTTP ${response.status}`);
console.log(await response.json());{
"data": {
"id": "cnn_example",
"object": "sync_job",
"subject_id": "biz_example",
"created_at": "2026-10-23T14:00:00Z",
"updated_at": "2026-10-23T14:00:00Z",
"record_version": 1,
"source_refs": [],
"data_status": "pending",
"missing_fields": [],
"schema_version": "1.4.2",
"client_reference": "app-1029",
"connection_id": "cnn_01JAMLOK",
"resources": [
"bank_account",
"bank_transaction"
],
"status": "queued",
"started_at": null,
"completed_at": null,
"requested_from": "2026-09-01",
"requested_to": "2026-10-01",
"records_added": null,
"records_updated": null,
"records_removed": null,
"coverage_start": null,
"coverage_end": null,
"errors": []
},
"meta": {
"request_id": "req_example",
"schema_version": "1.4.2",
"generated_at": "2026-10-23T14:00:00Z",
"data_status": "pending"
}
}Start connection sync
Request a bounded data refresh.
Required scope: connections:write. Poll GET /v1/sync-jobs/; may complete partially. 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.
curl --request POST --fail-with-body --max-time 30 \
"${AMLOK_API_BASE_URL}/v1/connections/cnn_example/sync" \
--header "Authorization: Bearer ${AMLOK_API_KEY}" \
--header "Accept: application/json" \
--header 'Idempotency-Key: idem_example_1001' \
--header 'Content-Type: application/json' \
--data '{
"resources": [
"bank_transaction"
],
"from": "2026-09-01",
"to": "2026-10-01"
}'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/connections/cnn_example/sync",
headers=headers, timeout=30, allow_redirects=False,
json={'resources': ['bank_transaction'],
'from': '2026-09-01',
'to': '2026-10-01'},
)
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/connections/cnn_example/sync", {
method: "POST", headers,
redirect: "error", signal: AbortSignal.timeout(30000),
body: JSON.stringify({
"resources": [
"bank_transaction"
],
"from": "2026-09-01",
"to": "2026-10-01"
}),
});
if (!response.ok) throw new Error(`AMLOK returned HTTP ${response.status}`);
console.log(await response.json());{
"data": {
"id": "cnn_example",
"object": "sync_job",
"subject_id": "biz_example",
"created_at": "2026-10-23T14:00:00Z",
"updated_at": "2026-10-23T14:00:00Z",
"record_version": 1,
"source_refs": [],
"data_status": "pending",
"missing_fields": [],
"schema_version": "1.4.2",
"client_reference": "app-1029",
"connection_id": "cnn_01JAMLOK",
"resources": [
"bank_account",
"bank_transaction"
],
"status": "queued",
"started_at": null,
"completed_at": null,
"requested_from": "2026-09-01",
"requested_to": "2026-10-01",
"records_added": null,
"records_updated": null,
"records_removed": null,
"coverage_start": null,
"coverage_end": null,
"errors": []
},
"meta": {
"request_id": "req_example",
"schema_version": "1.4.2",
"generated_at": "2026-10-23T14:00:00Z",
"data_status": "pending"
}
}connections:write
Request a bounded data refresh.
Required scope: connections:write. Poll GET /v1/sync-jobs/; may complete partially. 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 · ErrorsAuthorizations
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
Optional caller correlation ID; the response includes AMLOK request_id.
Reuse for retries of the same intended command and identical payload. Retention: 24 hours.
Path Parameters
Tenant-visible resource identifier.
Body
Resource types to retrieve.
1connection, consent, sync_job, business, person, relationship, verification, verification_check, screening_match, document, bank_account, account_balance, bank_transaction, recurring_stream, income_observation, merchant_account, payment, processor_transaction, payout, refund, dispute, counterparty, order, order_line, subscription, ledger_account, journal, journal_line, invoice, bill, credit_note, accounting_payment, financial_statement, statement_line, tax_obligation, product, location, inventory_balance, inventory_movement, purchase_order, shipment, production_order, project, application, credit_facility, loan, installment, repayment, collateral, guarantee, covenant, decision, lien_search, lien, filing_event, attribute, risk_snapshot, monitor, alert, workflow_run, requirement, audit_event, reconciliation_link Inclusive requested history start.
Exclusive requested history end.