Configuring OpenSanctions Data

By default, yente is configured to fetch the full and up-to-date OpenSanctions database. To help us understand how commercial partners use the dataset, we ask customers to create a delivery token. The token itself is not linked to a contract, it just helps us to provide relevant support. Please sign up at the customer portal - a delivery token will be created automatically and immediately, which you can find in the Data delivery service section. Set OPENSANCTIONS_DELIVERY_TOKEN in your environment and off you go!

If you're deploying yente using a Docker container, your docker-compose.yml could contain the token like this:

services:
  [...]
  app:
    [...]
    environment:
      YENTE_MANIFEST: "/app/manifests/commercial.yml"
      OPENSANCTIONS_DELIVERY_TOKEN: "65ee4bdac5b3421fb41324198cb951b3"  # Replace with your own

Or if you're using a custom manifest file, add a catalog like this:

catalogs:
  - url: "https://delivery.opensanctions.com/datasets/latest/index.json"
    auth_token: "$OPENSANCTIONS_DELIVERY_TOKEN" # $ENVIRONMENT_VARIABLE expansion supported
    scope: default
    resource_name: entities.ftm.json

Once you have decided to adopt the OpenSanctions database in a commercial setting, you need to purchase a license subscription.

Non-commercial users and users exempted from commercial licensing may set YENTE_MANIFEST: "/app/manifests/civic.yml" instead of "/app/manifests/commercial.yml" to access OpenSanctions directly.