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.
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.
Component | Additions | Removals |
---|---|---|
Data model (e.g., properties & entity types) | On effective date 3 months' notice for name changes | 3 months prior to effective date |
Metadata structure | On effective date | 3 months prior to effective date |
Datasets | See here | 2 months prior (except legal requirements) |
Hosted API (i.e., api.opensanctions.org) | On release date | 3 months prior to effective date |
Self-hosted API | On release date | As major semantic version change |
Export formats (e.g., specific export formats) | On release date | 3 months prior to effective date Possible extension |
When integrating OpenSanctions into your own service, product or workflow, please consider the following principles:
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.
We encourage you to reach out if you have any questions or need assistance:
OpenSanctions is free for non-commercial users. Businesses must acquire a data license to use the dataset.