yente is an open source screening API service. It provides functions to search, retrieve or match FollowTheMoney entities, including people, companies or vessels that are subject to international sanctions.
yente: Intro · Deployment · Settings · Custom datasets · FAQ
The yente API is built to provide access to OpenSanctions data, it can also be used to search and match other data, such as company registries or custom watchlists.
yente is the open source core code base for the OpenSanctions API, it can also be run on-premises as a KYC appliance so that no customer data leaves the deployment context. The software is distributed as a Docker image with a pre-defined
docker-compose.yml configuration that also provisions the requisite ElasticSearch index.
Note: this documentation is only relevant to users who plan to self-host the API. Click here if you'd prefer to use our hosted API service.
Here is a very quick tour of how
data.opensanctions.orgwhich states the latest version of the OpenSanctions data that was been released.
data.opensanctions.org(a 500MB+ JSON file) and store it onto the
/tmpvolume of the container.
yentewill create an ES index alias from
yente-entities-allto the latest snapshot of the index (e.g.
yente-entities-all-00220221030xxxx) and delete all older snapshots of the index.
/matchAPIs work correctly. On the plus side, any future updates to the data will be indexed first, and the switch-over to the new data will be instantaneous.
OpenSanctions is free for non-commercial users. Businesses must acquire a data license to use the dataset.