Introduction
The Lists API delivers Frank Penny’s screening datasets over HTTP. There are two primary datasets: Sanctions and PEP (which also includes the RCA dataset). Both datasets are primarily designed for bulk use cases, i.e. ingesting the full dataset periodically to also support single-entity lookup for various use cases, such as updating a local cache, fetching a single record for display, or finding delisted/archived records.
Environments and base URL
Section titled “Environments and base URL”Each environment has a fixed base URL, and all paths in these docs are relative to it. Examples refer to it as $BASE_URL. Keys are scoped to a single environment, and you must use the correct key for the environment you are calling. See Authentication for more details.
The staging environment serves synthetic sandbox data only and is intended for testing and development, changes to the API will first appear in staging before being released to production. The production environment serves real data and is intended for live use. Endpoints and record shapes are identical in both environments.
| Environment | Base URL | Key prefix |
|---|---|---|
| Staging | https://api.staging.editedsource.com | lk_test_... |
| Production | https://api.editedsource.com | lk_live_... |
The previous hostnames https://lists-api.tools.frankpenny.se (production) and https://lists-api.staging.tools.frankpenny.se (staging) are legacy hostnames that keep working for existing integrations, and they serve the same API at the same paths.
Schema versions
Section titled “Schema versions”Every dataset response declares the schema version of its payload in the X-Schema-Version header. You can pin a version, and within a major version schema changes are additive. See Schema versioning.
OpenAPI document
Section titled “OpenAPI document”The full machine-readable contract is published as OpenAPI 3.1 at GET /v1/openapi.json.