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 |
/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/createRequest fields and example
search_terms requiredobject Search inputs for creating a watchlist screening
| |||||
client_user_id string An identifier to help you connect this object to your internal systems. For example, your database ID corresponding to this object. Min length: 1 Pattern: ^\S+(\s+\S+)*$ | |||||
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. | |||||
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. |
1// Client libraries coming soon
Response fields and example
id string ID of the associated screening. | ||||||
search_terms object Search terms for creating an individual watchlist screening
| ||||||
assignee nullable string ID of the associated user. | ||||||
status string A status enum indicating whether a screening is still pending review, has been rejected, or has been cleared. Possible values: rejected , pending_review , cleared | ||||||
client_user_id nullable string An identifier to help you connect this object to your internal systems. For example, your database ID corresponding to this object. Min length: 1 Pattern: ^\S+(\s+\S+)*$ | ||||||
audit_trail object Information about the last change made to the parent object specifying what caused the change as well as when it occurred.
| ||||||
request_id string A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive. |
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/getRequest fields and example
watchlist_screening_id requiredstring ID of the associated screening. |
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. |
1// Client libraries coming soon
Response fields and example
id string ID of the associated screening. | ||||||
search_terms object Search terms for creating an individual watchlist screening
| ||||||
assignee nullable string ID of the associated user. | ||||||
status string A status enum indicating whether a screening is still pending review, has been rejected, or has been cleared. Possible values: rejected , pending_review , cleared | ||||||
client_user_id nullable string An identifier to help you connect this object to your internal systems. For example, your database ID corresponding to this object. Min length: 1 Pattern: ^\S+(\s+\S+)*$ | ||||||
audit_trail object Information about the last change made to the parent object specifying what caused the change as well as when it occurred.
| ||||||
request_id string A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive. |
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/listRequest fields and example
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_program_id requiredstring ID of the associated program. |
client_user_id string An identifier to help you connect this object to your internal systems. For example, your database ID corresponding to this object. Min length: 1 Pattern: ^\S+(\s+\S+)*$ |
status string A status enum indicating whether a screening is still pending review, has been rejected, or has been cleared. Possible values: rejected , pending_review , cleared |
assignee string ID of the associated user. |
cursor string An identifier that determines which page of results you receive. |
1// Client libraries coming soon
Response fields and example
watchlist_screenings [object] List of individual watchlist screenings
| |||||||||||||||
next_cursor nullable string An identifier that determines which page of results you receive. | |||||||||||||||
request_id string A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive. |
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.
Request fields and example
watchlist_screening_id requiredstring ID of the associated screening. | |||||
search_terms object Search terms for editing an individual watchlist screening
| |||||
assignee string ID of the associated user. | |||||
status string A status enum indicating whether a screening is still pending review, has been rejected, or has been cleared. Possible values: rejected , pending_review , cleared | |||||
client_user_id string An identifier to help you connect this object to your internal systems. For example, your database ID corresponding to this object. Min length: 1 Pattern: ^\S+(\s+\S+)*$ | |||||
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. | |||||
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. | |||||
reset_fields [string] A list of fields to reset back to null Possible values: assignee |
1// Client libraries coming soon
Response fields and example
id string ID of the associated screening. | ||||||
search_terms object Search terms for creating an individual watchlist screening
| ||||||
assignee nullable string ID of the associated user. | ||||||
status string A status enum indicating whether a screening is still pending review, has been rejected, or has been cleared. Possible values: rejected , pending_review , cleared | ||||||
client_user_id nullable string An identifier to help you connect this object to your internal systems. For example, your database ID corresponding to this object. Min length: 1 Pattern: ^\S+(\s+\S+)*$ | ||||||
audit_trail object Information about the last change made to the parent object specifying what caused the change as well as when it occurred.
| ||||||
request_id string A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive. |
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/listRequest fields and example
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 requiredstring ID of the associated screening. |
cursor string An identifier that determines which page of results you receive. |
1// Client libraries coming soon
Response fields and example
watchlist_screenings [object] List of individual watchlist screenings
| |||||||||||||||
next_cursor nullable string An identifier that determines which page of results you receive. | |||||||||||||||
request_id string A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive. |
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/createRequest fields and example
confirmed_hits required[string] Hits to mark as a true positive after thorough manual review. These hits will never recur or be updated once dismissed. In most cases, confirmed hits indicate that the customer should be rejected. |
dismissed_hits required[string] Hits to mark as a false positive after thorough manual review. These hits will never recur or be updated once dismissed. |
comment string A comment submitted by a team member as part of reviewing a watchlist screening. Min length: 1 |
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. |
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. |
watchlist_screening_id requiredstring ID of the associated screening. |
1// Client libraries coming soon
Response fields and example
id string ID of the associated review. | |||
confirmed_hits [string] Hits marked as a true positive after thorough manual review. These hits will never recur or be updated once dismissed. In most cases, confirmed hits indicate that the customer should be rejected. | |||
dismissed_hits [string] Hits marked as a false positive after thorough manual review. These hits will never recur or be updated once dismissed. | |||
comment nullable string A comment submitted by a team member as part of reviewing a watchlist screening. Min length: 1 | |||
audit_trail object Information about the last change made to the parent object specifying what caused the change as well as when it occurred.
| |||
request_id string A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive. |
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/listRequest fields and example
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 requiredstring ID of the associated screening. |
cursor string An identifier that determines which page of results you receive. |
1// Client libraries coming soon
Response fields and example
watchlist_screening_reviews [object] List of screening reviews
| ||||||||
next_cursor nullable string An identifier that determines which page of results you receive. | ||||||||
request_id string A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive. |
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/listRequest fields and example
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 requiredstring ID of the associated screening. |
cursor string An identifier that determines which page of results you receive. |
1// Client libraries coming soon
Response fields and example
watchlist_screening_hits [object] List of individual watchlist screening hits
| ||||||||||||||||||||||||||||||||||||||||
next_cursor nullable string An identifier that determines which page of results you receive. | ||||||||||||||||||||||||||||||||||||||||
request_id string A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive. |
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/getRequest fields and example
watchlist_program_id requiredstring ID of the associated program. |
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. |
1// Client libraries coming soon
Response fields and example
id string ID of the associated program. | |||
created_at string An ISO8601 formatted timestamp. Format: date-time | |||
is_rescanning_enabled boolean Indicator specifying whether the program is enabled and will perform daily rescans. | |||
lists_enabled [string] Watchlists enabled for the associated program Possible values: AU_CON , CA_CON , EU_CON , IZ_CIA , IZ_IPL , IZ_PEP , IZ_UNC , UK_HMC , US_DPL , US_DTC , US_FBI , US_FSE , US_ISN , US_MBC , US_PLC , US_SDN , US_SSI , SG_SOF , TR_TWL , TR_DFD , TR_FOR , TR_WMD | |||
name string A name for the program to define its purpose. For example, "High Risk Individuals", "US Cardholders", or "Applicants". Min length: 1 Pattern: ^\S+(\s+\S+)*$ | |||
name_sensitivity string The valid name matching sensitivity configurations for a screening program. Note that while certain matching techniques may be more prevalent on less strict settings, all matching algorithms are enabled for every 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.Possible values: coarse , balanced , strict , exact | |||
audit_trail object Information about the last change made to the parent object specifying what caused the change as well as when it occurred.
| |||
is_archived boolean Archived programs are read-only and cannot screen new customers nor participate in ongoing monitoring. | |||
request_id string A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive. |
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/listRequest fields and example
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. |
cursor string An identifier that determines which page of results you receive. |
1// Client libraries coming soon
Response fields and example
watchlist_programs [object] List of individual watchlist screening programs
| |||||||||||
next_cursor nullable string An identifier that determines which page of results you receive. | |||||||||||
request_id string A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive. |
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/createRequest fields and example
search_terms requiredobject Search inputs for creating an entity watchlist screening
| |||||||
client_user_id string An identifier to help you connect this object to your internal systems. For example, your database ID corresponding to this object. Min length: 1 Pattern: ^\S+(\s+\S+)*$ | |||||||
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. | |||||||
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. |
1// Client libraries coming soon
Response fields and example
id string ID of the associated entity screening. | ||||||||
search_terms object Search terms associated with an entity used for searching against watchlists
| ||||||||
assignee nullable string ID of the associated user. | ||||||||
status string A status enum indicating whether a screening is still pending review, has been rejected, or has been cleared. Possible values: rejected , pending_review , cleared | ||||||||
client_user_id nullable string An identifier to help you connect this object to your internal systems. For example, your database ID corresponding to this object. Min length: 1 Pattern: ^\S+(\s+\S+)*$ | ||||||||
audit_trail object Information about the last change made to the parent object specifying what caused the change as well as when it occurred.
| ||||||||
request_id string A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive. |
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/getRequest fields and example
entity_watchlist_screening_id requiredstring ID of the associated entity screening. |
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. |
1// Client libraries coming soon
Response fields and example
id string ID of the associated entity screening. | ||||||||
search_terms object Search terms associated with an entity used for searching against watchlists
| ||||||||
assignee nullable string ID of the associated user. | ||||||||
status string A status enum indicating whether a screening is still pending review, has been rejected, or has been cleared. Possible values: rejected , pending_review , cleared | ||||||||
client_user_id nullable string An identifier to help you connect this object to your internal systems. For example, your database ID corresponding to this object. Min length: 1 Pattern: ^\S+(\s+\S+)*$ | ||||||||
audit_trail object Information about the last change made to the parent object specifying what caused the change as well as when it occurred.
| ||||||||
request_id string A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive. |
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/listRequest fields and example
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_program_id requiredstring ID of the associated entity program. |
client_user_id string An identifier to help you connect this object to your internal systems. For example, your database ID corresponding to this object. Min length: 1 Pattern: ^\S+(\s+\S+)*$ |
status string A status enum indicating whether a screening is still pending review, has been rejected, or has been cleared. Possible values: rejected , pending_review , cleared |
assignee string ID of the associated user. |
cursor string An identifier that determines which page of results you receive. |
1// Client libraries coming soon
Response fields and example
entity_watchlist_screenings [object] List of entity watchlist screening
| |||||||||||||||||
next_cursor nullable string An identifier that determines which page of results you receive. | |||||||||||||||||
request_id string A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive. |
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/updateRequest fields and example
entity_watchlist_screening_id requiredstring ID of the associated entity screening. | |||||||||
search_terms object Search terms for editing an entity watchlist screening
| |||||||||
assignee string ID of the associated user. | |||||||||
status string A status enum indicating whether a screening is still pending review, has been rejected, or has been cleared. Possible values: rejected , pending_review , cleared | |||||||||
client_user_id string An identifier to help you connect this object to your internal systems. For example, your database ID corresponding to this object. Min length: 1 Pattern: ^\S+(\s+\S+)*$ | |||||||||
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. | |||||||||
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. | |||||||||
reset_fields [string] A list of fields to reset back to null Possible values: assignee |
1// Client libraries coming soon
Response fields and example
id string ID of the associated entity screening. | ||||||||
search_terms object Search terms associated with an entity used for searching against watchlists
| ||||||||
assignee nullable string ID of the associated user. | ||||||||
status string A status enum indicating whether a screening is still pending review, has been rejected, or has been cleared. Possible values: rejected , pending_review , cleared | ||||||||
client_user_id nullable string An identifier to help you connect this object to your internal systems. For example, your database ID corresponding to this object. Min length: 1 Pattern: ^\S+(\s+\S+)*$ | ||||||||
audit_trail object Information about the last change made to the parent object specifying what caused the change as well as when it occurred.
| ||||||||
request_id string A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive. |
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/listRequest fields and example
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 requiredstring ID of the associated entity screening. |
cursor string An identifier that determines which page of results you receive. |
1// Client libraries coming soon
Response fields and example
entity_watchlist_screenings [object] List of entity watchlist screening
| |||||||||||||||||
next_cursor nullable string An identifier that determines which page of results you receive. | |||||||||||||||||
request_id string A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive. |
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/createRequest fields and example
confirmed_hits required[string] Hits to mark as a true positive after thorough manual review. These hits will never recur or be updated once dismissed. In most cases, confirmed hits indicate that the customer should be rejected. |
dismissed_hits required[string] Hits to mark as a false positive after thorough manual review. These hits will never recur or be updated once dismissed. |
comment string A comment submitted by a team member as part of reviewing a watchlist screening. Min length: 1 |
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. |
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. |
entity_watchlist_screening_id requiredstring ID of the associated entity screening. |
1// Client libraries coming soon
Response fields and example
id string ID of the associated entity review. | |||
confirmed_hits [string] Hits marked as a true positive after thorough manual review. These hits will never recur or be updated once dismissed. In most cases, confirmed hits indicate that the customer should be rejected. | |||
dismissed_hits [string] Hits marked as a false positive after thorough manual review. These hits will never recur or be updated once dismissed. | |||
comment nullable string A comment submitted by a team member as part of reviewing a watchlist screening. Min length: 1 | |||
audit_trail object Information about the last change made to the parent object specifying what caused the change as well as when it occurred.
| |||
request_id string A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive. |
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/listRequest fields and example
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 requiredstring ID of the associated entity screening. |
cursor string An identifier that determines which page of results you receive. |
1// Client libraries coming soon
Response fields and example
entity_watchlist_screening_reviews [object] List of entity watchlist screening reviews
| ||||||||
next_cursor nullable string An identifier that determines which page of results you receive. | ||||||||
request_id string A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive. |
1{2 "entity_watchlist_screening_reviews": [3 {4 "id": "entrev_aCLNRxK3UVzn2r",5 "confirmed_hits": [6 "enthit_52xR9LKo77r1Np"7 ],8 "dismissed_hits": [9 "enthit_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/entity/hit/list
List hits for entity watchlist screenings
List all hits for the entity watchlist screening.
watchlist_screening/entity/hit/listRequest fields and example
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 requiredstring ID of the associated entity screening. |
cursor string An identifier that determines which page of results you receive. |
1// Client libraries coming soon
Response fields and example
entity_watchlist_screening_hits [object] List of entity watchlist screening hits
| ||||||||||||||||||||||||||||||||||||||||||||||||||||
next_cursor nullable string An identifier that determines which page of results you receive. | ||||||||||||||||||||||||||||||||||||||||||||||||||||
request_id string A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive. |
1{2 "entity_watchlist_screening_hits": [3 {4 "id": "enthit_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": "EU_CON",10 "plaid_uid": "uid_3NggckTimGSJHS",11 "source_uid": "26192ABC",12 "analysis": {13 "documents": "match",14 "email_addresses": "match",15 "locations": "match",16 "names": "match",17 "phone_numbers": "match",18 "urls": "match",19 "search_terms_version": 120 },21 "data": {22 "documents": [23 {24 "analysis": {25 "summary": "match"26 },27 "data": {28 "type": "swift",29 "number": "C31195855"30 }31 }32 ],33 "email_addresses": [34 {35 "analysis": {36 "summary": "match"37 },38 "data": {39 "email_address": "user@example.com"40 }41 }42 ],43 "locations": [44 {45 "analysis": {46 "summary": "match"47 },48 "data": {49 "full": "Florida, US",50 "country": "US"51 }52 }53 ],54 "names": [55 {56 "analysis": {57 "summary": "match"58 },59 "data": {60 "full": "Al Qaida",61 "is_primary": false,62 "weak_alias_determination": "none"63 }64 }65 ],66 "phone_numbers": [67 {68 "analysis": {69 "summary": "match"70 },71 "data": {72 "type": "phone",73 "phone_number": "+14025671234"74 }75 }76 ],77 "urls": [78 {79 "analysis": {80 "summary": "match"81 },82 "data": {83 "url": "https://example.com"84 }85 }86 ]87 }88 }89 ],90 "next_cursor": "eyJkaXJlY3Rpb24iOiJuZXh0Iiwib2Zmc2V0IjoiMTU5NDM",91 "request_id": "saKrIBuEB9qJZng"92}
Was this helpful?
/watchlist_screening/entity/program/get
Get entity watchlist screening program
Get an entity watchlist screening program
watchlist_screening/entity/program/getRequest fields and example
entity_watchlist_program_id requiredstring ID of the associated entity program. |
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. |
1// Client libraries coming soon
Response fields and example
id string ID of the associated entity program. | |||
created_at string An ISO8601 formatted timestamp. Format: date-time | |||
is_rescanning_enabled boolean Indicator specifying whether the program is enabled and will perform daily rescans. | |||
lists_enabled [string] Watchlists enabled for the associated program Possible values: CA_CON , EU_CON , IZ_SOE , IZ_UNC , US_CAP , US_FSE , US_MBS , US_SDN , US_SSI , US_CMC , US_UVL , AU_CON , UK_HMC | |||
name string A name for the entity program to define its purpose. For example, "High Risk Organizations" or "Applicants". Min length: 1 Pattern: ^\S+(\s+\S+)*$ | |||
name_sensitivity string The valid name matching sensitivity configurations for a screening program. Note that while certain matching techniques may be more prevalent on less strict settings, all matching algorithms are enabled for every 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.Possible values: coarse , balanced , strict , exact | |||
audit_trail object Information about the last change made to the parent object specifying what caused the change as well as when it occurred.
| |||
is_archived boolean Archived programs are read-only and cannot screen new customers nor participate in ongoing monitoring. | |||
request_id string A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive. |
1{2 "id": "entprg_2eRPsDnL66rZ7H",3 "created_at": "2020-07-24T03:26:02Z",4 "is_rescanning_enabled": true,5 "lists_enabled": [6 "EU_CON"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}