Data Delivery Service

Our data delivery service provides the following advantages over our publicly-available data serving infrastructure:

• Reliability: In case of issues with the publicly-served data, whether technical, legal, or otherwise, we prioritize serving our licensed customers first.
• Support: When issues arise, we have better insight from our end to help debug any problems you may encounter.
• Telemetry: Understanding our customers' access patterns, clients, and dataset usage allows us to make better decisions about what work to prioritize.

To use the data delivery service, a data delivery token is required. You'll receive this token from us as part of the customer onboarding process. Alternatively, if you have an email address on file with us, you can find the token in our customer portal. Please treat this token as a secret credential.

Using with Yente on-premise API Service

If you're deploying Yente using Docker containers, setting the following environment variables should be enough:

services:
  [...]
  app:
    [...]
    environment:
      YENTE_MANIFEST: "manifests/commercial.yml"
      OPENSANCTIONS_DELIVERY_TOKEN: "your-secret-delivery-token"

The yente repository contains a pre-configured docker-compose.commercial.yml that you may use as a template.

Using your own Manifest file

If you're configuring Yente using a custom manifest file, add a catalog like this:

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

Using in your own code

Downloading data works much the same as with our publicly-served data offering, with two key differences:

• Use https://delivery.opensanctions.com as the base domain (instead of https://data.opensanctions.org). When reading the dataset metadata, the URLs in the resources section will automatically point to the data delivery service.
• Include your delivery token in the Authorization header: Authorization: Token [yoursecret]

Important considerations:

• Enable HTTP redirects in your client. The data delivery service uses redirects to serve large files from our CDN.
• Scope your auth headers properly: Only send the Authorization header to delivery.opensanctions.org, not to any domains it redirects to. This is the default behavior for all HTTP clients we know about.