List hits for entity watchlist screenings

POST /watchlist_screening/entity/hit/list

List all hits for the entity watchlist screening.

Request Body

Required

Request input for listing hits for an entity 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.
entity_watchlist_screening_id
required, string
ID of the associated entity screening.
cursor
string
An identifier that determines which page of results you receive.

Response

Paginated list of entity watchlist screening hits

Response Properties

entity_watchlist_screening_hits
required, array[object]
List of entity watchlist screening hits
id
required, string
ID of the associated entity 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 entities. 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_SOE: State Owned Enterprise List IZ_UNC: United Nations Consolidated Sanctions IZ_WBK: World Bank Listing of Ineligible Firms and Individuals US_CAP: US OFAC Correspondent Account or Payable-Through Account Sanctions US_FSE: US OFAC Foreign Sanctions Evaders US_MBS: US Non-SDN Menu-Based Sanctions US_SDN: US Specially Designated Nationals List US_SSI: US OFAC Sectoral Sanctions Identifications US_CMC: US OFAC Non-SDN Chinese Military-Industrial Complex List US_UVL: Bureau of Industry and Security Unverified List US_SAM: US System for Award Management Exclusion List US_TEL: US Terrorist Exclusion List UK_HMC: UK HM Treasury Consolidated List
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 entity information
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.
email_addresses
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.
phone_numbers
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.
urls
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 entity screening’s search_terms that were compared when the entity screening hit was added. entity screening hits are immutable once they have been reviewed. If changes are detected due to updates to the entity screening’s search_terms, the associated entity program, or the list’s source data prior to review, the entity screening hit will be updated to reflect those changes.
data
object
Information associated with the entity watchlist hit
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. bik - Russian bank code business_number - A number that uniquely identifies the business within a category of businesses imo - Number assigned to the entity by the International Maritime Organization other - Any document not covered by other categories swift - Number identifying a bank and branch. tax_id - Identification issued for the purpose of collecting taxes
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.
email_addresses
array[object]
Email addresses 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
Email address information for the associated entity watchlist hit
email_address
required, string
A valid email address. Must not have leading or trailing spaces and address must be RFC compliant. For more information, see RFC 3696.
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 entity watchlist hit
full
required, string
The full name of the entity.
is_primary
required, boolean
Primary names are those most commonly used to refer to this entity. 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.
phone_numbers
array[object]
Phone numbers 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
Phone number information associated with the entity screening hit
type
required, string
An enum indicating whether a phone number is a phone line or a fax line.
phone_number
required, string
A phone number in E.164 format.
urls
array[object]
URLs 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
URLs associated with the entity screening hit
url
required, string
An ‘http’ or ‘https’ URL (must begin with either of those).
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.