Skip to main content
POST
cURL
Required scope: 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 · 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.

Path Parameters

id
string
required

Tenant-visible resource identifier.

Body

application/json
resources
enum<string>[]
required

Resource types to retrieve.

Minimum array length: 1
Available options:
connection,
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
from
string<date>

Inclusive requested history start.

to
string<date>

Exclusive requested history end.

Response

Request a bounded data refresh. Accepted work is not yet complete.

data
sync_job · object
required

Bounded ingestion run, including partial results and source outages. Population depends on source and tenant entitlement.

meta
object
required