removedOutput schema / properties / checked_at
Removed value: -{
- "description": "ISO-8601 timestamp of the screening.",
- "type": "string"
-}
addedOutput schema / properties / disclaimer
Added value: +{
+ "type": [
+ "string",
+ "null"
+ ]
+}
addedOutput schema / properties / indexUpdated
Added value: +{
+ "additionalProperties": true,
+ "description": "ISO-8601 last refresh per source list.",
+ "type": [
+ "object",
+ "null"
+ ]
+}
addedOutput schema / properties / matched
Added value: +{
+ "description": "Number of names with matched=true.",
+ "type": [
+ "integer",
+ "null"
+ ]
+}
addedOutput schema / properties / results / items / properties / classification
Added value: +{
+ "description": "Outcome for this name: none / potential_match / confirmed.",
+ "type": [
+ "string",
+ "null"
+ ]
+}
addedOutput schema / properties / results / items / properties / count
Added value: +{
+ "description": "Number of fuzzy candidates returned, including unflagged low-confidence ones — not a match count.",
+ "type": [
+ "integer",
+ "null"
+ ]
+}
addedOutput schema / properties / results / items / properties / flaggedCount
Added value: +{
+ "description": "Number of hits classified as a match.",
+ "type": [
+ "integer",
+ "null"
+ ]
+}
addedOutput schema / properties / results / items / properties / hits
Added value: +{
+ "description": "Fuzzy candidates, each with its own classification ('none' = not flagged).",
+ "items": {
+ "additionalProperties": true,
+ "properties": {
+ "classification": {
+ "description": "none / potential_match / confirmed.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "countries": {
+ "items": {
+ "type": "string"
+ },
+ "type": [
+ "array",
+ "null"
+ ]
+ },
+ "name": {
+ "description": "Listed entity name.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "programs": {
+ "description": "Sanctions programmes.",
+ "items": {
+ "type": "string"
+ },
+ "type": [
+ "array",
+ "null"
+ ]
+ },
+ "score": {
+ "description": "Fuzzy match score 0-1.",
+ "type": [
+ "number",
+ "null"
+ ]
+ },
+ "source": {
+ "description": "Source list (UN, EU FSF, US OFAC SDN, OpenSanctions PEPs).",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "type": {
+ "description": "individual / entity.",
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "type": "object"
+ },
+ "type": [
+ "array",
+ "null"
+ ]
+}
addedOutput schema / properties / results / items / properties / matched
Added value: +{
+ "description": "The screening outcome for this name: true only if at least one hit is classified as a match.",
+ "type": [
+ "boolean",
+ "null"
+ ]
+}
removedOutput schema / properties / results / items / properties / matches
Removed value: -{
- "description": "Matched sanctioned / PEP entities, ranked by score descending.",
- "items": {
- "additionalProperties": true,
- "properties": {
- "datasets": {
- "description": "Source lists (UN, EU, OFAC, PEP, ...).",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "name": {
- "description": "Matched entity name.",
- "type": "string"
- },
- "schema": {
- "description": "OpenSanctions schema, e.g. Person, Company.",
- "type": "string"
- },
- "score": {
- "description": "Fuzzy match score 0-1.",
- "type": "number"
- },
- "topics": {
- "description": "Risk topics tagged on the entity.",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "type": "array"
-}
changedOutput schema / properties / results / items / properties / query / type
Previous value: -"string"New value: +[
+ "string",
+ "null"
+]
addedOutput schema / properties / results / items / properties / requiresManualReview
Added value: +{
+ "description": "True when hits need human verification.",
+ "type": [
+ "boolean",
+ "null"
+ ]
+}
addedOutput schema / properties / results / items / properties / topScore
Added value: +{
+ "description": "Highest fuzzy score among candidates; null when there are none. A high score alone is not a match — see classification.",
+ "type": [
+ "number",
+ "null"
+ ]
+}
changedOutput schema / properties / results / type
Previous value: -"array"New value: +[
+ "array",
+ "null"
+]
addedOutput schema / properties / sourcesUnavailable
Added value: +{
+ "description": "Lists that could not be checked on this call; non-empty means the screening is incomplete.",
+ "type": [
+ "array",
+ "null"
+ ]
+}
addedOutput schema / properties / total
Added value: +{
+ "description": "Number of names screened.",
+ "type": [
+ "integer",
+ "null"
+ ]
+}