Monitor
API reference for Monitor endpoints and webhooks
Endpoints | |
---|---|
/watchlist_screening/individual/create | Create a watchlist screening for a person |
/watchlist_screening/individual/get | Retrieve an individual watchlist screening |
/watchlist_screening/individual/list | List individual watchlist screenings |
/watchlist_screening/individual/update | Update individual watchlist screening |
/watchlist_screening/individual/history/list | List history for entity watchlist screenings |
/watchlist_screening/individual/review/create | Create a review for an individual watchlist screening |
/watchlist_screening/individual/review/list | List reviews for individual watchlist screenings |
/watchlist_screening/individual/hit/list | List hits for individual watchlist screenings |
/watchlist_screening/individual/program/get | Get individual watchlist screening programs |
/watchlist_screening/individual/program/list | List individual watchlist screening programs |
/watchlist_screening/entity/create | Create a watchlist screening for an entity |
/watchlist_screening/entity/get | Retrieve an individual watchlist screening |
/watchlist_screening/entity/list | List individual watchlist screenings |
/watchlist_screening/entity/update | Update individual watchlist screening |
/watchlist_screening/entity/history/list | List history for individual watchlist screenings |
/watchlist_screening/entity/review/create | Create a review for an individual watchlist screening |
/watchlist_screening/entity/review/list | List reviews for individual watchlist screenings |
/watchlist_screening/entity/hit/list | List hits for individual watchlist screenings |
/watchlist_screening/entity/program/get | Get individual watchlist screening programs |
/watchlist_screening/entity/program/list | List individual watchlist screening programs |
See also | |
---|---|
/dashboard_user/get | Retrieve information about a dashboard user |
/dashboard_user/list | List dashboard users |
Webhooks | |
---|---|
SCREENING: STATUS_UPDATED | The status of an individual watchlist screening has changed |
ENTITY_SCREENING: STATUS_UPDATED | The status of an entity watchlist screening has changed |
Endpoints
/watchlist_screening/individual/create
Create a watchlist screening for a person
Create a new Watchlist Screening to check your customer against watchlists defined in the associated Watchlist Program. If your associated program has ongoing screening enabled, this is the profile information that will be used to monitor your customer over time.
watchlist_screening/individual/createsearch_terms
watchlist_program_id
legal_name
date_of_birth
date
document_number
country
client_user_id
/link/token/create
client_user_id
to be consistent. Personally identifiable information, such as an email address or phone number, should not be used in the client_user_id
.client_id
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.secret
secret
. The secret
is required and may be provided either in the PLAID-SECRET
header or as part of a request body.1const request: WatchlistScreeningIndividualCreateRequest = {2 search_terms: {3 watchlist_program_id: 'prg_2eRPsDnL66rZ7H',4 legal_name: 'Aleksey Potemkin',5 date_of_birth: '1990-05-29',6 document_number: 'C31195855',7 country: 'US',8 },9 client_user_id: 'example-client-user-id-123',10};11
12try {13 const response = await client.watchlistScreeningIndividualCreate(request);14} catch (error) {15 // handle error16}
Response fields and example
id
search_terms
watchlist_program_id
legal_name
date_of_birth
date
document_number
country
version
1
and increments with each edit to search_terms
.assignee
/dashboard_user/get
.status
rejected
, pending_review
, cleared
client_user_id
/link/token/create
client_user_id
to be consistent. Personally identifiable information, such as an email address or phone number, should not be used in the client_user_id
.audit_trail
source
dashboard
, link
, api
, system
dashboard_user_id
/dashboard_user/get
.timestamp
date-time
request_id
1{2 "id": "scr_52xR9LKo77r1Np",3 "search_terms": {4 "watchlist_program_id": "prg_2eRPsDnL66rZ7H",5 "legal_name": "Aleksey Potemkin",6 "date_of_birth": "1990-05-29",7 "document_number": "C31195855",8 "country": "US",9 "version": 110 },11 "assignee": "54350110fedcbaf01234ffee",12 "status": "cleared",13 "client_user_id": "your-db-id-3b24110",14 "audit_trail": {15 "source": "dashboard",16 "dashboard_user_id": "54350110fedcbaf01234ffee",17 "timestamp": "2020-07-24T03:26:02Z"18 },19 "request_id": "saKrIBuEB9qJZng"20}
Was this helpful?
/watchlist_screening/individual/get
Retrieve an individual watchlist screening
Retrieve a previously created individual watchlist screening
watchlist_screening/individual/getwatchlist_screening_id
secret
secret
. The secret
is required and may be provided either in the PLAID-SECRET
header or as part of a request body.client_id
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.1const request: WatchlistScreeningIndividualGetRequest = {2 watchlist_screening_id: 'scr_52xR9LKo77r1Np',3};4
5try {6 const response = await client.watchlistScreeningIndividualGet(request);7} catch (error) {8 // handle error9}
Response fields and example
id
search_terms
watchlist_program_id
legal_name
date_of_birth
date
document_number
country
version
1
and increments with each edit to search_terms
.assignee
/dashboard_user/get
.status
rejected
, pending_review
, cleared
client_user_id
/link/token/create
client_user_id
to be consistent. Personally identifiable information, such as an email address or phone number, should not be used in the client_user_id
.audit_trail
source
dashboard
, link
, api
, system
dashboard_user_id
/dashboard_user/get
.timestamp
date-time
request_id
1{2 "id": "scr_52xR9LKo77r1Np",3 "search_terms": {4 "watchlist_program_id": "prg_2eRPsDnL66rZ7H",5 "legal_name": "Aleksey Potemkin",6 "date_of_birth": "1990-05-29",7 "document_number": "C31195855",8 "country": "US",9 "version": 110 },11 "assignee": "54350110fedcbaf01234ffee",12 "status": "cleared",13 "client_user_id": "your-db-id-3b24110",14 "audit_trail": {15 "source": "dashboard",16 "dashboard_user_id": "54350110fedcbaf01234ffee",17 "timestamp": "2020-07-24T03:26:02Z"18 },19 "request_id": "saKrIBuEB9qJZng"20}
Was this helpful?
/watchlist_screening/individual/list
List Individual Watchlist Screenings
List previously created watchlist screenings for individuals
watchlist_screening/individual/listsecret
secret
. The secret
is required and may be provided either in the PLAID-SECRET
header or as part of a request body.client_id
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_program_id
client_user_id
/link/token/create
client_user_id
to be consistent. Personally identifiable information, such as an email address or phone number, should not be used in the client_user_id
.status
rejected
, pending_review
, cleared
assignee
/dashboard_user/get
.cursor
1const request: WatchlistScreeningIndividualListRequest = {2 watchlist_program_id: 'prg_2eRPsDnL66rZ7H',3 client_user_id: 'example-client-user-id-123',4};5
6try {7 const response = await client.watchlistScreeningIndividualList(request);8} catch (error) {9 // handle error10}
Response fields and example
watchlist_screenings
id
search_terms
watchlist_program_id
legal_name
date_of_birth
date
document_number
country
version
1
and increments with each edit to search_terms
.assignee
/dashboard_user/get
.status
rejected
, pending_review
, cleared
client_user_id
/link/token/create
client_user_id
to be consistent. Personally identifiable information, such as an email address or phone number, should not be used in the client_user_id
.audit_trail
source
dashboard
, link
, api
, system
dashboard_user_id
/dashboard_user/get
.timestamp
date-time
next_cursor
request_id
1{2 "watchlist_screenings": [3 {4 "id": "scr_52xR9LKo77r1Np",5 "search_terms": {6 "watchlist_program_id": "prg_2eRPsDnL66rZ7H",7 "legal_name": "Aleksey Potemkin",8 "date_of_birth": "1990-05-29",9 "document_number": "C31195855",10 "country": "US",11 "version": 112 },13 "assignee": "54350110fedcbaf01234ffee",14 "status": "cleared",15 "client_user_id": "your-db-id-3b24110",16 "audit_trail": {17 "source": "dashboard",18 "dashboard_user_id": "54350110fedcbaf01234ffee",19 "timestamp": "2020-07-24T03:26:02Z"20 }21 }22 ],23 "next_cursor": "eyJkaXJlY3Rpb24iOiJuZXh0Iiwib2Zmc2V0IjoiMTU5NDM",24 "request_id": "saKrIBuEB9qJZng"25}
Was this helpful?
/watchlist_screening/individual/update
Update individual watchlist screening
Update a specific individual watchlist screening. This endpoint can be used to add additional customer information, correct outdated information, add a reference id, assign the individual to a reviewer, and update which program it is associated with. Please note that you may not update search_terms
and status
at the same time since editing search_terms
may trigger an automatic status
change.
watchlist_screening_id
search_terms
watchlist_program_id
legal_name
date_of_birth
date
document_number
country
assignee
/dashboard_user/get
.status
rejected
, pending_review
, cleared
client_user_id
/link/token/create
client_user_id
to be consistent. Personally identifiable information, such as an email address or phone number, should not be used in the client_user_id
.client_id
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.secret
secret
. The secret
is required and may be provided either in the PLAID-SECRET
header or as part of a request body.reset_fields
assignee
1const request: WatchlistScreeningIndividualUpdateRequest = {2 watchlist_screening_id: 'scr_52xR9LKo77r1Np',3 status: 'cleared',4};5
6try {7 const response = await client.watchlistScreeningIndividualUpdate(request);8} catch (error) {9 // handle error10}
Response fields and example
id
search_terms
watchlist_program_id
legal_name
date_of_birth
date
document_number
country
version
1
and increments with each edit to search_terms
.assignee
/dashboard_user/get
.status
rejected
, pending_review
, cleared
client_user_id
/link/token/create
client_user_id
to be consistent. Personally identifiable information, such as an email address or phone number, should not be used in the client_user_id
.audit_trail
source
dashboard
, link
, api
, system
dashboard_user_id
/dashboard_user/get
.timestamp
date-time
request_id
1{2 "id": "scr_52xR9LKo77r1Np",3 "search_terms": {4 "watchlist_program_id": "prg_2eRPsDnL66rZ7H",5 "legal_name": "Aleksey Potemkin",6 "date_of_birth": "1990-05-29",7 "document_number": "C31195855",8 "country": "US",9 "version": 110 },11 "assignee": "54350110fedcbaf01234ffee",12 "status": "cleared",13 "client_user_id": "your-db-id-3b24110",14 "audit_trail": {15 "source": "dashboard",16 "dashboard_user_id": "54350110fedcbaf01234ffee",17 "timestamp": "2020-07-24T03:26:02Z"18 },19 "request_id": "saKrIBuEB9qJZng"20}
Was this helpful?
/watchlist_screening/individual/history/list
List history for individual watchlist screenings
List all changes to the individual watchlist screening in reverse-chronological order. If the watchlist screening has not been edited, no history will be returned.
watchlist_screening/individual/history/listsecret
secret
. The secret
is required and may be provided either in the PLAID-SECRET
header or as part of a request body.client_id
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
cursor
1const request: WatchlistScreeningIndividualHistoryListRequest = {2 watchlist_screening_id: 'scr_52xR9LKo77r1Np',3};4
5try {6 const response = await client.watchlistScreeningIndividualHistoryList(7 request,8 );9} catch (error) {10 // handle error11}
Response fields and example
watchlist_screenings
id
search_terms
watchlist_program_id
legal_name
date_of_birth
date
document_number
country
version
1
and increments with each edit to search_terms
.assignee
/dashboard_user/get
.status
rejected
, pending_review
, cleared
client_user_id
/link/token/create
client_user_id
to be consistent. Personally identifiable information, such as an email address or phone number, should not be used in the client_user_id
.audit_trail
source
dashboard
, link
, api
, system
dashboard_user_id
/dashboard_user/get
.timestamp
date-time
next_cursor
request_id
1{2 "watchlist_screenings": [3 {4 "id": "scr_52xR9LKo77r1Np",5 "search_terms": {6 "watchlist_program_id": "prg_2eRPsDnL66rZ7H",7 "legal_name": "Aleksey Potemkin",8 "date_of_birth": "1990-05-29",9 "document_number": "C31195855",10 "country": "US",11 "version": 112 },13 "assignee": "54350110fedcbaf01234ffee",14 "status": "cleared",15 "client_user_id": "your-db-id-3b24110",16 "audit_trail": {17 "source": "dashboard",18 "dashboard_user_id": "54350110fedcbaf01234ffee",19 "timestamp": "2020-07-24T03:26:02Z"20 }21 }22 ],23 "next_cursor": "eyJkaXJlY3Rpb24iOiJuZXh0Iiwib2Zmc2V0IjoiMTU5NDM",24 "request_id": "saKrIBuEB9qJZng"25}
Was this helpful?
/watchlist_screening/individual/review/create
Create a review for an individual watchlist screening
Create a review for the individual watchlist screening. Reviews are compliance reports created by users in your organization regarding the relevance of potential hits found by Plaid.
watchlist_screening/individual/review/createconfirmed_hits
dismissed_hits
comment
client_id
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.secret
secret
. The secret
is required and may be provided either in the PLAID-SECRET
header or as part of a request body.watchlist_screening_id
1const request: WatchlistScreeningIndividualReviewCreateRequest = {2 confirmed_hits: ['scrhit_52xR9LKo77r1Np'],3 dismissed_hits: [],4 watchlist_screening_id: 'scr_52xR9LKo77r1Np',5};6
7try {8 const response = await client.watchlistScreeningIndividualReviewCreate(9 request,10 );11} catch (error) {12 // handle error13}
Response fields and example
id
confirmed_hits
dismissed_hits
comment
audit_trail
source
dashboard
, link
, api
, system
dashboard_user_id
/dashboard_user/get
.timestamp
date-time
request_id
1{2 "id": "rev_aCLNRxK3UVzn2r",3 "confirmed_hits": [4 "scrhit_52xR9LKo77r1Np"5 ],6 "dismissed_hits": [7 "scrhit_52xR9LKo77r1Np"8 ],9 "comment": "These look like legitimate matches, rejecting the customer.",10 "audit_trail": {11 "source": "dashboard",12 "dashboard_user_id": "54350110fedcbaf01234ffee",13 "timestamp": "2020-07-24T03:26:02Z"14 },15 "request_id": "saKrIBuEB9qJZng"16}
Was this helpful?
/watchlist_screening/individual/review/list
List reviews for individual watchlist screenings
List all reviews for the individual watchlist screening.
watchlist_screening/individual/review/listsecret
secret
. The secret
is required and may be provided either in the PLAID-SECRET
header or as part of a request body.client_id
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
cursor
1const request: WatchlistScreeningIndividualReviewListRequest = {2 watchlist_screening_id: 'scr_52xR9LKo77r1Np',3};4
5try {6 const response = await client.watchlistScreeningIndividualReviewList(request);7} catch (error) {8 // handle error9}
Response fields and example
watchlist_screening _reviews
id
confirmed_hits
dismissed_hits
comment
audit_trail
source
dashboard
, link
, api
, system
dashboard_user_id
/dashboard_user/get
.timestamp
date-time
next_cursor
request_id
1{2 "watchlist_screening_reviews": [3 {4 "id": "rev_aCLNRxK3UVzn2r",5 "confirmed_hits": [6 "scrhit_52xR9LKo77r1Np"7 ],8 "dismissed_hits": [9 "scrhit_52xR9LKo77r1Np"10 ],11 "comment": "These look like legitimate matches, rejecting the customer.",12 "audit_trail": {13 "source": "dashboard",14 "dashboard_user_id": "54350110fedcbaf01234ffee",15 "timestamp": "2020-07-24T03:26:02Z"16 }17 }18 ],19 "next_cursor": "eyJkaXJlY3Rpb24iOiJuZXh0Iiwib2Zmc2V0IjoiMTU5NDM",20 "request_id": "saKrIBuEB9qJZng"21}
Was this helpful?
/watchlist_screening/individual/hit/list
List hits for individual watchlist screening
List all hits found by Plaid for a particular individual watchlist screening.
watchlist_screening/individual/hit/listsecret
secret
. The secret
is required and may be provided either in the PLAID-SECRET
header or as part of a request body.client_id
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
cursor
1const request: WatchlistScreeningIndividualHitListRequest = {2 watchlist_screening_id: 'scr_52xR9LKo77r1Np',3};4
5try {6 const response = await client.watchlistScreeningIndividualHitList(request);7} catch (error) {8 // handle error9}
Response fields and example
watchlist_screening _hits
id
review_status
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.confirmed
, pending_review
, dismissed
first_active
date-time
inactive_since
date-time
historical_since
date-time
list_code
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_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 BoardAU_CON
, CA_CON
, EU_CON
, IZ_CIA
, IZ_IPL
, IZ_PEP
, IZ_UNC
, IZ_WBK
, UK_HMC
, US_DPL
, US_DTC
, US_FBI
, US_FSE
, US_ISN
, US_MBS
, US_PLC
, US_SDN
, US_SSI
, SG_SOF
, TR_TWL
, TR_DFD
, TR_FOR
, TR_WMD
, TR_CMB
plaid_uid
source_uid
null
.analysis
dates_of_birth
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.match
, partial_match
, no_match
, no_data
, no_input
documents
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.match
, partial_match
, no_match
, no_data
, no_input
locations
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.match
, partial_match
, no_match
, no_data
, no_input
names
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.match
, partial_match
, no_match
, no_data
, no_input
search_terms_version
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
dates_of_birth
analysis
summary
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.match
, partial_match
, no_match
, no_data
, no_input
documents
analysis
summary
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.match
, partial_match
, no_match
, no_data
, no_input
data
type
birth_certificate
- A certificate of birthdrivers_license
- A license to operate a motor vehicleimmigration_number
- Immigration or residence documentsmilitary_id
- Identification issued by a military groupother
- Any document not covered by other categoriespassport
- An official passport issue by a governmentpersonal_identification
- Any generic personal identification that is not covered by other categoriesration_card
- Identification that entitles the holder to rationsssn
- United States Social Security Numberstudent_id
- Identification issued by an educational institutiontax_id
- Identification issued for the purpose of collecting taxestravel_document
- Visas, entry permits, refugee documents, etc.voter_id
- Identification issued for the purpose of votingbirth_certificate
, drivers_license
, immigration_number
, military_id
, other
, passport
, personal_identification
, ration_card
, ssn
, student_id
, tax_id
, travel_document
, voter_id
number
locations
analysis
summary
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.match
, partial_match
, no_match
, no_data
, no_input
data
full
country
names
analysis
summary
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.match
, partial_match
, no_match
, no_data
, no_input
data
full
is_primary
weak_alias _determination
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
.none
, source
, plaid
next_cursor
request_id
1{2 "watchlist_screening_hits": [3 {4 "id": "scrhit_52xR9LKo77r1Np",5 "review_status": "pending_review",6 "first_active": "2020-07-24T03:26:02Z",7 "inactive_since": "2020-07-24T03:26:02Z",8 "historical_since": "2020-07-24T03:26:02Z",9 "list_code": "US_SDN",10 "plaid_uid": "uid_3NggckTimGSJHS",11 "source_uid": "26192ABC",12 "analysis": {13 "dates_of_birth": "match",14 "documents": "match",15 "locations": "match",16 "names": "match",17 "search_terms_version": 118 },19 "data": {20 "dates_of_birth": [21 {22 "analysis": {23 "summary": "match"24 },25 "data": {26 "beginning": "1990-05-29",27 "ending": "1990-05-29"28 }29 }30 ],31 "documents": [32 {33 "analysis": {34 "summary": "match"35 },36 "data": {37 "type": "passport",38 "number": "C31195855"39 }40 }41 ],42 "locations": [43 {44 "analysis": {45 "summary": "match"46 },47 "data": {48 "full": "Florida, US",49 "country": "US"50 }51 }52 ],53 "names": [54 {55 "analysis": {56 "summary": "match"57 },58 "data": {59 "full": "Aleksey Potemkin",60 "is_primary": false,61 "weak_alias_determination": "none"62 }63 }64 ]65 }66 }67 ],68 "next_cursor": "eyJkaXJlY3Rpb24iOiJuZXh0Iiwib2Zmc2V0IjoiMTU5NDM",69 "request_id": "saKrIBuEB9qJZng"70}
Was this helpful?
/watchlist_screening/individual/program/get
Get individual watchlist screening program
Get an individual watchlist screening program
watchlist_screening/individual/program/getwatchlist_program_id
secret
secret
. The secret
is required and may be provided either in the PLAID-SECRET
header or as part of a request body.client_id
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.1const request: WatchlistScreeningIndividualProgramGetRequest = {2 watchlist_program_id: 'prg_2eRPsDnL66rZ7H',3};4
5try {6 const response = await client.watchlistScreeningIndividualProgramGet(request);7} catch (error) {8 // handle error9}
Response fields and example
id
created_at
date-time
is_rescanning_enabled
lists_enabled
AU_CON
, CA_CON
, EU_CON
, IZ_CIA
, IZ_IPL
, IZ_PEP
, IZ_UNC
, IZ_WBK
, UK_HMC
, US_DPL
, US_DTC
, US_FBI
, US_FSE
, US_ISN
, US_MBS
, US_PLC
, US_SDN
, US_SSI
, SG_SOF
, TR_TWL
, TR_DFD
, TR_FOR
, TR_WMD
, TR_CMB
name
name_sensitivity
coarse
- See more potential matches. This sensitivity will see more broad phonetic matches across alphabets that make missing a potential hit very unlikely. This setting is noisier and will require more manual review.balanced
- A good default for most companies. This sensitivity is balanced to show high quality hits with reduced noise.strict
- Aggressive false positive reduction. This sensitivity will require names to be more similar than coarse
and balanced
settings, relying less on phonetics, while still accounting for character transpositions, missing tokens, and other common permutations.exact
- Matches must be nearly exact. This sensitivity will only show hits with exact or nearly exact name matches with only basic correction such as extraneous symbols and capitalization. This setting is generally not recommended unless you have a very specific use case.coarse
, balanced
, strict
, exact
audit_trail
source
dashboard
, link
, api
, system
dashboard_user_id
/dashboard_user/get
.timestamp
date-time
is_archived
request_id
1{2 "id": "prg_2eRPsDnL66rZ7H",3 "created_at": "2020-07-24T03:26:02Z",4 "is_rescanning_enabled": true,5 "lists_enabled": [6 "US_SDN"7 ],8 "name": "Sample Program",9 "name_sensitivity": "balanced",10 "audit_trail": {11 "source": "dashboard",12 "dashboard_user_id": "54350110fedcbaf01234ffee",13 "timestamp": "2020-07-24T03:26:02Z"14 },15 "is_archived": false,16 "request_id": "saKrIBuEB9qJZng"17}
Was this helpful?
/watchlist_screening/individual/program/list
List individual watchlist screening programs
List all individual watchlist screening programs
watchlist_screening/individual/program/listsecret
secret
. The secret
is required and may be provided either in the PLAID-SECRET
header or as part of a request body.client_id
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.cursor
1try {2 const response = await client.watchlistScreeningIndividualProgramList({});3} catch (error) {4 // handle error5}
Response fields and example
watchlist_programs
id
created_at
date-time
is_rescanning_enabled
lists_enabled
AU_CON
, CA_CON
, EU_CON
, IZ_CIA
, IZ_IPL
, IZ_PEP
, IZ_UNC
, IZ_WBK
, UK_HMC
, US_DPL
, US_DTC
, US_FBI
, US_FSE
, US_ISN
, US_MBS
, US_PLC
, US_SDN
, US_SSI
, SG_SOF
, TR_TWL
, TR_DFD
, TR_FOR
, TR_WMD
, TR_CMB
name
name_sensitivity
coarse
- See more potential matches. This sensitivity will see more broad phonetic matches across alphabets that make missing a potential hit very unlikely. This setting is noisier and will require more manual review.balanced
- A good default for most companies. This sensitivity is balanced to show high quality hits with reduced noise.strict
- Aggressive false positive reduction. This sensitivity will require names to be more similar than coarse
and balanced
settings, relying less on phonetics, while still accounting for character transpositions, missing tokens, and other common permutations.exact
- Matches must be nearly exact. This sensitivity will only show hits with exact or nearly exact name matches with only basic correction such as extraneous symbols and capitalization. This setting is generally not recommended unless you have a very specific use case.coarse
, balanced
, strict
, exact
audit_trail
source
dashboard
, link
, api
, system
dashboard_user_id
/dashboard_user/get
.timestamp
date-time
is_archived
next_cursor
request_id
1{2 "watchlist_programs": [3 {4 "id": "prg_2eRPsDnL66rZ7H",5 "created_at": "2020-07-24T03:26:02Z",6 "is_rescanning_enabled": true,7 "lists_enabled": [8 "US_SDN"9 ],10 "name": "Sample Program",11 "name_sensitivity": "balanced",12 "audit_trail": {13 "source": "dashboard",14 "dashboard_user_id": "54350110fedcbaf01234ffee",15 "timestamp": "2020-07-24T03:26:02Z"16 },17 "is_archived": false18 }19 ],20 "next_cursor": "eyJkaXJlY3Rpb24iOiJuZXh0Iiwib2Zmc2V0IjoiMTU5NDM",21 "request_id": "saKrIBuEB9qJZng"22}
Was this helpful?
/watchlist_screening/entity/create
Create a watchlist screening for an entity
Create a new entity watchlist screening to check your customer against watchlists defined in the associated entity watchlist program. If your associated program has ongoing screening enabled, this is the profile information that will be used to monitor your customer over time.
watchlist_screening/entity/createsearch_terms
entity_watchlist _program_id
legal_name
document_number
email_address
email
country
phone_number
url
uri
client_user_id
/link/token/create
client_user_id
to be consistent. Personally identifiable information, such as an email address or phone number, should not be used in the client_user_id
.client_id
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.secret
secret
. The secret
is required and may be provided either in the PLAID-SECRET
header or as part of a request body.1const request: WatchlistScreeningEntityCreateRequest = {2 search_terms: {3 entity_watchlist_program_id: 'entprg_2eRPsDnL66rZ7H',4 legal_name: 'Example Screening Entity',5 document_number: 'C31195855',6 email_address: 'user@example.com',7 country: 'US',8 phone_number: '+14025671234',9 url: 'https://example.com',10 },11 client_user_id: 'example-client-user-id-123',12};13
14try {15 const response = await client.watchlistScreeningEntityCreate(request);16} catch (error) {17 // handle error18}
Response fields and example
id
search_terms
entity_watchlist _program_id
legal_name
document_number
email_address
email
country
phone_number
url
uri
version
1
and increments with each edit to search_terms
.assignee
/dashboard_user/get
.status
rejected
, pending_review
, cleared
client_user_id
/link/token/create
client_user_id
to be consistent. Personally identifiable information, such as an email address or phone number, should not be used in the client_user_id
.audit_trail
source
dashboard
, link
, api
, system
dashboard_user_id
/dashboard_user/get
.timestamp
date-time
request_id
1{2 "id": "entscr_52xR9LKo77r1Np",3 "search_terms": {4 "entity_watchlist_program_id": "entprg_2eRPsDnL66rZ7H",5 "legal_name": "Al-Qaida",6 "document_number": "C31195855",7 "email_address": "user@example.com",8 "country": "US",9 "phone_number": "+14025671234",10 "url": "https://example.com",11 "version": 112 },13 "assignee": "54350110fedcbaf01234ffee",14 "status": "cleared",15 "client_user_id": "your-db-id-3b24110",16 "audit_trail": {17 "source": "dashboard",18 "dashboard_user_id": "54350110fedcbaf01234ffee",19 "timestamp": "2020-07-24T03:26:02Z"20 },21 "request_id": "saKrIBuEB9qJZng"22}
Was this helpful?
/watchlist_screening/entity/get
Get an entity screening
Retrieve an entity watchlist screening.
watchlist_screening/entity/getentity_watchlist _screening_id
secret
secret
. The secret
is required and may be provided either in the PLAID-SECRET
header or as part of a request body.client_id
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.1const request: WatchlistScreeningEntityGetRequest = {2 entity_watchlist_screening_id: 'entscr_52xR9LKo77r1Np',3};4
5try {6 const response = await client.watchlistScreeningEntityGet(request);7} catch (error) {8 // handle error9}
Response fields and example
id
search_terms
entity_watchlist _program_id
legal_name
document_number
email_address
email
country
phone_number
url
uri
version
1
and increments with each edit to search_terms
.assignee
/dashboard_user/get
.status
rejected
, pending_review
, cleared
client_user_id
/link/token/create
client_user_id
to be consistent. Personally identifiable information, such as an email address or phone number, should not be used in the client_user_id
.audit_trail
source
dashboard
, link
, api
, system
dashboard_user_id
/dashboard_user/get
.timestamp
date-time
request_id
1{2 "id": "entscr_52xR9LKo77r1Np",3 "search_terms": {4 "entity_watchlist_program_id": "entprg_2eRPsDnL66rZ7H",5 "legal_name": "Al-Qaida",6 "document_number": "C31195855",7 "email_address": "user@example.com",8 "country": "US",9 "phone_number": "+14025671234",10 "url": "https://example.com",11 "version": 112 },13 "assignee": "54350110fedcbaf01234ffee",14 "status": "cleared",15 "client_user_id": "your-db-id-3b24110",16 "audit_trail": {17 "source": "dashboard",18 "dashboard_user_id": "54350110fedcbaf01234ffee",19 "timestamp": "2020-07-24T03:26:02Z"20 },21 "request_id": "saKrIBuEB9qJZng"22}
Was this helpful?
/watchlist_screening/entity/list
List entity watchlist screenings
List all entity screenings.
watchlist_screening/entity/listsecret
secret
. The secret
is required and may be provided either in the PLAID-SECRET
header or as part of a request body.client_id
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 _program_id
client_user_id
/link/token/create
client_user_id
to be consistent. Personally identifiable information, such as an email address or phone number, should not be used in the client_user_id
.status
rejected
, pending_review
, cleared
assignee
/dashboard_user/get
.cursor
1const request: WatchlistScreeningEntityListRequest = {2 entity_watchlist_program_id: 'entprg_2eRPsDnL66rZ7H',3};4
5try {6 const response = await client.watchlistScreeningEntityList(request);7} catch (error) {8 // handle error9}
Response fields and example
entity_watchlist _screenings
id
search_terms
entity_watchlist _program_id
legal_name
document_number
email_address
email
country
phone_number
url
uri
version
1
and increments with each edit to search_terms
.assignee
/dashboard_user/get
.status
rejected
, pending_review
, cleared
client_user_id
/link/token/create
client_user_id
to be consistent. Personally identifiable information, such as an email address or phone number, should not be used in the client_user_id
.audit_trail
source
dashboard
, link
, api
, system
dashboard_user_id
/dashboard_user/get
.timestamp
date-time
next_cursor
request_id
1{2 "entity_watchlist_screenings": [3 {4 "id": "entscr_52xR9LKo77r1Np",5 "search_terms": {6 "entity_watchlist_program_id": "entprg_2eRPsDnL66rZ7H",7 "legal_name": "Al-Qaida",8 "document_number": "C31195855",9 "email_address": "user@example.com",10 "country": "US",11 "phone_number": "+14025671234",12 "url": "https://example.com",13 "version": 114 },15 "assignee": "54350110fedcbaf01234ffee",16 "status": "cleared",17 "client_user_id": "your-db-id-3b24110",18 "audit_trail": {19 "source": "dashboard",20 "dashboard_user_id": "54350110fedcbaf01234ffee",21 "timestamp": "2020-07-24T03:26:02Z"22 }23 }24 ],25 "next_cursor": "eyJkaXJlY3Rpb24iOiJuZXh0Iiwib2Zmc2V0IjoiMTU5NDM",26 "request_id": "saKrIBuEB9qJZng"27}
Was this helpful?
/watchlist_screening/entity/update
Update an entity screening
Update an entity watchlist screening.
watchlist_screening/entity/updateentity_watchlist _screening_id
search_terms
entity_watchlist _program_id
legal_name
document_number
email_address
email
country
phone_number
url
uri
assignee
/dashboard_user/get
.status
rejected
, pending_review
, cleared
client_user_id
/link/token/create
client_user_id
to be consistent. Personally identifiable information, such as an email address or phone number, should not be used in the client_user_id
.client_id
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.secret
secret
. The secret
is required and may be provided either in the PLAID-SECRET
header or as part of a request body.reset_fields
assignee
1const request: WatchlistScreeningEntityUpdateRequest = {2 entity_watchlist_screening_id: 'entscr_52xR9LKo77r1Np',3 status: 'cleared',4};5
6try {7 const response = await client.watchlistScreeningEntityUpdate(request);8} catch (error) {9 // handle error10}
Response fields and example
id
search_terms
entity_watchlist _program_id
legal_name
document_number
email_address
email
country
phone_number
url
uri
version
1
and increments with each edit to search_terms
.assignee
/dashboard_user/get
.status
rejected
, pending_review
, cleared
client_user_id
/link/token/create
client_user_id
to be consistent. Personally identifiable information, such as an email address or phone number, should not be used in the client_user_id
.audit_trail
source
dashboard
, link
, api
, system
dashboard_user_id
/dashboard_user/get
.timestamp
date-time
request_id
1{2 "id": "entscr_52xR9LKo77r1Np",3 "search_terms": {4 "entity_watchlist_program_id": "entprg_2eRPsDnL66rZ7H",5 "legal_name": "Al-Qaida",6 "document_number": "C31195855",7 "email_address": "user@example.com",8 "country": "US",9 "phone_number": "+14025671234",10 "url": "https://example.com",11 "version": 112 },13 "assignee": "54350110fedcbaf01234ffee",14 "status": "cleared",15 "client_user_id": "your-db-id-3b24110",16 "audit_trail": {17 "source": "dashboard",18 "dashboard_user_id": "54350110fedcbaf01234ffee",19 "timestamp": "2020-07-24T03:26:02Z"20 },21 "request_id": "saKrIBuEB9qJZng"22}
Was this helpful?
/watchlist_screening/entity/history/list
List history for entity watchlist screenings
List all changes to the entity watchlist screening in reverse-chronological order. If the watchlist screening has not been edited, no history will be returned.
watchlist_screening/entity/history/listsecret
secret
. The secret
is required and may be provided either in the PLAID-SECRET
header or as part of a request body.client_id
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
cursor
1const request: WatchlistScreeningEntityHistoryListRequest = {2 entity_watchlist_screening_id: 'entscr_52xR9LKo77r1Np',3};4
5try {6 const response = await client.watchlistScreeningEntityHistoryList(request);7} catch (error) {8 // handle error9}
Response fields and example
entity_watchlist _screenings
id
search_terms
entity_watchlist _program_id
legal_name
document_number
email_address
email
country
phone_number
url
uri
version
1
and increments with each edit to search_terms
.assignee
/dashboard_user/get
.status
rejected
, pending_review
, cleared
client_user_id
/link/token/create
client_user_id
to be consistent. Personally identifiable information, such as an email address or phone number, should not be used in the client_user_id
.audit_trail
source
dashboard
, link
, api
, system
dashboard_user_id
/dashboard_user/get
.timestamp
date-time
next_cursor
request_id
1{2 "entity_watchlist_screenings": [3 {4 "id": "entscr_52xR9LKo77r1Np",5 "search_terms": {6 "entity_watchlist_program_id": "entprg_2eRPsDnL66rZ7H",7 "legal_name": "Al-Qaida",8 "document_number": "C31195855",9 "email_address": "user@example.com",10 "country": "US",11 "phone_number": "+14025671234",12 "url": "https://example.com",13 "version": 114 },15 "assignee": "54350110fedcbaf01234ffee",16 "status": "cleared",17 "client_user_id": "your-db-id-3b24110",18 "audit_trail": {19 "source": "dashboard",20 "dashboard_user_id": "54350110fedcbaf01234ffee",21 "timestamp": "2020-07-24T03:26:02Z"22 }23 }24 ],25 "next_cursor": "eyJkaXJlY3Rpb24iOiJuZXh0Iiwib2Zmc2V0IjoiMTU5NDM",26 "request_id": "saKrIBuEB9qJZng"27}
Was this helpful?
/watchlist_screening/entity/review/create
Create a review for an entity watchlist screening
Create a review for an entity watchlist screening. Reviews are compliance reports created by users in your organization regarding the relevance of potential hits found by Plaid.
watchlist_screening/entity/review/createconfirmed_hits
dismissed_hits
comment
client_id
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.secret
secret
. The secret
is required and may be provided either in the PLAID-SECRET
header or as part of a request body.entity_watchlist _screening_id
1const request: WatchlistScreeningEntityReviewCreateRequest = {2 entity_watchlist_screening_id: 'entscr_52xR9LKo77r1Np',3};4
5try {6 const response = await client.watchlistScreeningEntityReviewCreate(request);7} catch (error) {8 // handle error9}
Response fields and example
id
confirmed_hits
dismissed_hits
comment
audit_trail
source
dashboard
, link
, api
, system
dashboard_user_id
/dashboard_user/get
.timestamp
date-time
request_id
1{2 "id": "entrev_aCLNRxK3UVzn2r",3 "confirmed_hits": [4 "enthit_52xR9LKo77r1Np"5 ],6 "dismissed_hits": [7 "enthit_52xR9LKo77r1Np"8 ],9 "comment": "These look like legitimate matches, rejecting the customer.",10 "audit_trail": {11 "source": "dashboard",12 "dashboard_user_id": "54350110fedcbaf01234ffee",13 "timestamp": "2020-07-24T03:26:02Z"14 },15 "request_id": "saKrIBuEB9qJZng"16}
Was this helpful?
/watchlist_screening/entity/review/list
List reviews for entity watchlist screenings
List all reviews for a particular entity watchlist screening. Reviews are compliance reports created by users in your organization regarding the relevance of potential hits found by Plaid.
watchlist_screening/entity/review/listsecret
secret
. The secret
is required and may be provided either in the PLAID-SECRET
header or as part of a request body.client_id
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
cursor
1const request: WatchlistScreeningEntityReviewListRequest = {2 entity_watchlist_screening_id: 'entscr_52xR9LKo77r1Np',3};4
5try {6 const response = await client.watchlistScreeningEntityReviewList(request);7} catch (error) {8 // handle error9}
Response fields and example
entity_watchlist _screening_reviews
id
confirmed_hits
dismissed_hits
comment