Sanctions Screening (backgroundcheck_ky) Response Object
This JSON response is returned for a watchlists and sanctions screening check.
This response is returned by
/get-resultsif you include thekycsignal in the/startendpoint.
{
"backgroundcheck_ky": {
"type": "object",
"description": "Sanctions screening signal (backgroundcheck_ky) response",
"properties": {
"hits": {
"type": "string",
"description": "Number of watchlists on which the person being verified appears."
},
"rawHitDetails": {
"type": "string",
"description": "Watchlists associated with results."
},
"success": {
"type": "boolean",
"description": "True if the API call was successful; false otherwise."
},
"result": {
"type": "boolean",
"description": "True if data was returned in the data object; false otherwise."
},
"message": {
"type": "string",
"description": "A description of the result output. For example, \"success\" or an error message."
},
"data": {
"type": "object",
"description": "Contains the backgroundcheck_ky signal elements returned as a JSON object.",
"properties": {
"responseStatus": {
"type": "object",
"description": "Sanctions response status.",
"properties": {
"code": {
"type": "string",
"description": "Intellicheck internal use only."
},
"status": {
"type": "string",
"description": "Intellicheck internal use only."
},
"message": {
"type": "string",
"description": "Intellicheck internal use only."
}
}
},
"diq_summary": {
"type": "object",
"description": "Sanctions response summary.",
"properties": {
"decision": {
"type": "string",
"description": "Overall Sanctions verification result: FAIL - fails sanctions verification. Appears on one or more Watchlists. PASS- passes sanctions verification. Does not appear on any Watchlists. Verify - there were hits on watchlist(s) where one or more records require further verification. No Decision - insufficient information provided. More needed to make a decision. For example, if your request only includes part of a name."
},
"reason": {
"type": "string",
"description": "Reason for decision: FAIL - Strong match(s) on watchlists. PASS - No records with hits to clear. Verify - Some hits could not be cleared on watchlists."
},
"score": {
"type": "string",
"description": "Calculated based on frequency of hits on the subject name and percentage of the matched part of the name. 100% means an absolute or strong match. Lower number(s) indicate a degree of fuzzy match."
},
"timestamp": {
"type": "string",
"description": "Date and time the verification data was sent."
},
"hits": {
"type": "string",
"description": "Total number of records that contributed to the decision. 200 is the maximum value reported."
},
"diq_customer_id": {
"type": "string",
"description": "Unique search ID. Intellicheck internal use."
},
"pow_url": {
"type": "string",
"description": "Link to proof of decision (POD) report with details regarding the decision."
},
"records_contributing_to_result": {
"type": "string",
"description": "For future use."
},
"records_contributing_to_fail": {
"type": "string",
"description": "For future use."
},
"records_contributing_to_verify": {
"type": "string",
"description": "For future use."
},
"processing_time": {
"type": "string",
"description": "Amount of time in milliseconds that elapsed for processing of verification data to arrive at decision."
},
"diq_results_by_watchlist_type": {
"description": "Sanctions results by watchlist type.",
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Name of watchlist category that contributed to the decision. For example, Regulatory, High Risk Organization (HIO), and so on."
},
"value": {
"type": "string",
"description": "Individual watchlist verification result: Cleared - No hits on any of the watchlist categories or watchlists. FAIL - Fails sanctions verification. Appears on one or more watchlists. Verify - Further verification is required. Refer to pow_url. Not Selected - The watchlist category is not included in the tier."
}
}
}
},
"high_risk_business_association": {
"type": "array",
"description": "Sanctions results by high-risk business association.",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Name of high-risk business (HRB) watchlist that contributed to the decision. For example, Casino, Finance, and so on."
},
"value": {
"type": "string",
"description": "Verification result: Cleared - No hits on any of the watchlist categories or watchlists. FAIL - Fails sanctions verification. Appears on one or more watchlists. Verify - Further verification is required. Refer to pow_url. Not Selected - The watchlist category is not included in the tier."
}
}
}
},
"adverse_media_statistics": {
"type": "object",
"description": "Contains the statistics of negative news hits. This object is included only for response-type = 6.",
"properties": {
"is_likely_pep": {
"type": "boolean",
"description": "If the searched entity is a likely politically exposed person (PEP)."
},
"is_likely_rca": {
"type": "boolean",
"description": "If the searched entity is a likely relative and close associate (RCA)."
},
"is_likely_hrb": {
"type": "boolean",
"description": "If the searched entity is likely associated with high-risk business (HRB)."
},
"adverse_media_reason": {
"type": "string",
"description": "Descriptive text for reason of hit in adverse media."
},
"designated_offences_categories": {
"type": "string",
"format": "list",
"description": "List of designated offence categories applicable to the hits as per the 6th AML directive of predicate offences. Example: designated_offences_categories: [Corruption and Bribery, Trafficking in stolen goods, Violent Crime, Fraud, Illegal arms trafficking]. Parameter type is List."
},
"rca_of_pep": {
"type": "string",
"format": "list",
"description": "List of strings with each entry containing the Name of the person and relationship with the searched entity separated by pipe |. Example: rca_of_pep: [Don Jr|child]. Parameter type is List."
},
"keywords": {
"type": "string",
"format": "list",
"description": "The negative keywords the hit articles contain. Example: keywords: [assault, tax fraud, expel, arrest]. Parameter type is List."
}
}
}
}
},
"smart_scan_summary": {
"type": "array",
"description": "Smart scan summary results object.",
"items": {
"type": "object",
"description": "These fields provide precise details about matches identified in the KYC2020 watchlist database, offering in-depth information for each detected match.",
"properties": {
"hit_location": {
"type": "string",
"description": "Indicates the part of the name where a match was found.",
"example": "derivedName.phonetic,derivedName.latin,derivedName"
},
"no_of_hits": {
"type": "string",
"description": "Indicates the number of matches found for the search in the KYC2020 Watchlist database.",
"example": "3"
},
"list_name": {
"type": "string",
"description": "Specifies the name of the watchlist where the match was identified.",
"example": "Ireland - All Financial Service Providers (IEMSBL)"
},
"list_url": {
"type": "string",
"description": "The source URL from which the data associated with the match(es) was retrieved.",
"example": "http://registers.centralbank.ie/FirmSearchResultsPage.aspx?searchEntity=Institution&searchType=Name&searchText=®isters=All&firmType=All"
},
"record_id": {
"type": "string",
"description": "The record ID of the match in the KYC2020 Database.",
"example": "33498e65dca9f53da8cc416acbc340c8"
},
"search_reference_id": {
"type": "string",
"description": "Unique reference ID of the search. Used for internal purposes.",
"example": "00000000000034445220"
},
"score": {
"type": "string",
"description": "The SmartScan score for this match.",
"example": "58.8"
},
"relevancy_score": {
"type": "string",
"description": "This field denotes the Name Relevancy Score, providing a measure of the degree of relevance between the searched name and the identified entity or individual. A score of 100 indicates a perfect, exact match, while scores between 0 and 99 represent varying degrees of similarity. Higher scores signify a closer resemblance to the searched name."
},
"flag_type": {
"type": "string",
"description": "Indicates the flag type for a hit. Applies to SmartScan only. Possible values are: High Risk, False Positive, Cleared."
},
"comment": {
"type": "string",
"description": "Comments included while flagging a hit. Applies only to SmartScan."
},
"search_dump_id": {
"type": "string",
"description": "Internal identifier used by the KYC2020 team for reference.",
"example": "1342870"
},
"error": {
"type": "string"
},
"status": {
"type": "string",
"description": "Status of the record"
},
"hits": {
"type": "array",
"items": {
"type": "object",
"properties": {
"hit": {
"type": "string",
"description": "A specific persona or record found within the list of matches.",
"example": "ABS BANK SPOLDZIELCZY"
}
},
"description": "Personas(records) within the KYC2020 database that match the search criteria."
}
}
}
}
},
"articles": {
"type": "array",
"description": "Articles scan summary results object.",
"items": {
"type": "object",
"description": "",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier for the adverse media article within the KYC2020 database.",
"example": "3b8cbbf63adf2e55dfac8497f9a8da67"
},
"summary": {
"type": "string",
"description": "High-level summary of the negative news article where a match was identified.",
"example": "Federal prosecutors unsealed an eight-count indictment Tuesday against a former CEO, Sam Bankman-Fried, who was arrested in the Bahamas on charges including wire fraud and misusing customer funds. Grewal accused Bankman-Fried of secretly and improperly diverting FTX customer funds to the hedge fund Alameda Research. “To the contrary, FTX customer assets were routinely accepted and held by Alameda and commingled with Alameda’s funds. The complaint named Bankman-Fried, FTX Trading Ltd. and Alameda Research LLC, two of his companies. Sam Bankman-Fried, former CEO of FTX crypto exchange, says he will testify before Congress."
},
"keywords": {
"type": "string",
"description": "Keywords indicative of negative aspects within the news article.",
"example": "Human Trafficking, Fraud, Arrest"
},
"guid": {
"type": "string",
"description": "The source URL of the negative news article.",
"example": "https://www.moneyweb.co.za/moneyweb-podcasts/special-report/pityana-on-being-fired-from-the-absa-board/"
},
"published": {
"type": "string",
"description": "Date and time when the negative news article was published.",
"example": "24/11/2021 14:05:30"
},
"title": {
"type": "string",
"description": "Title of the negative news article.",
"example": "Pityana on being fired from the Absa board"
},
"author": {
"type": "array",
"items": {
"type": "string",
"description": "Author(s) of the negative news article.",
"example": "[{\"Albert Mohler\"}]"
}
},
"source": {
"type": "string",
"description": "The platform used to source the article.",
"example": "www.google.com"
},
"provider": {
"type": "string",
"description": "The publisher or source aggregator of the negative news article.",
"example": "www.moneyweb.co.za"
},
"pep": {
"type": "array",
"items": {
"type": "object",
"description": "Details the PEP mentioned in the article.",
"example": [
{
"entity": "Mike Pompeo",
"orgs": [
{
"name": "CIA"
}
],
"roles": [
{
"name": "director"
}
]
}
]
}
},
"sentiment_score": {
"type": "integer",
"description": "Indicates the sentiment of the news article. Possible values include: 1 – Positive, -1 - Negative, 0 – Neutral.",
"format": "int32",
"example": -1
},
"key_negative_words": {
"type": "string",
"description": "6AMLD predicate offences found in the article that were configured for this search.",
"example": "dismiss, arbitr"
},
"name_variance": {
"type": "string",
"description": "The different name variants found for this negative news search.",
"example": "Absa"
},
"designated_offences_categories": {
"type": "string",
"description": "Comma-separated predicate offences designated under 6AMLD that match this article."
},
"high_light": {
"type": "object",
"description": "This object highlights the customer’s name found in articles on the KYC2020 User Interface.",
"properties": {
"field": {
"type": "string",
"description": "The key indicating the type of match in this article.",
"example": "ner.text"
},
"values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "All matches on name and name variants for the screened name.",
"example": "[{\"Absa\"}]"
}
}
}
}
}
}
}
}
}
}
}
}
}
}
Updated 5 months ago