How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

OpenSanctions Screening API

REST API for screening people, companies, vessels and other entities against sanctions, watchlist and PEP data. Query-by-example matching returns scored candidates with per-feature explanations; free-text search, entity fetch with graph traversal, statement-level provenance and an OpenRefine reconciliation manifest round out the surface. Authenticated with an `Authorization: ApiKey ` header and metered per logical query.

This API exposes 12 operations across 12 paths, organized into 4 resource areas, and defines 42 schemas. It is described by OpenAPI 3.1.0, at version yente 5.5.0.

Requests are made against a single base URL, https://api.opensanctions.org.

12 operations 12 paths 42 schemas 10 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
yente 5.5.0
Base URL
https://api.opensanctions.org
Terms of Service
Resource Areas
4

Paths & Operations 12

Across 12 paths, the API surfaces 12 operations — 10 GET, 2 POST. They span 4 resource areas: Matching, Data access, Reconciliation, System information. Each is listed below with its method, path, parameters, and response codes.

Matching 2

Endpoints for conducting a user-facing entity search or matching a local data store against the given dataset.

POST
/match/{dataset}
Query by example matcher
match_match__dataset__post 11 params body → 200400500422
GET
/search/{dataset}
Simple entity search
search_search__dataset__get 19 params → 200400500422
Data access 5

Endpoints for fetching data from the API, either related to individual entities, or for bulk data access in various forms.

GET
/entities/{entity_id}
Fetch Entity
fetch_entity_entities__entity_id__get 2 params → 200308404500422
GET
/entities/{entity_id}/adjacent
Fetch Adjacent Entities
Fetch_Adjacent_Entities__entities__entity_id__adjacent_get 4 params → 200308404500422
GET
/entities/{entity_id}/adjacent/{property_name}
Fetch Adjacent By Property
Fetch_Adjacent_by_Property__entities__entity_id__adjacent__property_name__get 5 params → 200308404500422
GET
/catalog
Data catalog
catalog_catalog_get → 200304
GET
/statements
Statement-based records
statements_statements_get 10 params → 200422
Reconciliation 1

The Reconciliation Service provides four separate endpoints that work in concert to implement the data matching API used by OpenRefine, Wikidata and several other services and uti…

GET
/reconcile/{dataset}
Reconciliation manifest
reconcile_reconcile__dataset__get 1 param → 200400500422
System information 4

Service metadata endpoints for health checking and getting the application metadata to be used in client applications.

GET
/healthz
Health check
healthz_healthz_get → 200500
GET
/readyz
Search index readiness check
readyz_readyz_get → 200503
GET
/algorithms
Algorithms
algorithms_algorithms_get → 200
POST
/updatez
Force an index update
force_update_updatez_post 2 params → 200403422

Schemas 42

The contract defines 42 schemas that model the data the API accepts and returns. The most detailed are YenteDatasetModel (25 properties), ScoredEntityResponse (13 properties), Statement (13 properties), FreebaseManifest (11 properties). Each schema is shown below with its type and property counts.

AdjacentResultsResponse
object
4 properties 2 required
Algorithm
object
4 properties 3 required
AlgorithmDocs
object
Documentation for a scoring algorithm.
4 properties 3 required
AlgorithmResponse
object
3 properties 3 required
ConfigVar
object
A configuration variable for a scoring algorithm.
3 properties
ConfigVarType
string
The type of a configuration variable.
DataCatalogModel
object
4 properties 3 required
DataCoverage
object
Details on the temporal and geographic scope of a dataset.
5 properties
DataPublisher
object
Publisher information, eg. the government authority.
9 properties 2 required
DataResource
object
A downloadable resource that is part of a dataset.
8 properties 2 required
EntityAdjacentResponse
object
2 properties 2 required
EntityExample
object
3 properties 2 required
EntityMatchQuery
object
3 properties 1 required
EntityMatchResponse
object
2 properties 2 required
EntityMatches
object
4 properties 3 required
EntityResponse
object
10 properties 4 required
ErrorResponse
object
1 property 1 required
Facet
string
FeatureDoc
object
Documentation for a particular feature in the matching API model.
3 properties 3 required
FeatureResult
object
A explained score for a particular feature result.
4 properties 2 required
FreebaseManifest
object
11 properties 11 required
FreebaseManifestExtend
object
2 properties 2 required
FreebaseManifestExtendPropertySetting
object
6 properties 5 required
FreebaseManifestExtendPropertySettingChoice
object
2 properties 2 required
FreebaseManifestExtendProposeProperties
object
2 properties 2 required
FreebaseManifestPreview
object
3 properties 3 required
FreebaseManifestSuggest
object
3 properties 3 required
FreebaseManifestSuggestType
object
2 properties 2 required
FreebaseManifestView
object
1 property 1 required
FreebaseType
object
3 properties 2 required
HTTPValidationError
object
1 property
Operator
string
ScoredEntityResponse
object
13 properties 6 required
SearchFacet
object
2 properties 2 required
SearchFacetItem
object
3 properties 2 required
SearchResponse
object
5 properties 4 required
Statement
object
13 properties 10 required
StatementResponse
object
4 properties 3 required
StatusResponse
object
1 property
TotalSpec
object
2 properties 1 required
ValidationError
object
5 properties 3 required
YenteDatasetModel
object
25 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

opensanctions-api-openapi.yml Raw ↑
Where this information came from

This is an independent, third-party profile of OpenSanctions Screening API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.