hubvibe-io.com

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "description": "The 200 body of every paid /work call. `result` is the worker's own output (its schema is per route); everything else is the same on every /work route. A receipt for the job is at `receipt_url`.",
  "properties": {
    "attribution": {
      "$ref": "#/components/schemas/Attribution"
    },
    "billing_warning": {
      "description": "Present only when the charge was recorded with a caveat.",
      "examples": [
        "settlement pending"
      ],
      "type": "string"
    },
    "price_usd": {
      "description": "What this call cost, in USD.",
      "examples": [
        0.02
      ],
      "type": "number"
    },
    "provenance": {
      "$ref": "#/components/schemas/Provenance"
    },
    "receipt_id": {
      "description": "Receipt id for this job.",
      "examples": [
        "rcpt_9f1c2b3a4d5e6f70"
      ],
      "type": "string"
    },
    "receipt_url": {
      "description": "Where to fetch the machine-readable receipt (free, no payment).",
      "examples": [
        "/work/receipts/rcpt_9f1c2b3a4d5e6f70"
      ],
      "type": "string"
    },
    "result": {
      "properties": {
        "checked_at": {
          "description": "When this node read the source (UTC). Nothing here is cached.",
          "examples": [
            "2026-09-26T18:00:00Z"
          ],
          "format": "date-time",
          "type": "string"
        },
        "lists": {
          "description": "Every list asked for, with its date.",
          "examples": [
            []
          ],
          "items": {
            "description": "One list screened.",
            "properties": {
              "as_of": {
                "description": "The list's own publication date.",
                "examples": [
                  "2026-09-23"
                ],
                "type": [
                  "string",
                  "null"
                ]
              },
              "entries": {
                "description": "Entries loaded from it.",
                "examples": [
                  19391
                ],
                "type": "integer"
              },
              "license": {
                "description": "Its reuse licence.",
                "examples": [
                  "US government work (public domain)"
                ],
                "type": "string"
              },
              "list": {
                "description": "List id.",
                "examples": [
                  "ofac_sdn"
                ],
                "type": "string"
              },
              "loaded": {
                "description": "The list was screened.",
                "examples": [
                  true
                ],
                "type": "boolean"
              },
              "name": {
                "description": "List name.",
                "examples": [
                  "OFAC Specially Designated Nationals (SDN) List"
                ],
                "type": "string"
              },
              "publisher": {
                "description": "Who publishes it.",
                "examples": [
                  "US Department of the Treasury, Office of Foreign Assets Control"
                ],
                "type": "string"
              },
              "source_url": {
                "description": "Where it is published.",
                "examples": [
                  "https://sanctionssearch.ofac.treas.gov/"
                ],
                "type": "string"
              }
            },
            "required": [
              "list",
              "name",
              "publisher",
              "license",
              "source_url",
              "as_of",
              "entries",
              "loaded"
            ],
            "type": "object"
          },
          "type": "array"
        },
        "match_count": {
          "description": "Number of matches returned.",
          "examples": [
            3
          ],
          "type": "integer"
        },
        "matches": {
          "description": "Matches, best first.",
          "examples": [
            []
          ],
          "items": {
            "description": "One listing.",
            "properties": {
              "birth_dates": {
                "description": "Dates of birth the list records.",
                "examples": [
                  []
                ],
                "items": {
                  "description": "A date of birth as the list records it.",
                  "examples": [
                    "07 Oct 1952"
                  ],
                  "type": "string"
                },
                "type": "array"
              },
              "countries": {
                "description": "Countries the list records (address, nationality, birth).",
                "examples": [
                  []
                ],
                "items": {
                  "description": "A country the list records.",
                  "examples": [
                    "Russia"
                  ],
                  "type": "string"
                },
                "type": "array"
              },
              "id": {
                "description": "The list's own id for the entry.",
                "examples": [
                  "12345"
                ],
                "type": "string"
              },
              "list": {
                "description": "Which list.",
                "enum": [
                  "ofac_sdn",
                  "ofac_consolidated",
                  "uk",
                  "eu"
                ],
                "examples": [
                  "ofac_sdn"
                ],
                "type": "string"
              },
              "list_name": {
                "description": "The list's name.",
                "examples": [
                  "OFAC Specially Designated Nationals (SDN) List"
                ],
                "type": "string"
              },
              "listed_on": {
                "description": "Designation date, when the list records it.",
                "examples": [
                  "2014-07-16"
                ],
                "type": [
                  "string",
                  "null"
                ]
              },
              "matched_name": {
                "description": "The name or alias that matched.",
                "examples": [
                  "ROSNEFT"
                ],
                "type": "string"
              },
              "name": {
                "description": "The entry's primary name.",
                "examples": [
                  "ROSNEFT"
                ],
                "type": "string"
              },
              "programs": {
                "description": "Programmes the entry is listed under.",
                "examples": [
                  []
                ],
                "items": {
                  "description": "A sanctions programme or regime.",
                  "examples": [
                    "RUSSIA-EO14024"
                  ],
                  "type": "string"
                },
                "type": "array"
              },
              "score": {
                "description": "Match score, 0-1 (1 = the same words).",
                "examples": [
                  1
                ],
                "type": "number"
              },
              "source_url": {
                "description": "Where the list is published.",
                "examples": [
                  "https://sanctionssearch.ofac.treas.gov/"
                ],
                "type": "string"
              },
              "type": {
                "description": "Kind of listing.",
                "enum": [
                  "person",
                  "entity",
                  "vessel",
                  "aircraft"
                ],
                "examples": [
                  "entity"
                ],
                "type": "string"
              },
              "un_reference": {
                "description": "UN Security Council reference, when the list records one.",
                "examples": [
                  "TAi.002"
                ],
                "type": [
                  "string",
                  "null"
                ]
              }
            },
            "required": [
              "list",
              "list_name",
              "id",
              "name",
              "matched_name",
              "score",
              "type",
              "programs",
              "countries",
              "birth_dates",
              "un_reference",
              "listed_on",
              "source_url"
            ],
            "type": "object"
          },
          "type": "array"
        },
        "notes": {
          "description": "Caveats.",
          "examples": [
            []
          ],
          "items": {
            "description": "A caveat.",
            "examples": [
              "A potential match is a lead to review, not a determination."
            ],
            "type": "string"
          },
          "type": "array"
        },
        "query": {
          "description": "The screening request.",
          "properties": {
            "birth_year": {
              "description": "Birth-year filter, as given.",
              "examples": [
                1952
              ],
              "type": [
                "integer",
                "null"
              ]
            },
            "country": {
              "description": "Country filter, as given.",
              "examples": [
                "Russia"
              ],
              "type": [
                "string",
                "null"
              ]
            },
            "limit": {
              "description": "Most matches returned.",
              "examples": [
                10
              ],
              "type": "integer"
            },
            "lists": {
              "description": "The lists asked for; null means all four.",
              "examples": [
                null
              ],
              "items": {
                "type": "string"
              },
              "type": [
                "array",
                "null"
              ]
            },
            "name": {
              "description": "The name screened.",
              "examples": [
                "Rosneft"
              ],
              "type": "string"
            },
            "threshold": {
              "description": "Minimum match score used.",
              "examples": [
                0.85
              ],
              "type": "number"
            },
            "type": {
              "description": "The kind of listing matched.",
              "enum": [
                "any",
                "person",
                "entity",
                "vessel",
                "aircraft"
              ],
              "examples": [
                "entity"
              ],
              "type": "string"
            }
          },
          "required": [
            "name",
            "type",
            "threshold",
            "limit",
            "lists",
            "country",
            "birth_year"
          ],
          "type": "object"
        },
        "verdict": {
          "description": "potential_match: at least one listing scored at or above the threshold. no_match: none did, on every list asked for. incomplete: none did, but a list could not be screened (see notes).",
          "enum": [
            "potential_match",
            "no_match",
            "incomplete"
          ],
          "examples": [
            "potential_match"
          ],
          "type": "string"
        }
      },
      "required": [
        "query",
        "verdict",
        "match_count",
        "matches",
        "lists",
        "notes",
        "checked_at"
      ],
      "type": "object"
    },
    "status": {
      "const": "ok",
      "description": "Present only on a delivered result.",
      "type": "string"
    },
    "worker": {
      "description": "Catalog name of the worker that ran.",
      "examples": [
        "market.quote"
      ],
      "type": "string"
    }
  },
  "required": [
    "status",
    "worker",
    "price_usd",
    "result",
    "provenance",
    "receipt_id",
    "receipt_url"
  ],
  "title": "sanctions.screen response",
  "type": "object"
}