Documentation
ProofAML Screening Appliance
Documentation for the ProofAML Screening Appliance — a self-hosted Docker image that runs the same matching engine as this site's own search entirely inside your VPC. Architecture and trust model, quickstart, the search/batch/monitoring API reference, dataset selection, the update/sync architecture, configuration, and troubleshooting.
Guide
- 01Overview & ArchitectureWhat the ProofAML Screening Appliance is, the trust model (everything stays in your VPC), and how it fits together with the persistent data volume and the updates endpoint.
- 02Quickstartdocker pull, docker run with a persistent volume and env vars, and your first search via curl — complete, copy-pasteable commands.
- 03Search API ReferenceGET /healthz, GET /v1/status, and POST /v1/search — full request/response reference with curl examples and example JSON responses.
- 04Batch Screening GuidePOST /v1/batch for JSON or JSONL input — synchronous for up to 100 subjects, asynchronous with a pollable job for larger files.
- 05Monitoring GuideRegister subjects for continuous re-screening, poll or receive webhook alerts when a change in the data affects them, and how dismissals persist across updates.
- 06Dataset Selection & ReferenceHow the DATASETS environment variable controls what the appliance screens against, and the full reference table of dataset ids — the same catalog published at /sources/.
- 07Updates & SynchronizationHow the appliance stays current — the versioned manifest, incremental per-dataset deltas, checksum self-healing, the epoch mechanism, atomic swap — and the air-gap side-load procedure.
- 08Configuration ReferenceEvery environment variable the appliance reads — PORT, DATA_DIR, UPDATE_URL, DATASETS, SYNC_INTERVAL, ALERT_WEBHOOK_URL, OFFLINE — with defaults and effect.
- 09Troubleshooting / FAQStale data, checksum-mismatch resync, health checks for orchestrators, and upgrading to a new image tag.
Not self-hosting?
The appliance packages the same data and matcher as our hosted API. If you don't need everything to run inside your own VPC, see API for this data instead of running the appliance yourself.
These docs describe the appliance's self-hosted deployment, API, and update protocol. ProofAML is not the issuing authority for the underlying sanctions/PEP/watchlist data — see About the data for source, licensing, and correction policy.