Getting started with the API

The most common thing you'll want to do with the API is to screen a set of people or companies for their presence on a watchlist. Get started by:

• Follow the matching tutorial. You'll find out how to compose a query, and how to interpret the response. You'll also begin to authenticate requests using your API key.
• Browse the full API documentation for a detailed overview of the functionality that is available. There's also an OpenAPI JSON spec that you can use the generate an API client in your favorite language.
• Dig into the detailed data dictionary to learn types of entities, properties and relationships are used in the data.
• There's a search API for building full-text search solutions.
  • Learn about when to use /match and /search.
• Explore the Frequently Asked Questions regarding the API and data format.
• Most important: our support team is excited to work with you and answer your questions.

You don't have an API key yet? Sign up to create an API key or learn more about the API. If you sign up using a business email address, a free trial key will be generated for you. Also: find out how if you might qualify for a free API key.

Next steps#

Once you've performed your first set of requests against the API, here's some more in-depth resources you might be interested in:

• Accessing and using the nested relationship data in our API (e.g. to see sanctions details, family and business relationships, etc.), which isn't included in the initial /search and /match responses.
• Learn how to fine-tune the scoring system and define query filters to fit your use case and reduce the number of false matches in response to your queries.
• There's matches! Understand entity risk tagging and sanctions programs to determine if a match result is sanctioned, sanction-linked, a PEP or some other category of risk.
• Once you've integrated the API, check if running the service on-premise is a better option for you in terms of privacy, scaling and pricing.

Commercials#

The OpenSanctions API has very simple, transparent pricing. Our simple pay-as-you-go metering model gives you full flexibility, and doesn't lock you into any contracts.

• Find more details in the commercial section of the FAQ.
• Please feel free to set up a call with us to discuss pricing. We're keen to discuss volume use discounts starting at 20,000 req/mo.
• Visit your account page to view usage statistics and manage your API key, configure billing details, etc.