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 System information API

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

OpenSanctions System information API is one of 4 APIs that OpenSanctions publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include System Information. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 4 operations across 4 paths, and defines 10 schemas. It is described by OpenAPI 3.2.0, at version yente 5.5.0.

Requests are made against the base URL https://api.opensanctions.org.

4 operations 4 paths 10 schemas 3 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

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

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 3 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

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 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are ValidationError (5 properties), AlgorithmDocs (4 properties), Algorithm (4 properties), AlgorithmResponse (3 properties). Each schema is shown below with its type and property counts.

ConfigVarType
string
The type of a configuration variable.
StatusResponse
object
1 property
ConfigVar
object
A configuration variable for a scoring algorithm.
3 properties
AlgorithmResponse
object
3 properties 3 required
ErrorResponse
object
1 property 1 required
AlgorithmDocs
object
Documentation for a scoring algorithm.
4 properties 3 required
ValidationError
object
5 properties 3 required
HTTPValidationError
object
1 property
FeatureDoc
object
Documentation for a particular feature in the matching API model.
3 properties 3 required
Algorithm
object
4 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

opensanctions-system-information-api-openapi.yml Raw ↑

Other APIs OpenSanctions publishes across the network.

OpenSanctions Data access API
OpenSanctions Matching API
OpenSanctions Reconciliation API
Where this information came from

This is an independent, third-party profile of OpenSanctions System information 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.