{ "components": { "responses": { "errors": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/errors" } } }, "description": "General Error" } }, "schemas": { "error": { "properties": { "code": { "description": "An application-specific error code, expressed as a string value.", "type": "string" }, "detail": { "description": "A human-readable explanation specific to this occurrence of the problem.", "type": "string" }, "id": { "description": "A unique identifier for this particular occurrence of the problem.", "type": "string" }, "links": { "$ref": "#/components/schemas/links" }, "source": { "properties": { "parameter": { "description": "A string indicating which query parameter caused the error.", "type": "string" }, "pointer": { "description": "A JSON Pointer [RFC6901] to the associated entity in the request document [e.g. \"/data\" for a primary data object, or \"/data/attributes/title\" for a specific attribute].", "type": "string" } }, "type": "object" }, "status": { "description": "The HTTP status code applicable to this problem, expressed as a string value.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", "type": "string" } }, "type": "object" }, "errors": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/error" }, "type": "array" }, "jsonapi": { "additionalProperties": true, "type": "object" }, "links": { "additionalProperties": true, "type": "object" } }, "required": [ "errors" ], "type": "object" }, "link": { "description": "A link MUST be represented as either: a string containing the link's URL or a link object.", "type": "string" }, "links": { "additionalProperties": { "$ref": "#/components/schemas/link" }, "type": "object" }, "sanction_list": { "description": "A \"Resource object\" representing a sanction_list", "properties": { "attributes": { "description": "An attributes object for a sanction_list", "properties": { "active_version_id": { "anyOf": [ { "format": "uuid", "nullable": true, "type": "string" }, { "type": "null" } ], "description": "Field included by default." }, "slug": { "description": "Field included by default.", "type": "string" } }, "required": [ "slug" ], "type": "object" }, "id": { "type": "string" }, "relationships": { "description": "A relationships object for a sanction_list", "properties": { "active_version": { "properties": { "data": { "description": "An identifier for active_version", "nullable": true, "properties": { "id": { "type": "string" }, "meta": { "additionalProperties": true, "type": "object" }, "type": { "type": "string" } }, "required": [ "type", "id" ], "type": "object" } } }, "versions": { "properties": { "data": { "description": "Relationship data for versions", "items": { "description": "Resource identifiers for versions", "properties": { "id": { "type": "string" }, "meta": { "additionalProperties": true, "type": "object" }, "type": { "type": "string" } }, "required": [ "type", "id" ], "type": "object" }, "type": "array", "uniqueItems": true } } } }, "type": "object" }, "type": { "type": "string" } }, "required": [ "type", "id" ], "type": "object" }, "sanction_list-filter": { "description": "Filters the query to results matching the given filter object", "example": "", "properties": { "active_version": { "$ref": "#/components/schemas/sanction_list_version-filter" }, "active_version_id": { "$ref": "#/components/schemas/sanction_list-filter-active_version_id" }, "and": { "items": { "$ref": "#/components/schemas/sanction_list-filter" }, "type": "array", "uniqueItems": true }, "id": { "$ref": "#/components/schemas/sanction_list-filter-id" }, "not": { "$ref": "#/components/schemas/sanction_list-filter" }, "or": { "items": { "$ref": "#/components/schemas/sanction_list-filter" }, "type": "array", "uniqueItems": true }, "slug": { "$ref": "#/components/schemas/sanction_list-filter-slug" }, "versions": { "$ref": "#/components/schemas/sanction_list_version-filter" } }, "type": "object" }, "sanction_list-filter-active_version_id": { "properties": { "eq": { "format": "uuid", "type": "string" }, "greater_than": { "format": "uuid", "type": "string" }, "greater_than_or_equal": { "format": "uuid", "type": "string" }, "in": { "items": { "format": "uuid", "type": "string" }, "type": "array" }, "is_distinct_from": { "format": "uuid", "type": "string" }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "format": "uuid", "type": "string" }, "less_than": { "format": "uuid", "type": "string" }, "less_than_or_equal": { "format": "uuid", "type": "string" }, "not_eq": { "format": "uuid", "type": "string" } }, "type": "object" }, "sanction_list-filter-id": { "properties": { "eq": { "format": "uuid", "type": "string" }, "greater_than": { "format": "uuid", "type": "string" }, "greater_than_or_equal": { "format": "uuid", "type": "string" }, "in": { "items": { "format": "uuid", "type": "string" }, "type": "array" }, "is_distinct_from": { "format": "uuid", "type": "string" }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "format": "uuid", "type": "string" }, "less_than": { "format": "uuid", "type": "string" }, "less_than_or_equal": { "format": "uuid", "type": "string" }, "not_eq": { "format": "uuid", "type": "string" } }, "type": "object" }, "sanction_list-filter-slug": { "properties": { "contains": { "type": "string" }, "eq": { "type": "string" }, "greater_than": { "type": "string" }, "greater_than_or_equal": { "type": "string" }, "ilike": { "type": "string" }, "in": { "items": { "type": "string" }, "type": "array" }, "is_distinct_from": { "type": "string" }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "type": "string" }, "less_than": { "type": "string" }, "less_than_or_equal": { "type": "string" }, "like": { "type": "string" }, "not_eq": { "type": "string" }, "string_ends_with": { "type": "string" }, "string_starts_with": { "type": "string" } }, "type": "object" }, "sanction_list_version": { "description": "A \"Resource object\" representing a sanction_list_version", "properties": { "attributes": { "description": "An attributes object for a sanction_list_version", "properties": { "byte_size": { "description": "Field included by default.", "type": "integer" }, "content_type": { "description": "Field included by default.", "type": "string" }, "fetched_at": { "description": "Field included by default." }, "last_seen_at": { "description": "Field included by default." }, "parser_module": { "description": "Field included by default.", "type": "string" }, "publish_date": { "anyOf": [ { "format": "date", "nullable": true, "type": "string" }, { "type": "null" } ], "description": "Field included by default." }, "record_count": { "description": "Field included by default.", "type": "integer" }, "sha256": { "description": "Field included by default.", "type": "string" }, "source_slug": { "description": "Field included by default.", "type": "string" }, "storage_key": { "description": "Field included by default.", "type": "string" } }, "required": [ "source_slug", "sha256", "record_count", "storage_key", "byte_size", "content_type", "parser_module", "fetched_at", "last_seen_at" ], "type": "object" }, "id": { "type": "string" }, "relationships": { "description": "A relationships object for a sanction_list_version", "properties": {}, "type": "object" }, "type": { "type": "string" } }, "required": [ "type", "id" ], "type": "object" }, "sanction_list_version-filter": { "description": "Filters the query to results matching the given filter object", "example": "", "properties": { "and": { "items": { "$ref": "#/components/schemas/sanction_list_version-filter" }, "type": "array", "uniqueItems": true }, "byte_size": { "$ref": "#/components/schemas/sanction_list_version-filter-byte_size" }, "content_type": { "$ref": "#/components/schemas/sanction_list_version-filter-content_type" }, "fetched_at": { "$ref": "#/components/schemas/sanction_list_version-filter-fetched_at" }, "id": { "$ref": "#/components/schemas/sanction_list_version-filter-id" }, "last_seen_at": { "$ref": "#/components/schemas/sanction_list_version-filter-last_seen_at" }, "not": { "$ref": "#/components/schemas/sanction_list_version-filter" }, "or": { "items": { "$ref": "#/components/schemas/sanction_list_version-filter" }, "type": "array", "uniqueItems": true }, "parser_module": { "$ref": "#/components/schemas/sanction_list_version-filter-parser_module" }, "publish_date": { "$ref": "#/components/schemas/sanction_list_version-filter-publish_date" }, "record_count": { "$ref": "#/components/schemas/sanction_list_version-filter-record_count" }, "sha256": { "$ref": "#/components/schemas/sanction_list_version-filter-sha256" }, "source_slug": { "$ref": "#/components/schemas/sanction_list_version-filter-source_slug" }, "storage_key": { "$ref": "#/components/schemas/sanction_list_version-filter-storage_key" } }, "type": "object" }, "sanction_list_version-filter-byte_size": { "properties": { "eq": { "type": "integer" }, "greater_than": { "type": "integer" }, "greater_than_or_equal": { "type": "integer" }, "in": { "items": { "type": "integer" }, "type": "array" }, "is_distinct_from": { "type": "integer" }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "type": "integer" }, "less_than": { "type": "integer" }, "less_than_or_equal": { "type": "integer" }, "not_eq": { "type": "integer" } }, "type": "object" }, "sanction_list_version-filter-content_type": { "properties": { "contains": { "type": "string" }, "eq": { "type": "string" }, "greater_than": { "type": "string" }, "greater_than_or_equal": { "type": "string" }, "ilike": { "type": "string" }, "in": { "items": { "type": "string" }, "type": "array" }, "is_distinct_from": { "type": "string" }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "type": "string" }, "less_than": { "type": "string" }, "less_than_or_equal": { "type": "string" }, "like": { "type": "string" }, "not_eq": { "type": "string" }, "string_ends_with": { "type": "string" }, "string_starts_with": { "type": "string" } }, "type": "object" }, "sanction_list_version-filter-fetched_at": { "properties": { "eq": {}, "greater_than": {}, "greater_than_or_equal": {}, "in": { "items": {}, "type": "array" }, "is_distinct_from": {}, "is_nil": { "type": "boolean" }, "is_not_distinct_from": {}, "less_than": {}, "less_than_or_equal": {}, "not_eq": {} }, "type": "object" }, "sanction_list_version-filter-id": { "properties": { "eq": { "format": "uuid", "type": "string" }, "greater_than": { "format": "uuid", "type": "string" }, "greater_than_or_equal": { "format": "uuid", "type": "string" }, "in": { "items": { "format": "uuid", "type": "string" }, "type": "array" }, "is_distinct_from": { "format": "uuid", "type": "string" }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "format": "uuid", "type": "string" }, "less_than": { "format": "uuid", "type": "string" }, "less_than_or_equal": { "format": "uuid", "type": "string" }, "not_eq": { "format": "uuid", "type": "string" } }, "type": "object" }, "sanction_list_version-filter-last_seen_at": { "properties": { "eq": {}, "greater_than": {}, "greater_than_or_equal": {}, "in": { "items": {}, "type": "array" }, "is_distinct_from": {}, "is_nil": { "type": "boolean" }, "is_not_distinct_from": {}, "less_than": {}, "less_than_or_equal": {}, "not_eq": {} }, "type": "object" }, "sanction_list_version-filter-parser_module": { "properties": { "contains": { "type": "string" }, "eq": { "type": "string" }, "greater_than": { "type": "string" }, "greater_than_or_equal": { "type": "string" }, "ilike": { "type": "string" }, "in": { "items": { "type": "string" }, "type": "array" }, "is_distinct_from": { "type": "string" }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "type": "string" }, "less_than": { "type": "string" }, "less_than_or_equal": { "type": "string" }, "like": { "type": "string" }, "not_eq": { "type": "string" }, "string_ends_with": { "type": "string" }, "string_starts_with": { "type": "string" } }, "type": "object" }, "sanction_list_version-filter-publish_date": { "properties": { "eq": { "format": "date", "type": "string" }, "greater_than": { "format": "date", "type": "string" }, "greater_than_or_equal": { "format": "date", "type": "string" }, "in": { "items": { "format": "date", "type": "string" }, "type": "array" }, "is_distinct_from": { "format": "date", "type": "string" }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "format": "date", "type": "string" }, "less_than": { "format": "date", "type": "string" }, "less_than_or_equal": { "format": "date", "type": "string" }, "not_eq": { "format": "date", "type": "string" } }, "type": "object" }, "sanction_list_version-filter-record_count": { "properties": { "eq": { "type": "integer" }, "greater_than": { "type": "integer" }, "greater_than_or_equal": { "type": "integer" }, "in": { "items": { "type": "integer" }, "type": "array" }, "is_distinct_from": { "type": "integer" }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "type": "integer" }, "less_than": { "type": "integer" }, "less_than_or_equal": { "type": "integer" }, "not_eq": { "type": "integer" } }, "type": "object" }, "sanction_list_version-filter-sha256": { "properties": { "contains": { "type": "string" }, "eq": { "type": "string" }, "greater_than": { "type": "string" }, "greater_than_or_equal": { "type": "string" }, "ilike": { "type": "string" }, "in": { "items": { "type": "string" }, "type": "array" }, "is_distinct_from": { "type": "string" }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "type": "string" }, "less_than": { "type": "string" }, "less_than_or_equal": { "type": "string" }, "like": { "type": "string" }, "not_eq": { "type": "string" }, "string_ends_with": { "type": "string" }, "string_starts_with": { "type": "string" } }, "type": "object" }, "sanction_list_version-filter-source_slug": { "properties": { "contains": { "type": "string" }, "eq": { "type": "string" }, "greater_than": { "type": "string" }, "greater_than_or_equal": { "type": "string" }, "ilike": { "type": "string" }, "in": { "items": { "type": "string" }, "type": "array" }, "is_distinct_from": { "type": "string" }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "type": "string" }, "less_than": { "type": "string" }, "less_than_or_equal": { "type": "string" }, "like": { "type": "string" }, "not_eq": { "type": "string" }, "string_ends_with": { "type": "string" }, "string_starts_with": { "type": "string" } }, "type": "object" }, "sanction_list_version-filter-storage_key": { "properties": { "contains": { "type": "string" }, "eq": { "type": "string" }, "greater_than": { "type": "string" }, "greater_than_or_equal": { "type": "string" }, "ilike": { "type": "string" }, "in": { "items": { "type": "string" }, "type": "array" }, "is_distinct_from": { "type": "string" }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "type": "string" }, "less_than": { "type": "string" }, "less_than_or_equal": { "type": "string" }, "like": { "type": "string" }, "not_eq": { "type": "string" }, "string_ends_with": { "type": "string" }, "string_starts_with": { "type": "string" } }, "type": "object" }, "sanction_screening": { "description": "A \"Resource object\" representing a sanction_screening", "properties": { "attributes": { "description": "An attributes object for a sanction_screening", "properties": {}, "type": "object" }, "id": { "type": "string" }, "relationships": { "description": "A relationships object for a sanction_screening", "properties": {}, "type": "object" }, "type": { "type": "string" } }, "required": [ "type", "id" ], "type": "object" }, "sanction_screening-filter": { "description": "Filters the query to results matching the given filter object", "example": "", "properties": { "and": { "items": { "$ref": "#/components/schemas/sanction_screening-filter" }, "type": "array", "uniqueItems": true }, "not": { "$ref": "#/components/schemas/sanction_screening-filter" }, "or": { "items": { "$ref": "#/components/schemas/sanction_screening-filter" }, "type": "array", "uniqueItems": true } }, "type": "object" } }, "securitySchemes": {} }, "info": { "description": "Screen a name against warmed sanctions lists (OFAC SDN/Consolidated, EU, UN, UK).\nPublic, rate-limited per IP. Responses conform to JSON:API for errors; the\n200 body is the flat `sanction_screening` result.\n", "title": "Sanction Screening API", "version": "1.0.0" }, "openapi": "3.0.0", "paths": { "/api/v1/projects/ss": { "get": { "callbacks": {}, "deprecated": false, "description": "Screen a name against loaded sanctions lists and return any matches that\nclear the given threshold. All work is in-memory: sources must be warmed\non boot before they can be queried (requesting an unready source returns\n503 `sources_not_ready`).\n", "parameters": [ { "description": "Matching algorithm — see enum for per-version guidance.", "in": "query", "name": "algorithm", "required": false, "schema": { "description": "Matching algorithm — see enum for per-version guidance.", "enum": [ "ofac_v5_1", "ofac_v5_0", "ofac_v4_2", "ofac_v4_1", "ofac_v4_0", "ofac_v3", "ofac_v2", "ofac_v1", "exact_normalized" ], "type": "string", "x-enumDescriptions": { "exact_normalized": "No fuzziness. Requires a post-normalization exact match (casefolded, diacritic-stripped).", "ofac_v1": "v1 — plain Jaro-Winkler on the full preprocessed string. Baseline.", "ofac_v2": "v2 — naive token-level Jaro-Winkler, averaged across query tokens.", "ofac_v3": "v3 — token Jaro-Winkler + Soundex secondary gate to reject same-prefix non-matches.", "ofac_v4_0": "v4.0 — adaptive gating: per-token gate for multi-token queries, +0.02 JW offset, short tokens dropped.", "ofac_v4_1": "v4.1 — v4.0 + display-format reversal so 'putin' matches records stored as 'PUTIN, Vladimir'.", "ofac_v4_2": "v4.2 — v4.1 + length-ratio guard on the entity full-string fallback.", "ofac_v5_0": "v5.0 — v4 + residual correction calibrated against OFAC's reported scores.", "ofac_v5_1": "v5.1 — greedy token pairing on top of v5.0. Closest to OFAC's behavior so far. Recommended default." } }, "style": "form" }, { "description": "Filter results by entry type.", "in": "query", "name": "entity_type", "required": false, "schema": { "description": "Filter results by entry type.", "enum": [ "all", "individual", "entity", "vessel", "aircraft" ], "type": "string", "x-enumDescriptions": { "aircraft": "Planes, helicopters, and other aircraft.", "all": "No filtering — return every match.", "entity": "Organizations, companies, government bodies.", "individual": "Natural persons only.", "vessel": "Ships, boats, and other watercraft." } }, "style": "form" }, { "description": "Cap on the number of matches returned, ordered by descending score.", "in": "query", "name": "max_results", "required": false, "schema": { "default": 50, "example": 50, "maximum": 500, "minimum": 1, "type": "integer" }, "style": "form" }, { "description": "Name to screen. Free-form; normalization (casefolding, diacritic stripping) is handled server-side.", "in": "query", "name": "name", "required": true, "schema": { "example": "Vladimir Putin", "minLength": 1, "pattern": "\\S", "type": "string" }, "style": "form" }, { "description": "Comma-separated list of source slugs to search (e.g. `ofac_sdn,eu`). Must contain at least one source. Any requested source not yet indexed causes a 503 response.", "in": "query", "name": "sources", "required": false, "schema": { "default": "ofac_sdn,ofac_cons,eu", "description": "Comma-separated list of source slugs. Supported: ofac_sdn, ofac_cons, eu.", "example": "ofac_sdn,ofac_cons", "pattern": "^(ofac_sdn|ofac_cons|eu)(,(ofac_sdn|ofac_cons|eu))*$", "type": "string" }, "style": "form" }, { "description": "Minimum similarity score for a match to be returned. 1.0 = exact; 0.85 is a sensible default; lower values widen recall at the cost of precision.", "in": "query", "name": "threshold", "required": false, "schema": { "default": 0.85, "example": 0.85, "format": "float", "maximum": 1.0, "minimum": 0.0, "type": "number" }, "style": "form" } ], "responses": { "200": { "content": { "application/vnd.api+json": { "schema": { "properties": { "algorithm": { "description": "Matching algorithm that produced these results. Field included by default.", "type": "string" }, "matches": { "anyOf": [ { "items": { "properties": { "entry": { "description": "The sanctions list entry that matched, in the unified format. Field included by default.", "properties": { "addresses": { "anyOf": [ { "items": { "properties": { "city": { "anyOf": [ { "nullable": true, "type": "string" }, { "type": "null" } ], "description": "City or locality. Field included by default." }, "country": { "anyOf": [ { "nullable": true, "type": "string" }, { "type": "null" } ], "description": "Country name as published by the source list. Field included by default." }, "country_code": { "anyOf": [ { "nullable": true, "type": "string" }, { "type": "null" } ], "description": "ISO 3166-1 alpha-2 country code when available. Field included by default." }, "note": { "anyOf": [ { "nullable": true, "type": "string" }, { "type": "null" } ], "description": "Free-form address qualifier (e.g. \"last known\", \"business\"). Field included by default." }, "postal_code": { "anyOf": [ { "nullable": true, "type": "string" }, { "type": "null" } ], "description": "Postal or ZIP code. Field included by default." }, "region": { "anyOf": [ { "nullable": true, "type": "string" }, { "type": "null" } ], "description": "State, province, oblast, or other sub-national region. Field included by default." }, "street": { "anyOf": [ { "nullable": true, "type": "string" }, { "type": "null" } ], "description": "Street line, including house or building number. Field included by default." } }, "type": "object" }, "nullable": true, "type": "array" }, { "type": "null" } ], "description": "Known addresses associated with the entry. Field included by default." }, "aliases": { "anyOf": [ { "items": { "properties": { "language": { "anyOf": [ { "nullable": true, "type": "string" }, { "type": "null" } ], "description": "Language of the alias as a free-form string or ISO 639 code. Field included by default." }, "name": { "description": "The alias name as published by the sanctions authority. Field included by default.", "type": "string" }, "quality": { "anyOf": [ { "enum": [ "strong", "weak" ], "nullable": true, "type": "string", "x-enumDescriptions": { "strong": "High-confidence alias — should be screened against.", "weak": "Low-confidence alias — often legitimate different persons share it; treat with caution." } }, { "type": "null" } ], "description": "Confidence tier for the alias. Field included by default." }, "script": { "anyOf": [ { "nullable": true, "type": "string" }, { "type": "null" } ], "description": "Writing system of the alias (e.g. `Latin`, `Cyrillic`, `Arabic`). Field included by default." }, "type": { "anyOf": [ { "enum": [ "aka", "fka", "nka", "primary" ], "nullable": true, "type": "string", "x-enumDescriptions": { "aka": "Also-known-as — a currently used alternate name.", "fka": "Formerly-known-as — a historical name no longer in use.", "nka": "Now-known-as — a successor name.", "primary": "The canonical primary name of the entry." } }, { "type": "null" } ], "description": "Relationship of this alias to the entry's primary name. Field included by default." } }, "required": [ "name" ], "type": "object" }, "nullable": true, "type": "array" }, { "type": "null" } ], "description": "Alternate names (aka/fka/nka) published by the source. Field included by default." }, "citizenships": { "anyOf": [ { "items": { "type": "string" }, "nullable": true, "type": "array" }, { "type": "null" } ], "description": "Citizenships — distinct from nationalities in sources that track them separately. Field included by default." }, "contact": { "anyOf": [ { "nullable": true, "properties": { "crypto_addresses": { "anyOf": [ { "nullable": true, "type": "object" }, { "type": "null" } ], "description": "Map of cryptocurrency network to addresses, keyed by ticker (e.g. `%{\"XBT\" => [\"1...\"], \"ETH\" => [\"0x...\"]}`). Field included by default." }, "emails": { "anyOf": [ { "items": { "type": "string" }, "nullable": true, "type": "array" }, { "type": "null" } ], "description": "Known email addresses. Field included by default." }, "phones": { "anyOf": [ { "items": { "type": "string" }, "nullable": true, "type": "array" }, { "type": "null" } ], "description": "Known telephone numbers in E.164 or raw source format. Field included by default." }, "swift_bic": { "anyOf": [ { "nullable": true, "type": "string" }, { "type": "null" } ], "description": "SWIFT/BIC code, typically present only for financial-institution entries. Field included by default." }, "websites": { "anyOf": [ { "items": { "type": "string" }, "nullable": true, "type": "array" }, { "type": "null" } ], "description": "URLs of websites operated by or linked to the entity. Field included by default." } }, "type": "object" }, { "type": "null" } ], "description": "Phones, emails, websites, and crypto addresses linked to the entry. Field included by default." }, "cross_references": { "anyOf": [ { "nullable": true, "properties": { "eu_reference": { "anyOf": [ { "nullable": true, "type": "string" }, { "type": "null" } ], "description": "EU Council Regulation reference (e.g. `EU.12345.67`). Field included by default." }, "ofac_uid": { "anyOf": [ { "nullable": true, "type": "string" }, { "type": "null" } ], "description": "OFAC Unique Identifier, persistent across SDN/Consolidated list updates. Field included by default." }, "ofsi_group_id": { "anyOf": [ { "nullable": true, "type": "string" }, { "type": "null" } ], "description": "UK OFSI group identifier grouping related target records. Field included by default." }, "un_reference": { "anyOf": [ { "nullable": true, "type": "string" }, { "type": "null" } ], "description": "UN Security Council Consolidated List permanent reference (e.g. `QDi.001`). Field included by default." } }, "type": "object" }, { "type": "null" } ], "description": "Foreign keys into other sanctions lists (OFAC UID, UN reference, EU reference, OFSI group id) — useful for reconciling the same target across sources. Field included by default." }, "dates_of_birth": { "anyOf": [ { "items": { "properties": { "approximate?": { "anyOf": [ { "nullable": true, "type": "boolean" }, { "type": "null" } ], "description": "True when the source indicates the date is estimated (e.g. \"circa 1960\"), not confirmed. Field included by default." }, "calendar": { "anyOf": [ { "enum": [ "gregorian", "islamic" ], "nullable": true, "type": "string", "x-enumDescriptions": { "gregorian": "Gregorian (western) calendar.", "islamic": "Islamic (Hijri) calendar." } }, { "type": "null" } ], "description": "Calendar system the date is expressed in. Field included by default." }, "date": { "anyOf": [ { "format": "date", "nullable": true, "type": "string" }, { "type": "null" } ], "description": "Exact date of birth when known. Field included by default." }, "from_year": { "anyOf": [ { "nullable": true, "type": "integer" }, { "type": "null" } ], "description": "Lower bound of a year range when only an approximate span is published. Field included by default." }, "to_year": { "anyOf": [ { "nullable": true, "type": "integer" }, { "type": "null" } ], "description": "Upper bound of a year range when only an approximate span is published. Field included by default." }, "year": { "anyOf": [ { "nullable": true, "type": "integer" }, { "type": "null" } ], "description": "Year of birth when only the year is known. Field included by default." } }, "type": "object" }, "nullable": true, "type": "array" }, { "type": "null" } ], "description": "One or more dates (or year ranges) of birth. Always an array; some lists publish multiple. Field included by default." }, "documents": { "anyOf": [ { "items": { "properties": { "expiry_date": { "anyOf": [ { "format": "date", "nullable": true, "type": "string" }, { "type": "null" } ], "description": "Date the document expires or expired. Field included by default." }, "issued_date": { "anyOf": [ { "format": "date", "nullable": true, "type": "string" }, { "type": "null" } ], "description": "Date the document was issued. Field included by default." }, "issuing_authority": { "anyOf": [ { "nullable": true, "type": "string" }, { "type": "null" } ], "description": "Issuing authority or agency, when named by the source. Field included by default." }, "issuing_country": { "anyOf": [ { "nullable": true, "type": "string" }, { "type": "null" } ], "description": "Country of issue (free-form; ISO code when available in the source). Field included by default." }, "note": { "anyOf": [ { "nullable": true, "type": "string" }, { "type": "null" } ], "description": "Free-form qualifier (e.g. \"Issued in exile\", \"Previous number\"). Field included by default." }, "number": { "anyOf": [ { "nullable": true, "type": "string" }, { "type": "null" } ], "description": "Document number as published; redaction and formatting follow the source. Field included by default." }, "type": { "anyOf": [ { "enum": [ "passport", "national_id", "tax_id", "ssn", "drivers_license", "business_reg", "vessel_reg", "imo", "swift_bic", "other" ], "nullable": true, "type": "string", "x-enumDescriptions": { "business_reg": "Business registration number.", "drivers_license": "Driver's license.", "imo": "IMO number (7-digit permanent vessel identifier).", "national_id": "National identity card.", "other": "Anything not covered above — see `type_detail` for specifics.", "passport": "Passport.", "ssn": "Social security / social insurance number.", "swift_bic": "SWIFT/BIC financial institution code.", "tax_id": "Taxpayer identification number.", "vessel_reg": "Vessel registration document." } }, { "type": "null" } ], "description": "Document kind. Use `other` with `type_detail` when no category fits. Field included by default." }, "type_detail": { "anyOf": [ { "nullable": true, "type": "string" }, { "type": "null" } ], "description": "Free-form refinement of `type` (e.g. \"Diplomatic Passport\"). Field included by default." }, "validity": { "anyOf": [ { "enum": [ "valid", "fraudulent", "expired", "lost", "revoked" ], "nullable": true, "type": "string", "x-enumDescriptions": { "expired": "Document has passed its expiry date.", "fraudulent": "Document is known to be fraudulent.", "lost": "Document reported lost.", "revoked": "Document revoked by the issuing authority.", "valid": "Document is currently valid as far as the source knows." } }, { "type": "null" } ], "description": "Current status of the document as reported by the source. Field included by default." } }, "type": "object" }, "nullable": true, "type": "array" }, { "type": "null" } ], "description": "Identity documents (passports, national IDs, tax IDs, etc.) published by the source. Field included by default." }, "entity_info": { "anyOf": [ { "nullable": true, "properties": { "entity_type": { "anyOf": [ { "nullable": true, "type": "string" }, { "type": "null" } ], "description": "Source-published organization type (e.g. \"Limited liability company\", \"Government entity\"). Distinct from the top-level `entity_type` enum. Field included by default." }, "parent_company": { "anyOf": [ { "nullable": true, "type": "string" }, { "type": "null" } ], "description": "Name of the parent corporation or owning entity, if disclosed. Field included by default." }, "registration_numbers": { "anyOf": [ { "items": { "type": "string" }, "nullable": true, "type": "array" }, { "type": "null" } ], "description": "Corporate registry / tax / trade-register numbers as published. Field included by default." }, "subsidiaries": { "anyOf": [ { "items": { "type": "string" }, "nullable": true, "type": "array" }, { "type": "null" } ], "description": "Names of known subsidiary or controlled entities. Field included by default." } }, "type": "object" }, { "type": "null" } ], "description": "Corporate-specific details; typically populated only when `entity_type` is `entity`. Field included by default." }, "entity_type": { "description": "High-level classification of the listed entity. Field included by default.", "enum": [ "individual", "entity", "vessel", "aircraft" ], "type": "string", "x-enumDescriptions": { "aircraft": "A plane, helicopter, or other aircraft.", "entity": "An organization, company, or government body.", "individual": "A natural person.", "vessel": "A ship, boat, or other watercraft." } }, "gender": { "anyOf": [ { "enum": [ "male", "female" ], "nullable": true, "type": "string", "x-enumDescriptions": { "female": "Female, as recorded by the source.", "male": "Male, as recorded by the source." } }, { "type": "null" } ], "description": "Gender as recorded by the source list. Field included by default." }, "id": { "description": "Stable identifier within the source list (e.g. OFAC UID, EU reference). Field included by default.", "type": "string" }, "legal_basis": { "anyOf": [ { "nullable": true, "type": "string" }, { "type": "null" } ], "description": "Citation of the regulation, executive order, or resolution authorizing the listing. Field included by default." }, "listed_on": { "anyOf": [ { "format": "date", "nullable": true, "type": "string" }, { "type": "null" } ], "description": "Date the entry was first added to the list. Field included by default." }, "measures": { "anyOf": [ { "items": { "type": "string" }, "nullable": true, "type": "array" }, { "type": "null" } ], "description": "Specific restrictive measures applied — e.g. \"asset_freeze\", \"travel_ban\". Distinct from `programs`, which are bucket identifiers. Field included by default." }, "name_parts": { "anyOf": [ { "nullable": true, "properties": { "first_name": { "anyOf": [ { "nullable": true, "type": "string" }, { "type": "null" } ], "description": "Given name. Field included by default." }, "last_name": { "anyOf": [ { "nullable": true, "type": "string" }, { "type": "null" } ], "description": "Family name / surname. Field included by default." }, "maiden_name": { "anyOf": [ { "nullable": true, "type": "string" }, { "type": "null" } ], "description": "Maiden surname, when published separately from `last_name`. Field included by default." }, "matronymic": { "anyOf": [ { "nullable": true, "type": "string" }, { "type": "null" } ], "description": "Matronymic (name derived from the mother), e.g. in Icelandic naming. Field included by default." }, "middle_name": { "anyOf": [ { "nullable": true, "type": "string" }, { "type": "null" } ], "description": "Middle name or initial. Field included by default." }, "patronymic": { "anyOf": [ { "nullable": true, "type": "string" }, { "type": "null" } ], "description": "Patronymic (name derived from the father), common in Slavic naming conventions. Field included by default." } }, "type": "object" }, { "type": "null" } ], "description": "Decomposed given/family/patronymic components when the source provides them. Field included by default." }, "nationalities": { "anyOf": [ { "items": { "type": "string" }, "nullable": true, "type": "array" }, { "type": "null" } ], "description": "Nationalities held by the individual, most-recent/primary first when ordering is implied. Field included by default." }, "places_of_birth": { "anyOf": [ { "items": { "properties": { "city": { "anyOf": [ { "nullable": true, "type": "string" }, { "type": "null" } ], "description": "City or town of birth. Field included by default." }, "country": { "anyOf": [ { "nullable": true, "type": "string" }, { "type": "null" } ], "description": "Country of birth as published. Field included by default." }, "country_code": { "anyOf": [ { "nullable": true, "type": "string" }, { "type": "null" } ], "description": "ISO 3166-1 alpha-2 country code of the place of birth when available. Field included by default." }, "region": { "anyOf": [ { "nullable": true, "type": "string" }, { "type": "null" } ], "description": "State, province, or other sub-national region of birth. Field included by default." } }, "type": "object" }, "nullable": true, "type": "array" }, { "type": "null" } ], "description": "One or more places of birth. Field included by default." }, "positions": { "anyOf": [ { "items": { "type": "string" }, "nullable": true, "type": "array" }, { "type": "null" } ], "description": "Official roles or positions the person holds or held. Field included by default." }, "primary_name": { "description": "Canonical name as published by the sanctions authority. Field included by default.", "type": "string" }, "programs": { "anyOf": [ { "items": { "type": "string" }, "nullable": true, "type": "array" }, { "type": "null" } ], "description": "Program codes under which the listing is maintained (e.g. OFAC programs `SDGT`, `UKRAINE-EO13662`). Field included by default." }, "remarks": { "anyOf": [ { "nullable": true, "type": "string" }, { "type": "null" } ], "description": "Free-form remarks from the source, often conveying provenance or context. Field included by default." }, "source": { "description": "Sanctions list the entry comes from. Field included by default.", "enum": [ "ofac_sdn", "ofac_cons", "eu" ], "type": "string", "x-enumDescriptions": { "eu": "EU Consolidated Financial Sanctions List.", "ofac_cons": "OFAC Consolidated Sanctions List — non-SDN US Treasury restrictions.", "ofac_sdn": "OFAC Specially Designated Nationals list (US Treasury)." } }, "titles": { "anyOf": [ { "items": { "type": "string" }, "nullable": true, "type": "array" }, { "type": "null" } ], "description": "Honorifics and ranks (e.g. \"Major General\", \"Dr.\"). Field included by default." }, "transport_info": { "anyOf": [ { "nullable": true, "properties": { "call_sign": { "anyOf": [ { "nullable": true, "type": "string" }, { "type": "null" } ], "description": "Radio call sign assigned to the vessel or aircraft. Field included by default." }, "construction_number": { "anyOf": [ { "nullable": true, "type": "string" }, { "type": "null" } ], "description": "Construction or build number as assigned by the shipyard or plant. Field included by default." }, "flag": { "anyOf": [ { "nullable": true, "type": "string" }, { "type": "null" } ], "description": "Current flag state (country of registration). Field included by default." }, "former_flags": { "anyOf": [ { "items": { "type": "string" }, "nullable": true, "type": "array" }, { "type": "null" } ], "description": "Previously held flags, newest first. Field included by default." }, "gross_tonnage": { "anyOf": [ { "nullable": true, "type": "string" }, { "type": "null" } ], "description": "Gross tonnage as published. Field included by default." }, "hull_id": { "anyOf": [ { "nullable": true, "type": "string" }, { "type": "null" } ], "description": "Hull identification number or keel laying reference. Field included by default." }, "imo_number": { "anyOf": [ { "nullable": true, "type": "string" }, { "type": "null" } ], "description": "IMO number — permanent 7-digit vessel identifier. Field included by default." }, "length": { "anyOf": [ { "nullable": true, "type": "string" }, { "type": "null" } ], "description": "Overall length as published (unit varies by source). Field included by default." }, "manufacturer_serial": { "anyOf": [ { "nullable": true, "type": "string" }, { "type": "null" } ], "description": "MSN — manufacturer serial number specific to aircraft. Field included by default." }, "mmsi": { "anyOf": [ { "nullable": true, "type": "string" }, { "type": "null" } ], "description": "Maritime Mobile Service Identity — 9-digit radio identifier used by AIS. Field included by default." }, "model": { "anyOf": [ { "nullable": true, "type": "string" }, { "type": "null" } ], "description": "Aircraft or vessel model designation. Field included by default." }, "operator": { "anyOf": [ { "nullable": true, "type": "string" }, { "type": "null" } ], "description": "Current operator of the craft when distinct from owner. Field included by default." }, "serial_number": { "anyOf": [ { "nullable": true, "type": "string" }, { "type": "null" } ], "description": "Manufacturer serial number. Field included by default." }, "tail_number": { "anyOf": [ { "nullable": true, "type": "string" }, { "type": "null" } ], "description": "Aircraft tail number (ICAO/registration). Field included by default." }, "tonnage": { "anyOf": [ { "nullable": true, "type": "string" }, { "type": "null" } ], "description": "Deadweight tonnage as published; kept as string because sources use mixed units. Field included by default." }, "transponder_code": { "anyOf": [ { "nullable": true, "type": "string" }, { "type": "null" } ], "description": "Aircraft transponder (squawk) code, when published. Field included by default." }, "vessel_type": { "anyOf": [ { "nullable": true, "type": "string" }, { "type": "null" } ], "description": "Vessel category (e.g. \"Oil tanker\", \"Cargo\"). Field included by default." }, "year_built": { "anyOf": [ { "nullable": true, "type": "string" }, { "type": "null" } ], "description": "Year the vessel or aircraft was built; string to preserve ranges (\"1995–1997\"). Field included by default." } }, "type": "object" }, { "type": "null" } ], "description": "Vessel- or aircraft-specific details; populated when `entity_type` is `vessel` or `aircraft`. Field included by default." } }, "required": [ "id", "source", "entity_type", "primary_name" ], "type": "object" }, "list_version": { "description": "Version identifier of the source list used to produce this match, useful for audit/replay. Field included by default.", "type": "string" }, "matched_name": { "description": "The specific name on the entry that scored the match (primary name or one of the aliases). Field included by default.", "type": "string" }, "score": { "description": "Similarity score in the range 0.0–1.0. Higher is a closer match. Field included by default.", "format": "float", "type": "number" } }, "required": [ "entry", "matched_name", "score", "list_version" ], "type": "object" }, "nullable": true, "type": "array" }, { "type": "null" } ], "description": "Matches that cleared `threshold`, ordered by descending `score`. Field included by default." }, "preprocessed_query": { "description": "The query after normalization (casefolding, diacritic stripping, etc.) — the form that was actually compared against list entries. Field included by default.", "type": "string" }, "query": { "description": "The original name submitted by the caller, unchanged. Field included by default.", "type": "string" }, "searched_lists": { "anyOf": [ { "items": { "type": "string" }, "nullable": true, "type": "array" }, { "type": "null" } ], "description": "Slug list of the sanction sources actually searched (e.g. `[\"ofac_sdn\"]`). Mirrors the requested `sources` once validity is checked. Field included by default." }, "threshold": { "description": "Minimum score a match had to clear to be included in `matches`. Field included by default.", "format": "float", "type": "number" }, "total_matches": { "anyOf": [ { "nullable": true, "type": "integer" }, { "type": "null" } ], "description": "Number of entries in `matches`. Present for clients that paginate client-side. Field included by default." } }, "required": [ "query", "preprocessed_query", "algorithm", "threshold" ], "type": "object" } } }, "description": "Success" }, "422": { "content": { "application/vnd.api+json": { "schema": { "properties": { "errors": { "items": { "properties": { "code": { "type": "string" }, "detail": { "type": "string" }, "id": { "type": "string" }, "links": { "additionalProperties": true, "type": "object" }, "meta": { "additionalProperties": true, "type": "object" }, "source": { "properties": { "parameter": { "type": "string" }, "pointer": { "type": "string" } }, "type": "object" }, "status": { "type": "string" }, "title": { "type": "string" } }, "type": "object" }, "type": "array" }, "jsonapi": { "additionalProperties": true, "type": "object" } }, "required": [ "errors" ], "type": "object" } } }, "description": "Validation failed — a query parameter is missing, malformed, or out of range." }, "429": { "content": { "application/vnd.api+json": { "schema": { "properties": { "errors": { "items": { "properties": { "code": { "type": "string" }, "detail": { "type": "string" }, "id": { "type": "string" }, "links": { "additionalProperties": true, "type": "object" }, "meta": { "additionalProperties": true, "type": "object" }, "source": { "properties": { "parameter": { "type": "string" }, "pointer": { "type": "string" } }, "type": "object" }, "status": { "type": "string" }, "title": { "type": "string" } }, "type": "object" }, "type": "array" }, "jsonapi": { "additionalProperties": true, "type": "object" } }, "required": [ "errors" ], "type": "object" } } }, "description": "Rate limit exceeded. Retry after the duration advertised in the `Retry-After` header." }, "503": { "content": { "application/vnd.api+json": { "schema": { "properties": { "errors": { "items": { "properties": { "code": { "type": "string" }, "detail": { "type": "string" }, "id": { "type": "string" }, "links": { "additionalProperties": true, "type": "object" }, "meta": { "additionalProperties": true, "type": "object" }, "source": { "properties": { "parameter": { "type": "string" }, "pointer": { "type": "string" } }, "type": "object" }, "status": { "type": "string" }, "title": { "type": "string" } }, "type": "object" }, "type": "array" }, "jsonapi": { "additionalProperties": true, "type": "object" } }, "required": [ "errors" ], "type": "object" } } }, "description": "One or more requested sources have not finished warming. See the `sources_not_ready` error's `meta.pending` list." }, "default": { "$ref": "#/components/responses/errors" } }, "summary": "Screen a name against sanctions lists", "tags": [ "sanction_screening" ] } }, "/api/v1/sanction-lists": { "get": { "callbacks": {}, "deprecated": false, "description": "/sanction-lists operation on sanction_list resource", "parameters": [ { "description": "Relationship paths to include in the response", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "pattern": "^(active_version)(,(active_version))*$", "type": "string" }, "style": "form" } ], "responses": { "200": { "content": { "application/vnd.api+json": { "schema": { "properties": { "data": { "description": "An array of resource objects representing a sanction_list", "items": { "$ref": "#/components/schemas/sanction_list" }, "type": "array", "uniqueItems": true }, "included": { "items": { "oneOf": [ { "$ref": "#/components/schemas/sanction_list_version" } ] }, "type": "array", "uniqueItems": true }, "meta": { "additionalProperties": true, "type": "object" } }, "type": "object" } } }, "description": "Success" }, "default": { "$ref": "#/components/responses/errors" } }, "tags": [ "sanction_list" ] } } }, "security": [], "servers": [ { "url": "https://aight.blog", "variables": {} } ], "tags": [] }