Change policy

We strive to balance our commitment to innovation with our users' need for a reliable dataset that can be seamlessly integrated into their systems. To achieve this, we've established a Change Policy that explains how we announce and implement changes.

Offering new features, datasets, entity types and properties, and API services provides clear value to our users. However, we sometimes need to deprecate, remove or modify existing aspects of the database in ways that may be disruptive.

This is because our understanding of the domain, the needs of our users, as well as the pursuit of the best possible product are constantly evolving. Failing to accommodate this evolution by removing legacy functionality without clear notice can lead to a confusing, insecure, and stagnant product in the long run.

Therefore, this Change Policy documentation defines a transparent process for the deprecation and eventual removal of functionality in various components of the OpenSanctions platform. In particular, it defines notice periods and a notification mechanism meant to minimize disruptions resulting from abrupt modifications of the system.

What the Changelog Covers

Our changelog includes notifications regarding structural changes to the data model, metadata descriptions, and API functionality.

The addition and modification of datasets is so common that it is not included in the changelog to avoid generating noise (we may publish updates regarding particularly disruptive changes in datasets). To view our recently added datasets, visit our data sources index.

Dataset removals, however, will be included in the change log to provide an explanation of the reasons for why it's been expunged. The removal of datasets is often driven by external factors, such as the original source having ceased publishing the data or having modified its terms of use in a way that prevents us from re-using the source.

Notification policy

ComponentAdditionsRemovals
Data model
(e.g., properties & entity types)
On effective date
3 months' notice for name changes
3 months prior to effective date
Metadata structureOn effective date3 months prior to effective date
DatasetsSee here2 months prior (except legal requirements)
Hosted API
(i.e., api.opensanctions.org)
On release date3 months prior to effective date
Self-hosted APIOn release dateAs major semantic version change
Export formats
(e.g., specific export formats)
On release date3 months prior to effective date
Possible extension

Considerations for integrators

When integrating OpenSanctions into your own service, product or workflow, please consider the following principles:

  • Follow the Changelog (RSS Link) and/or subscribe to the monthly newsletter in order to be aware of upcoming and planned changes. Please feel free to reach out to the team if any announced changes raise concerns or require clarification.
  • The addition of new datasets should not require changes on your end. Use the dataset metadata and dataset catalog to automatically fetch descriptive information. New datasets are added on at least a weekly cadence.
  • Similarly, additions to the data model, such as new entity types (schemata) and properties associated with entity types should be ignored until they can be handled explicitly.
  • For users of the self-hosted API, each major version of the yente software has a service life of one year. After that period, the metadata and data structure of newly published data versions may no longer be compatible with the import mechanism in old software releases. We recommend more frequent updates of the yente software for security and stability purposes.

For details on how changes may affect your use of our services, please also refer to section 2.4 of our General Terms and Conditions.

Feedback and Support

We encourage you to reach out if you have any questions or need assistance:

  • Slack Community: Join our Slack channel to engage with our team and other users. We announce notable updates in our General channel there.
  • Email Support: Contact us at support@opensanctions.org for any questions or feedback regarding changes.
  • GitHub Releases: Technical updates to our software are also documented on our GitHub.