Skip to main content
POST
cURL
Required scope: documents:write Upload permitted evidence. Required scope: documents:write. Validate file content; poll document extraction state. 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

multipart/form-data
file
file
required

Request field from the endpoint contract.

subject_id
string
required

Business or person to which this record relates.

Minimum string length: 1
document_type
enum<string>
required

Category of evidence.

Available options:
identity,
proof_of_address,
bank_statement,
financial_statement,
tax_return,
corporate_registry,
ownership,
loan_agreement,
lien_report,
invoice,
other
period_start
string<date>

First date covered by the document.

period_end
string<date>

Last date covered by the document, inclusive.

requirement_id
string

Optional missing-evidence requirement in this subject and workspace. The upload is attached to the requirement; AMLOK validates evidence and resumes the parent when accepted.

Minimum string length: 1

Response

Upload permitted evidence. Accepted work is not yet complete.

data
document · object
required

Evidence file metadata and extraction context. Population depends on source and tenant entitlement.

meta
object
required