input | string | object | Input The name (or the object from "entities") this record corresponds to. |
status | string | Status ok | error | skipped_invalid | skipped_budget | skipped_free_plan | skipped_unmetered e.g. "ok" |
charged | boolean | Charged Whether this record incurred a pay-per-event charge. |
chargedEvent | string | Charged event Pay-per-event event charged for this record (present only when charged). |
chargedCount | integer | Events charged Events actually charged when the charge came back short of the requested count (present only then; a warning explains it). |
source | string | Source Upstream data source. |
fetchedAt | string | Fetched at ISO timestamp. |
error | object | Error { code, message, provider?, status? } when status is not ok. Codes set by the runtime: budget_exhausted, free_plan_limit, unmetered, aborted, charge_failed, record_too_large, invalid_record, dataset_push_failed; this Actor: invalid_name, lists_incomplete (no match on the lists that loaded, but a selected list was unavailable: not cleared, not charged), timeout, internal. |
warnings | array | Warnings Notes about this record, e.g. a list that was unavailable in this run or an ignored date of birth. |
name | string | Name The screened name as given. |
entityType | string | Type any | person | entity | vessel | aircraft: which list entries the name was compared with. |
dateOfBirth | string | null | Date of birth The date of birth given for the name (YYYY-MM-DD, YYYY-MM or YYYY), if any. |
country | string | null | Country The country given for the name, if any. |
normalizedName | string | Normalized name The name as compared: transliterated to ASCII, upper case, punctuation and legal forms removed. |
matchStatus | string | null | Match status potential_match (at least one list entry scored at or above the threshold) or no_match; null when the name was not screened (invalid name) or not cleared (lists_incomplete). |
bestScore | number | Best score Highest score among the list entries compared (0–1), also when below the threshold; entries that cannot reach the threshold or 0.7, whichever is lower, are not compared. |
threshold | number | Threshold The threshold used for this name. |
matchCount | integer | Matches Number of potential matches returned (at most maxMatchesPerName). |
totalMatches | integer | Total matches All list entries scoring at or above the threshold, also those beyond maxMatchesPerName. |
topMatchName | string | null | Top match Primary name of the best-scoring list entry, if any. |
topMatchList | string | null | Top match list List of the best-scoring entry: ofac-sdn, ofac-cons, un, eu or uk. |
topMatchScore | number | null | Top match score Score of the best-scoring entry. |
matches | array | Potential matches List entries scoring at or above the threshold, best first: list, listName, entryId, name, matchedName, matchedNameType (primary | alias | weak_alias | former | non_latin), aliases, type, programs, dateOfBirth, nationalities, countries, listedOn, ids, remarks, score, nameScore, reasons, sourceUrl. |
listsComplete | boolean | Lists complete true when every selected list was screened; false on a potential match while a selected list could not be loaded in this run. |
listsStale | boolean | Lists stale true when a selected list was screened against an older cached copy (up to 7 days) because its download failed in this run. |
listsScreened | array | Lists screened Lists this name was screened against (selected lists that were available in this run). |
listsVersion | object | List versions Per list: name, status (ok | stale | unavailable), sourceUrls, fetchedAt, publishedAt, recordCount, fromCache. |
screenedAt | string | Screened at ISO timestamp of the screening. |
raw | array | Raw list entries Complete list entries of the matches (only with includeRaw). |