List hits for individual watchlist screening

POST /watchlist_screening/individual/hit/list

List all hits found by Plaid for a particular individual watchlist screening.

Request Body

Required

Request input for listing hits for an individual watchlist screening

Parameters

secret
string
Your Plaid API secret. The secret is required and may be provided either in the PLAID-SECRET header or as part of a request body.
client_id
string
Your Plaid API client_id. The client_id is required and may be provided either in the PLAID-CLIENT-ID header or as part of a request body.
watchlist_screening_id
required, string
ID of the associated screening.
cursor
string
An identifier that determines which page of results you receive.

Response

Paginated list of individual watchlist screening hits

Response Properties

watchlist_screening_hits
required, array[object]
List of individual watchlist screening hits
id
required, string
ID of the associated screening hit.
review_status
required, string
The current state of review. All watchlist screening hits begin in a pending_review state but can be changed by creating a review. When a hit is in the pending_review state, it will always show the latest version of the watchlist data Plaid has available and be compared against the latest customer information saved in the watchlist screening. Once a hit has been marked as confirmed or dismissed it will no longer be updated so that the state is as it was when the review was first conducted.
first_active
required, string
An ISO8601 formatted timestamp.
inactive_since
required, string
An ISO8601 formatted timestamp.
historical_since
required, string
An ISO8601 formatted timestamp.
list_code
required, string
Shorthand identifier for a specific screening list for individuals. AU_CON: Australia Department of Foreign Affairs and Trade Consolidated List CA_CON: Government of Canada Consolidated List of Sanctions EU_CON: European External Action Service Consolidated List IZ_CIA: CIA List of Chiefs of State and Cabinet Members IZ_IPL: Interpol Red Notices for Wanted Persons List IZ_PEP: Politically Exposed Persons List IZ_UNC: United Nations Consolidated Sanctions IZ_WBK: World Bank Listing of Ineligible Firms and Individuals UK_HMC: UK HM Treasury Consolidated List US_DPL: Bureau of Industry and Security Denied Persons List US_DTC: US Department of State AECA Debarred US_FBI: US Department of Justice FBI Wanted List US_FSE: US OFAC Foreign Sanctions Evaders US_ISN: US Department of State Nonproliferation Sanctions US_PLC: US OFAC Palestinian Legislative Council US_SAM: US System for Award Management Exclusion List US_SDN: US OFAC Specially Designated Nationals List US_SSI: US OFAC Sectoral Sanctions Identifications SG_SOF: Government of Singapore Terrorists and Terrorist Entities TR_TWL: Government of Turkey Terrorist Wanted List TR_DFD: Government of Turkey Domestic Freezing Decisions TR_FOR: Government of Turkey Foreign Freezing Requests TR_WMD: Government of Turkey Weapons of Mass Destruction TR_CMB: Government of Turkey Capital Markets Board
plaid_uid
required, string
A universal identifier for a watchlist individual that is stable across searches and updates.
source_uid
required, string
The identifier provided by the source sanction or watchlist. When one is not provided by the source, this is null.
analysis
object
Analysis information describing why a screening hit matched the provided user information
dates_of_birth
string
An enum indicating the match type between data provided by user and data checked against an external data source. match indicates that the provided input data was a strong match against external data. partial_match indicates the data approximately matched against external data. For example, “Knope” vs. “Knope-Wyatt” for last name. no_match indicates that Plaid was able to perform a check against an external data source and it did not match the provided input data. no_data indicates that Plaid was unable to find external data to compare against the provided input data. no_input indicates that Plaid was unable to perform a check because no information was provided for this field by the end user.
documents
string
An enum indicating the match type between data provided by user and data checked against an external data source. match indicates that the provided input data was a strong match against external data. partial_match indicates the data approximately matched against external data. For example, “Knope” vs. “Knope-Wyatt” for last name. no_match indicates that Plaid was able to perform a check against an external data source and it did not match the provided input data. no_data indicates that Plaid was unable to find external data to compare against the provided input data. no_input indicates that Plaid was unable to perform a check because no information was provided for this field by the end user.
locations
string
An enum indicating the match type between data provided by user and data checked against an external data source. match indicates that the provided input data was a strong match against external data. partial_match indicates the data approximately matched against external data. For example, “Knope” vs. “Knope-Wyatt” for last name. no_match indicates that Plaid was able to perform a check against an external data source and it did not match the provided input data. no_data indicates that Plaid was unable to find external data to compare against the provided input data. no_input indicates that Plaid was unable to perform a check because no information was provided for this field by the end user.
names
string
An enum indicating the match type between data provided by user and data checked against an external data source. match indicates that the provided input data was a strong match against external data. partial_match indicates the data approximately matched against external data. For example, “Knope” vs. “Knope-Wyatt” for last name. no_match indicates that Plaid was able to perform a check against an external data source and it did not match the provided input data. no_data indicates that Plaid was unable to find external data to compare against the provided input data. no_input indicates that Plaid was unable to perform a check because no information was provided for this field by the end user.
search_terms_version
required, integer
The version of the screening’s search_terms that were compared when the screening hit was added. screening hits are immutable once they have been reviewed. If changes are detected due to updates to the screening’s search_terms, the associated program, or the list’s source data prior to review, the screening hit will be updated to reflect those changes.
data
object
Information associated with the watchlist hit
dates_of_birth
array[object]
Dates of birth associated with the watchlist hit
analysis
object
Summary object reflecting the match result of the associated data
summary
required, string
An enum indicating the match type between data provided by user and data checked against an external data source. match indicates that the provided input data was a strong match against external data. partial_match indicates the data approximately matched against external data. For example, “Knope” vs. “Knope-Wyatt” for last name. no_match indicates that Plaid was able to perform a check against an external data source and it did not match the provided input data. no_data indicates that Plaid was unable to find external data to compare against the provided input data. no_input indicates that Plaid was unable to perform a check because no information was provided for this field by the end user.
data
object
A date range with a start and end date
beginning
required, string
A date in the format YYYY-MM-DD (RFC 3339 Section 5.6).
ending
required, string
A date in the format YYYY-MM-DD (RFC 3339 Section 5.6).
documents
array[object]
Documents associated with the watchlist hit
analysis
object
Summary object reflecting the match result of the associated data
summary
required, string
An enum indicating the match type between data provided by user and data checked against an external data source. match indicates that the provided input data was a strong match against external data. partial_match indicates the data approximately matched against external data. For example, “Knope” vs. “Knope-Wyatt” for last name. no_match indicates that Plaid was able to perform a check against an external data source and it did not match the provided input data. no_data indicates that Plaid was unable to find external data to compare against the provided input data. no_input indicates that Plaid was unable to perform a check because no information was provided for this field by the end user.
data
object
An official document, usually issued by a governing body or institution, with an associated identifier.
type
required, string
The kind of official document represented by this object. birth_certificate - A certificate of birth drivers_license - A license to operate a motor vehicle immigration_number - Immigration or residence documents military_id - Identification issued by a military group other - Any document not covered by other categories passport - An official passport issue by a government personal_identification - Any generic personal identification that is not covered by other categories ration_card - Identification that entitles the holder to rations ssn - United States Social Security Number student_id - Identification issued by an educational institution tax_id - Identification issued for the purpose of collecting taxes travel_document - Visas, entry permits, refugee documents, etc. voter_id - Identification issued for the purpose of voting
number
required, string
The numeric or alphanumeric identifier associated with this document. Must be between 4 and 32 characters long, and cannot have leading or trailing spaces.
locations
array[object]
Locations associated with the watchlist hit
analysis
object
Summary object reflecting the match result of the associated data
summary
required, string
An enum indicating the match type between data provided by user and data checked against an external data source. match indicates that the provided input data was a strong match against external data. partial_match indicates the data approximately matched against external data. For example, “Knope” vs. “Knope-Wyatt” for last name. no_match indicates that Plaid was able to perform a check against an external data source and it did not match the provided input data. no_data indicates that Plaid was unable to find external data to compare against the provided input data. no_input indicates that Plaid was unable to perform a check because no information was provided for this field by the end user.
data
object
Location information for the associated individual watchlist hit
full
required, string
The full location string, potentially including elements like street, city, postal codes and country codes. Note that this is not necessarily a complete or well-formatted address.
country
required, string
Valid, capitalized, two-letter ISO code representing the country of this object. Must be in ISO 3166-1 alpha-2 form.
names
array[object]
Names associated with the watchlist hit
analysis
object
Summary object reflecting the match result of the associated data
summary
required, string
An enum indicating the match type between data provided by user and data checked against an external data source. match indicates that the provided input data was a strong match against external data. partial_match indicates the data approximately matched against external data. For example, “Knope” vs. “Knope-Wyatt” for last name. no_match indicates that Plaid was able to perform a check against an external data source and it did not match the provided input data. no_data indicates that Plaid was unable to find external data to compare against the provided input data. no_input indicates that Plaid was unable to perform a check because no information was provided for this field by the end user.
data
object
Name information for the associated individual watchlist hit
full
required, string
The full name of the individual, including all parts.
is_primary
required, boolean
Primary names are those most commonly used to refer to this person. Only one name will ever be marked as primary.
weak_alias_determination
required, string
Names that are explicitly marked as low quality either by their source list, or by plaid by a series of additional checks done by Plaid. Plaid does not ever surface a hit as a result of a weak name alone. If a name has no quality issues, this value will be none.
next_cursor
required, string
An identifier that determines which page of results you receive.
request_id
required, string
A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.