Operational

The endpoints on this page support an integration rather than carrying dataset records: they report what a key can do, whether the service is up, which schema versions are served, and where the machine-readable contract lives.

Whoami

GET/v1/whoami

Returns the calling key’s identity, its dataset scopes, its per-source grants, and its rate limits. Use it to confirm a key is live and to discover what it may read.

curl -sS \
  -H "Authorization: Bearer YOUR_API_KEY" \
  "https://api.editedsource.com/v1/whoami"

{
  "allowed_sources": [
    "pep-eu",
    "pep-intl",
    "pep-swe"
  ],
  "environment": "test",
  "key_id": "a1b2c3d4e5f6a7b8",
  "prefix": "lk_test_XXXX",
  "rate_limits": {
    "rpm": 60
  },
  "scopes": [
    "pep",
    "sanctions"
  ],
  "tenant_id": "acme-bank"
}

Service health

GET/v1/health

Liveness check for the service. It requires no authentication and is safe to poll from monitoring.

curl -sS \
  -H "Authorization: Bearer YOUR_API_KEY" \
  "https://api.editedsource.com/v1/health"

{
  "base_as_of": {
    "sanctions": "2026-09-07T20:05:12Z"
  },
  "build": "20260625142416.02d00801",
  "status": "ok",
  "version": "0.6.0"
}

Schema manifest

GET/v1/schemas/{domain}

Lists the schema versions served for one dataset domain, naming the current version and any that are deprecated or withdrawn. See Schema versioning.

Path parameters

domainenum · required

Public dataset token. Canonical values: sanctions, pep, screening. pep-rca and pep_rca are deprecated aliases for pep.

curl -sS \
  -H "Authorization: Bearer YOUR_API_KEY" \
  "https://api.editedsource.com/v1/schemas/sanctions"

{
  "current": "1.2.6",
  "deprecated": [],
  "domain": "sanctions",
  "supported": [
    {
      "released": "2026-11-03",
      "version": "1.2.6"
    }
  ],
  "withdrawn": []
}

Schema document

GET/v1/schemas/{domain}/{version}

Returns one dataset’s JSON Schema document, the machine-readable definition of the record shape at that version.

Path parameters

domainenum · required

Public dataset token. Canonical values: sanctions, pep, screening. pep-rca and pep_rca are deprecated aliases for pep.

versionstring · required

Schema version to fetch: major, major.minor, or full semver (e.g. 1, 1.2, 1.2.0). A withdrawn version is 410; an unknown version is 406. The manifest at /v1/schemas/{domain} lists the served versions.

curl -sS \
  -H "Authorization: Bearer YOUR_API_KEY" \
  "https://api.editedsource.com/v1/schemas/sanctions/1.2.0"

{
  "$id": "https://lists-api.tools.frankpenny.se/v1/schemas/sanctions/1.2.6",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false,
  "description": "sanctions dataset record.",
  "properties": {
    "id": {
      "type": "string"
    },
    "schema": {
      "type": "string"
    }
  },
  "required": [
    "id",
    "schema",
    "properties",
    "topics",
    "sources",
    "caption",
    "sanctions",
    "status"
  ],
  "title": "sanctions=1.2.6",
  "type": "object"
}

Changelog feed (JSON)

GET/v1/changelog/json

The release record as JSON, one entry per released contract version, for watching releases programmatically. The same history is published for humans in the changelog.

curl -sS \
  -H "Authorization: Bearer YOUR_API_KEY" \
  "https://api.editedsource.com/v1/changelog/json"

{
  "tool": "oasdiff",
  "versions": [
    {
      "breaking": true,
      "changes": [
        {
          "id": "response-optional-property-added",
          "level": 1,
          "operation": "GET",
          "path": "/v1/pep/full",
          "section": "paths",
          "text": "added the optional property `items/properties/country` to the response with the `200` status (media type: application/json)"
        }
      ],
      "date": "2026-07-07",
      "initial": false,
      "schemaVersions": {
        "pep": "2.0.0",
        "sanctions": "1.2.0"
      },
      "sha": "c905369",
      "version": "0.3.0"
    }
  ]
}

Dataset schema changelog (JSON)

GET/v1/changelog/schemas.json

Per-dataset schema version history, including patch versions that only changed descriptions or annotations. Public, no auth, like the API changelog.

curl -sS \
  -H "Authorization: Bearer YOUR_API_KEY" \
  "https://api.editedsource.com/v1/changelog/schemas.json"

{
  "datasets": {
    "pep": {
      "versions": [
        {
          "breaking": false,
          "changes": [
            {
              "id": "property-deprecated",
              "level": 1,
              "path": "nationality",
              "text": "`nationality` marked deprecated"
            },
            {
              "id": "required-added",
              "level": 1,
              "path": "status",
              "text": "`status` became required"
            }
          ],
          "date": "2026-08-26",
          "initial": false,
          "version": "2.0.6"
        }
      ]
    }
  },
  "tool": "schema_changelog"
}

OpenAPI document

GET/v1/openapi.json

Returns this service's OpenAPI document.

The entity record components can be pinned to a specific dataset major schema version via the query params below, so an SDK generated from this spec matches the version you pin your data to (?schema_version= on the data endpoints). Omit a param to describe that dataset's current version.

Query parameters

pep_schema_versionstring · optional

Pin the pep record schema to this major version (e.g. 1). The spec then describes that version's record shape instead of the current one. Omit for current.

Major only:

1 → that major's latest served shape
1.0 / 1.0.0 → 400
unknown major → 406

Pass the same value you use for data ?schema_version= so generated clients don't drift to a newer shape.

sanctions_schema_versionstring · optional

Pin the sanctions record schema to this major version (e.g. 1). Same rules as pep_schema_version. Omit for current.

curl -sS \
  -H "Authorization: Bearer YOUR_API_KEY" \
  "https://api.editedsource.com/v1/openapi.json"

Successful Response

The contract declares no schema for this response.