Monitor

API reference for Monitor endpoints and webhooks

Endpoints
/watchlist_screening/individual/createCreate a watchlist screening for a person
/watchlist_screening/individual/getRetrieve an individual watchlist screening
/watchlist_screening/individual/listList individual watchlist screenings
/watchlist_screening/individual/updateUpdate individual watchlist screening
/watchlist_screening/individual/history/listList history for entity watchlist screenings
/watchlist_screening/individual/review/createCreate a review for an individual watchlist screening
/watchlist_screening/individual/review/listList reviews for individual watchlist screenings
/watchlist_screening/individual/hit/listList hits for individual watchlist screenings
/watchlist_screening/individual/program/getGet individual watchlist screening programs
/watchlist_screening/individual/program/listList individual watchlist screening programs
/watchlist_screening/entity/createCreate a watchlist screening for an entity
/watchlist_screening/entity/getRetrieve an individual watchlist screening
/watchlist_screening/entity/listList individual watchlist screenings
/watchlist_screening/entity/updateUpdate individual watchlist screening
/watchlist_screening/entity/history/listList history for individual watchlist screenings
/watchlist_screening/entity/review/createCreate a review for an individual watchlist screening
/watchlist_screening/entity/review/listList reviews for individual watchlist screenings
/watchlist_screening/entity/hit/listList hits for individual watchlist screenings
/watchlist_screening/entity/program/getGet individual watchlist screening programs
/watchlist_screening/entity/program/listList individual watchlist screening programs
/dashboard_user/getRetrieve information about a dashboard user
/dashboard_user/listList dashboard users
Webhooks
SCREENING: STATUS_UPDATEDThe status of an individual watchlist screening has changed
ENTITY_SCREENING: STATUS_UPDATEDThe 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/create

Request fields and example

search_terms
requiredobject
Search inputs for creating a watchlist screening
watchlist_program_id
requiredstring
ID of the associated program.
legal_name
requiredstring
The legal name of the individual being screened.

Min length: 1
Pattern: ^\S+(\s+\S+)*$
date_of_birth
string
A date in the format YYYY-MM-DD (RFC 3339 Section 5.6).

Format: date
document_number
string
The numeric or alphanumeric identifier associated with this document.

Min length: 4
Pattern: ^\S+(\s+\S+)*$
country
string
Valid, capitalized, two-letter ISO code representing the country of this object. Must be in ISO 3166-1 alpha-2 form.

Min length: 2
Pattern: ^[A-Z]{2}$
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
watchlist_screening/individual/create

Response fields and example

id
string
ID of the associated screening.
search_terms
object
Search terms for creating an individual watchlist screening
watchlist_program_id
string
ID of the associated program.
legal_name
string
The legal name of the individual being screened.

Min length: 1
Pattern: ^\S+(\s+\S+)*$
date_of_birth
nullable string
A date in the format YYYY-MM-DD (RFC 3339 Section 5.6).

Format: date
document_number
nullable string
The numeric or alphanumeric identifier associated with this document.

Min length: 4
Pattern: ^\S+(\s+\S+)*$
country
nullable string
Valid, capitalized, two-letter ISO code representing the country of this object. Must be in ISO 3166-1 alpha-2 form.

Min length: 2
Pattern: ^[A-Z]{2}$
version
number
The current version of the search terms. Starts at 1 and increments with each edit to search_terms.
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.
source
string
A type indicating whether a dashboard user, an API-based user, or Plaid last touched this object.

Possible values: dashboard, link, api, system
dashboard_user_id
nullable string
ID of the associated user.
timestamp
string
An ISO8601 formatted timestamp.

Format: date-time
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": 1
10  },
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}

/watchlist_screening/individual/get

Retrieve an individual watchlist screening

Retrieve a previously created individual watchlist screening

watchlist_screening/individual/get

Request 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
watchlist_screening/individual/get

Response fields and example

id
string
ID of the associated screening.
search_terms
object
Search terms for creating an individual watchlist screening
watchlist_program_id
string
ID of the associated program.
legal_name
string
The legal name of the individual being screened.

Min length: 1
Pattern: ^\S+(\s+\S+)*$
date_of_birth
nullable string
A date in the format YYYY-MM-DD (RFC 3339 Section 5.6).

Format: date
document_number
nullable string
The numeric or alphanumeric identifier associated with this document.

Min length: 4
Pattern: ^\S+(\s+\S+)*$
country
nullable string
Valid, capitalized, two-letter ISO code representing the country of this object. Must be in ISO 3166-1 alpha-2 form.

Min length: 2
Pattern: ^[A-Z]{2}$
version
number
The current version of the search terms. Starts at 1 and increments with each edit to search_terms.
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.
source
string
A type indicating whether a dashboard user, an API-based user, or Plaid last touched this object.

Possible values: dashboard, link, api, system
dashboard_user_id
nullable string
ID of the associated user.
timestamp
string
An ISO8601 formatted timestamp.

Format: date-time
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": 1
10  },
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}

/watchlist_screening/individual/list

List Individual Watchlist Screenings

List previously created watchlist screenings for individuals

watchlist_screening/individual/list

Request 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
watchlist_screening/individual/list

Response fields and example

watchlist_screenings
[object]
List of individual watchlist screenings
id
string
ID of the associated screening.
search_terms
object
Search terms for creating an individual watchlist screening
watchlist_program_id
string
ID of the associated program.
legal_name
string
The legal name of the individual being screened.

Min length: 1
Pattern: ^\S+(\s+\S+)*$
date_of_birth
nullable string
A date in the format YYYY-MM-DD (RFC 3339 Section 5.6).

Format: date
document_number
nullable string
The numeric or alphanumeric identifier associated with this document.

Min length: 4
Pattern: ^\S+(\s+\S+)*$
country
nullable string
Valid, capitalized, two-letter ISO code representing the country of this object. Must be in ISO 3166-1 alpha-2 form.

Min length: 2
Pattern: ^[A-Z]{2}$
version
number
The current version of the search terms. Starts at 1 and increments with each edit to search_terms.
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.
source
string
A type indicating whether a dashboard user, an API-based user, or Plaid last touched this object.

Possible values: dashboard, link, api, system
dashboard_user_id
nullable string
ID of the associated user.
timestamp
string
An ISO8601 formatted timestamp.

Format: date-time
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": 1
12      },
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}

/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/individual/update

Request fields and example

watchlist_screening_id
requiredstring
ID of the associated screening.
search_terms
object
Search terms for editing an individual watchlist screening
watchlist_program_id
string
ID of the associated program.
legal_name
string
The legal name of the individual being screened.

Min length: 1
Pattern: ^\S+(\s+\S+)*$
date_of_birth
string
A date in the format YYYY-MM-DD (RFC 3339 Section 5.6).

Format: date
document_number
string
The numeric or alphanumeric identifier associated with this document.

Min length: 4
Pattern: ^\S+(\s+\S+)*$
country
string
Valid, capitalized, two-letter ISO code representing the country of this object. Must be in ISO 3166-1 alpha-2 form.

Min length: 2
Pattern: ^[A-Z]{2}$
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
watchlist_screening/individual/update

Response fields and example

id
string
ID of the associated screening.
search_terms
object
Search terms for creating an individual watchlist screening
watchlist_program_id
string
ID of the associated program.
legal_name
string
The legal name of the individual being screened.

Min length: 1
Pattern: ^\S+(\s+\S+)*$
date_of_birth
nullable string
A date in the format YYYY-MM-DD (RFC 3339 Section 5.6).

Format: date
document_number
nullable string
The numeric or alphanumeric identifier associated with this document.

Min length: 4
Pattern: ^\S+(\s+\S+)*$
country
nullable string
Valid, capitalized, two-letter ISO code representing the country of this object. Must be in ISO 3166-1 alpha-2 form.

Min length: 2
Pattern: ^[A-Z]{2}$
version
number
The current version of the search terms. Starts at 1 and increments with each edit to search_terms.
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.
source
string
A type indicating whether a dashboard user, an API-based user, or Plaid last touched this object.

Possible values: dashboard, link, api, system
dashboard_user_id
nullable string
ID of the associated user.
timestamp
string
An ISO8601 formatted timestamp.

Format: date-time
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": 1
10  },
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}

/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/list

Request 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
watchlist_screening/individual/history/list

Response fields and example

watchlist_screenings
[object]
List of individual watchlist screenings
id
string
ID of the associated screening.
search_terms
object
Search terms for creating an individual watchlist screening
watchlist_program_id
string
ID of the associated program.
legal_name
string
The legal name of the individual being screened.

Min length: 1
Pattern: ^\S+(\s+\S+)*$
date_of_birth
nullable string
A date in the format YYYY-MM-DD (RFC 3339 Section 5.6).

Format: date
document_number
nullable string
The numeric or alphanumeric identifier associated with this document.

Min length: 4
Pattern: ^\S+(\s+\S+)*$
country
nullable string
Valid, capitalized, two-letter ISO code representing the country of this object. Must be in ISO 3166-1 alpha-2 form.

Min length: 2
Pattern: ^[A-Z]{2}$
version
number
The current version of the search terms. Starts at 1 and increments with each edit to search_terms.
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.
source
string
A type indicating whether a dashboard user, an API-based user, or Plaid last touched this object.

Possible values: dashboard, link, api, system
dashboard_user_id
nullable string
ID of the associated user.
timestamp
string
An ISO8601 formatted timestamp.

Format: date-time
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": 1
12      },
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}

/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/create

Request 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
watchlist_screening/individual/review/create

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.
source
string
A type indicating whether a dashboard user, an API-based user, or Plaid last touched this object.

Possible values: dashboard, link, api, system
dashboard_user_id
nullable string
ID of the associated user.
timestamp
string
An ISO8601 formatted timestamp.

Format: date-time
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}

/watchlist_screening/individual/review/list

List reviews for individual watchlist screenings

List all reviews for the individual watchlist screening.

watchlist_screening/individual/review/list

Request 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
watchlist_screening/individual/review/list

Response fields and example

watchlist_screening_reviews
[object]
List of screening reviews
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.
source
string
A type indicating whether a dashboard user, an API-based user, or Plaid last touched this object.

Possible values: dashboard, link, api, system
dashboard_user_id
nullable string
ID of the associated user.
timestamp
string
An ISO8601 formatted timestamp.

Format: date-time
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}

/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/list

Request 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
watchlist_screening/individual/hit/list

Response fields and example

watchlist_screening_hits
[object]
List of individual watchlist screening hits
id
string
ID of the associated screening hit.
review_status
string
The current state of review. All watchlist screening hits begin in a pending_review state but can be changed by creating a review. When a hit is in the pending_review state, it will always show the latest version of the watchlist data Plaid has available and be compared against the latest customer information saved in the watchlist screening. Once a hit has been marked as confirmed or dismissed it will no longer be updated so that the state is as it was when the review was first conducted.

Possible values: confirmed, pending_review, dismissed
first_active
string
An ISO8601 formatted timestamp.

Format: date-time
inactive_since
nullable string
An ISO8601 formatted timestamp.

Format: date-time
historical_since
nullable string
An ISO8601 formatted timestamp.

Format: date-time
list_code
string
Shorthand identifier for a specific screening list for individuals.

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
plaid_uid
string
A universal identifier for a watchlist individual that is stable across searches and updates.
source_uid
nullable string
The identifier provided by the source sanction or watchlist. When one is not provided by the source, this is null.

Min length: 1
analysis
object
Analysis information describing why a screening hit matched the provided user information
dates_of_birth
string
An enum indicating the match type between data provided by user and data checked against an external data source.
match indicates that the provided input data was a strong match against external data.
partial_match indicates the data approximately matched against external data. For example, "Knope" vs. "Knope-Wyatt" for last name.
no_match indicates that Plaid was able to perform a check against an external data source and it did not match the provided input data.
no_data indicates that Plaid was unable to find external data to compare against the provided input data.
no_input indicates that Plaid was unable to perform a check because no information was provided for this field by the end user.

Possible values: match, partial_match, no_match, no_data, no_input
documents
string
An enum indicating the match type between data provided by user and data checked against an external data source.
match indicates that the provided input data was a strong match against external data.
partial_match indicates the data approximately matched against external data. For example, "Knope" vs. "Knope-Wyatt" for last name.
no_match indicates that Plaid was able to perform a check against an external data source and it did not match the provided input data.
no_data indicates that Plaid was unable to find external data to compare against the provided input data.
no_input indicates that Plaid was unable to perform a check because no information was provided for this field by the end user.

Possible values: match, partial_match, no_match, no_data, no_input
locations
string
An enum indicating the match type between data provided by user and data checked against an external data source.
match indicates that the provided input data was a strong match against external data.
partial_match indicates the data approximately matched against external data. For example, "Knope" vs. "Knope-Wyatt" for last name.
no_match indicates that Plaid was able to perform a check against an external data source and it did not match the provided input data.
no_data indicates that Plaid was unable to find external data to compare against the provided input data.
no_input indicates that Plaid was unable to perform a check because no information was provided for this field by the end user.

Possible values: match, partial_match, no_match, no_data, no_input
names
string
An enum indicating the match type between data provided by user and data checked against an external data source.
match indicates that the provided input data was a strong match against external data.
partial_match indicates the data approximately matched against external data. For example, "Knope" vs. "Knope-Wyatt" for last name.
no_match indicates that Plaid was able to perform a check against an external data source and it did not match the provided input data.
no_data indicates that Plaid was unable to find external data to compare against the provided input data.
no_input indicates that Plaid was unable to perform a check because no information was provided for this field by the end user.

Possible values: match, partial_match, no_match, no_data, no_input
search_terms_version
number
The version of the screening's search_terms that were compared when the screening hit was added. screening hits are immutable once they have been reviewed. If changes are detected due to updates to the screening's search_terms, the associated program, or the list's source data prior to review, the screening hit will be updated to reflect those changes.
data
object
Information associated with the watchlist hit
dates_of_birth
[object]
Dates of birth associated with the watchlist hit
analysis
object
Summary object reflecting the match result of the associated data
summary
string
An enum indicating the match type between data provided by user and data checked against an external data source.
match indicates that the provided input data was a strong match against external data.
partial_match indicates the data approximately matched against external data. For example, "Knope" vs. "Knope-Wyatt" for last name.
no_match indicates that Plaid was able to perform a check against an external data source and it did not match the provided input data.
no_data indicates that Plaid was unable to find external data to compare against the provided input data.
no_input indicates that Plaid was unable to perform a check because no information was provided for this field by the end user.

Possible values: match, partial_match, no_match, no_data, no_input
data
object
A date range with a start and end date
beginning
string
A date in the format YYYY-MM-DD (RFC 3339 Section 5.6).

Format: date
ending
string
A date in the format YYYY-MM-DD (RFC 3339 Section 5.6).

Format: date
documents
[object]
Documents associated with the watchlist hit
analysis
object
Summary object reflecting the match result of the associated data
summary
string
An enum indicating the match type between data provided by user and data checked against an external data source.
match indicates that the provided input data was a strong match against external data.
partial_match indicates the data approximately matched against external data. For example, "Knope" vs. "Knope-Wyatt" for last name.
no_match indicates that Plaid was able to perform a check against an external data source and it did not match the provided input data.
no_data indicates that Plaid was unable to find external data to compare against the provided input data.
no_input indicates that Plaid was unable to perform a check because no information was provided for this field by the end user.

Possible values: match, partial_match, no_match, no_data, no_input
data
object
An official document, usually issued by a governing body or institution, with an associated identifier.
type
string
The kind of official document represented by this object.
birth_certificate - A certificate of birth
drivers_license - A license to operate a motor vehicle
immigration_number - Immigration or residence documents
military_id - Identification issued by a military group
other - Any document not covered by other categories
passport - An official passport issue by a government
personal_identification - Any generic personal identification that is not covered by other categories
ration_card - Identification that entitles the holder to rations
ssn - United States Social Security Number
student_id - Identification issued by an educational institution
tax_id - Identification issued for the purpose of collecting taxes
travel_document - Visas, entry permits, refugee documents, etc.
voter_id - Identification issued for the purpose of voting

Possible values: birth_certificate, drivers_license, immigration_number, military_id, other, passport, personal_identification, ration_card, ssn, student_id, tax_id, travel_document, voter_id
number
string
The numeric or alphanumeric identifier associated with this document.

Min length: 4
Pattern: ^\S+(\s+\S+)*$
locations
[object]
Locations associated with the watchlist hit
analysis
object
Summary object reflecting the match result of the associated data
summary
string
An enum indicating the match type between data provided by user and data checked against an external data source.
match indicates that the provided input data was a strong match against external data.
partial_match indicates the data approximately matched against external data. For example, "Knope" vs. "Knope-Wyatt" for last name.
no_match indicates that Plaid was able to perform a check against an external data source and it did not match the provided input data.
no_data indicates that Plaid was unable to find external data to compare against the provided input data.
no_input indicates that Plaid was unable to perform a check because no information was provided for this field by the end user.

Possible values: match, partial_match, no_match, no_data, no_input
data
object
Location information for the associated individual watchlist hit
full
string
The full location string, potentially including elements like street, city, postal codes and country codes. Note that this is not necessarily a complete or well-formatted address.
country
string
Valid, capitalized, two-letter ISO code representing the country of this object. Must be in ISO 3166-1 alpha-2 form.

Min length: 2
Pattern: ^[A-Z]{2}$
names
[object]
Names associated with the watchlist hit
analysis
object
Summary object reflecting the match result of the associated data
summary
string
An enum indicating the match type between data provided by user and data checked against an external data source.
match indicates that the provided input data was a strong match against external data.
partial_match indicates the data approximately matched against external data. For example, "Knope" vs. "Knope-Wyatt" for last name.
no_match indicates that Plaid was able to perform a check against an external data source and it did not match the provided input data.
no_data indicates that Plaid was unable to find external data to compare against the provided input data.
no_input indicates that Plaid was unable to perform a check because no information was provided for this field by the end user.

Possible values: match, partial_match, no_match, no_data, no_input
data
object
Name information for the associated individual watchlist hit
full
string
The full name of the individual, including all parts.
is_primary
boolean
Primary names are those most commonly used to refer to this person. Only one name will ever be marked as primary.
weak_alias_determination
string
Names that are explicitly marked as low quality either by their source list, or by plaid by a series of additional checks done by Plaid. Plaid does not ever surface a hit as a result of a weak name alone. If a name has no quality issues, this value will be none.

Possible values: none, source, plaid
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": 1
18      },
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}

/watchlist_screening/individual/program/get

Get individual watchlist screening program

Get an individual watchlist screening program

watchlist_screening/individual/program/get

Request 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
watchlist_screening/individual/program/get

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.
source
string
A type indicating whether a dashboard user, an API-based user, or Plaid last touched this object.

Possible values: dashboard, link, api, system
dashboard_user_id
nullable string
ID of the associated user.
timestamp
string
An ISO8601 formatted timestamp.

Format: date-time
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}

/watchlist_screening/individual/program/list

List individual watchlist screening programs

List all individual watchlist screening programs

watchlist_screening/individual/program/list

Request 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
watchlist_screening/individual/program/list

Response fields and example

watchlist_programs
[object]
List of individual watchlist screening programs
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.
source
string
A type indicating whether a dashboard user, an API-based user, or Plaid last touched this object.

Possible values: dashboard, link, api, system
dashboard_user_id
nullable string
ID of the associated user.
timestamp
string
An ISO8601 formatted timestamp.

Format: date-time
is_archived
boolean
Archived programs are read-only and cannot screen new customers nor participate in ongoing monitoring.
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": false
18    }
19  ],
20  "next_cursor": "eyJkaXJlY3Rpb24iOiJuZXh0Iiwib2Zmc2V0IjoiMTU5NDM",
21  "request_id": "saKrIBuEB9qJZng"
22}

/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/create

Request fields and example

search_terms
requiredobject
Search inputs for creating an entity watchlist screening
entity_watchlist_program_id
requiredstring
ID of the associated entity program.
legal_name
requiredstring
The name of the organization being screened.

Min length: 1
Pattern: ^\S+(\s+\S+)*$
document_number
string
The numeric or alphanumeric identifier associated with this document.

Min length: 4
Pattern: ^\S+(\s+\S+)*$
email_address
string
A valid email address.

Format: email
country
string
Valid, capitalized, two-letter ISO code representing the country of this object. Must be in ISO 3166-1 alpha-2 form.

Min length: 2
Pattern: ^[A-Z]{2}$
phone_number
string
A phone number in E.164 format.

Pattern: ^\+[1-9]\d{6,14}$
url
string
An 'http' or 'https' URL (must begin with either of those).

Format: uri
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
watchlist_screening/entity/create

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
entity_watchlist_program_id
string
ID of the associated entity program.
legal_name
string
The name of the organization being screened.

Min length: 1
Pattern: ^\S+(\s+\S+)*$
document_number
nullable string
The numeric or alphanumeric identifier associated with this document.

Min length: 4
Pattern: ^\S+(\s+\S+)*$
email_address
nullable string
A valid email address.

Format: email
country
nullable string
Valid, capitalized, two-letter ISO code representing the country of this object. Must be in ISO 3166-1 alpha-2 form.

Min length: 2
Pattern: ^[A-Z]{2}$
phone_number
nullable string
A phone number in E.164 format.

Pattern: ^\+[1-9]\d{6,14}$
url
nullable string
An 'http' or 'https' URL (must begin with either of those).

Format: uri
version
number
The current version of the search terms. Starts at 1 and increments with each edit to search_terms.
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.
source
string
A type indicating whether a dashboard user, an API-based user, or Plaid last touched this object.

Possible values: dashboard, link, api, system
dashboard_user_id
nullable string
ID of the associated user.
timestamp
string
An ISO8601 formatted timestamp.

Format: date-time
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": 1
12  },
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}

/watchlist_screening/entity/get

Get an entity screening

Retrieve an entity watchlist screening.

watchlist_screening/entity/get

Request 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
watchlist_screening/entity/get

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
entity_watchlist_program_id
string
ID of the associated entity program.
legal_name
string
The name of the organization being screened.

Min length: 1
Pattern: ^\S+(\s+\S+)*$
document_number
nullable string
The numeric or alphanumeric identifier associated with this document.

Min length: 4
Pattern: ^\S+(\s+\S+)*$
email_address
nullable string
A valid email address.

Format: email
country
nullable string
Valid, capitalized, two-letter ISO code representing the country of this object. Must be in ISO 3166-1 alpha-2 form.

Min length: 2
Pattern: ^[A-Z]{2}$
phone_number
nullable string
A phone number in E.164 format.

Pattern: ^\+[1-9]\d{6,14}$
url
nullable string
An 'http' or 'https' URL (must begin with either of those).

Format: uri
version
number
The current version of the search terms. Starts at 1 and increments with each edit to search_terms.
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.
source
string
A type indicating whether a dashboard user, an API-based user, or Plaid last touched this object.

Possible values: dashboard, link, api, system
dashboard_user_id
nullable string
ID of the associated user.
timestamp
string
An ISO8601 formatted timestamp.

Format: date-time
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": 1
12  },
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}

/watchlist_screening/entity/list

List entity watchlist screenings

List all entity screenings.

watchlist_screening/entity/list

Request 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
watchlist_screening/entity/list

Response fields and example

entity_watchlist_screenings
[object]
List of entity watchlist screening
id
string
ID of the associated entity screening.
search_terms
object
Search terms associated with an entity used for searching against watchlists
entity_watchlist_program_id
string
ID of the associated entity program.
legal_name
string
The name of the organization being screened.

Min length: 1
Pattern: ^\S+(\s+\S+)*$
document_number
nullable string
The numeric or alphanumeric identifier associated with this document.

Min length: 4
Pattern: ^\S+(\s+\S+)*$
email_address
nullable string
A valid email address.

Format: email
country
nullable string
Valid, capitalized, two-letter ISO code representing the country of this object. Must be in ISO 3166-1 alpha-2 form.

Min length: 2
Pattern: ^[A-Z]{2}$
phone_number
nullable string
A phone number in E.164 format.

Pattern: ^\+[1-9]\d{6,14}$
url
nullable string
An 'http' or 'https' URL (must begin with either of those).

Format: uri
version
number
The current version of the search terms. Starts at 1 and increments with each edit to search_terms.
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.
source
string
A type indicating whether a dashboard user, an API-based user, or Plaid last touched this object.

Possible values: dashboard, link, api, system
dashboard_user_id
nullable string
ID of the associated user.
timestamp
string
An ISO8601 formatted timestamp.

Format: date-time
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": 1
14      },
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}

/watchlist_screening/entity/update

Update an entity screening

Update an entity watchlist screening.

watchlist_screening/entity/update

Request 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
entity_watchlist_program_id
requiredstring
ID of the associated entity program.
legal_name
string
The name of the organization being screened.

Min length: 1
Pattern: ^\S+(\s+\S+)*$
document_number
string
The numeric or alphanumeric identifier associated with this document.

Min length: 4
Pattern: ^\S+(\s+\S+)*$
email_address
string
A valid email address.

Format: email
country
string
Valid, capitalized, two-letter ISO code representing the country of this object. Must be in ISO 3166-1 alpha-2 form.

Min length: 2
Pattern: ^[A-Z]{2}$
phone_number
string
A phone number in E.164 format.

Pattern: ^\+[1-9]\d{6,14}$
url
string
An 'http' or 'https' URL (must begin with either of those).

Format: uri
client_id
requiredstring
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
requiredstring
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.
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
watchlist_screening/entity/update

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
entity_watchlist_program_id
string
ID of the associated entity program.
legal_name
string
The name of the organization being screened.

Min length: 1
Pattern: ^\S+(\s+\S+)*$
document_number
nullable string
The numeric or alphanumeric identifier associated with this document.

Min length: 4
Pattern: ^\S+(\s+\S+)*$
email_address
nullable string
A valid email address.

Format: email
country
nullable string
Valid, capitalized, two-letter ISO code representing the country of this object. Must be in ISO 3166-1 alpha-2 form.

Min length: 2
Pattern: ^[A-Z]{2}$
phone_number
nullable string
A phone number in E.164 format.

Pattern: ^\+[1-9]\d{6,14}$
url
nullable string
An 'http' or 'https' URL (must begin with either of those).

Format: uri
version
number
The current version of the search terms. Starts at 1 and increments with each edit to search_terms.
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.
source
string
A type indicating whether a dashboard user, an API-based user, or Plaid last touched this object.

Possible values: dashboard, link, api, system
dashboard_user_id
nullable string
ID of the associated user.
timestamp
string
An ISO8601 formatted timestamp.

Format: date-time
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": 1
12  },
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}

/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/list

Request 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
watchlist_screening/entity/history/list

Response fields and example

entity_watchlist_screenings
[object]
List of entity watchlist screening
id
string
ID of the associated entity screening.
search_terms
object
Search terms associated with an entity used for searching against watchlists
entity_watchlist_program_id
string
ID of the associated entity program.
legal_name
string
The name of the organization being screened.

Min length: 1
Pattern: ^\S+(\s+\S+)*$
document_number
nullable string
The numeric or alphanumeric identifier associated with this document.

Min length: 4
Pattern: ^\S+(\s+\S+)*$
email_address
nullable string
A valid email address.

Format: email
country
nullable string
Valid, capitalized, two-letter ISO code representing the country of this object. Must be in ISO 3166-1 alpha-2 form.

Min length: 2
Pattern: ^[A-Z]{2}$
phone_number
nullable string
A phone number in E.164 format.

Pattern: ^\+[1-9]\d{6,14}$
url
nullable string
An 'http' or 'https' URL (must begin with either of those).

Format: uri
version
number
The current version of the search terms. Starts at 1 and increments with each edit to search_terms.
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.
source
string
A type indicating whether a dashboard user, an API-based user, or Plaid last touched this object.

Possible values: dashboard, link, api, system
dashboard_user_id
nullable string
ID of the associated user.
timestamp
string
An ISO8601 formatted timestamp.

Format: date-time
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": 1
14      },
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}

/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/create

Request 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
watchlist_screening/entity/review/create

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.
source
string
A type indicating whether a dashboard user, an API-based user, or Plaid last touched this object.

Possible values: dashboard, link, api, system
dashboard_user_id
nullable string
ID of the associated user.
timestamp
string
An ISO8601 formatted timestamp.

Format: date-time
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}

/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/list

Request 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
watchlist_screening/entity/review/list

Response fields and example

entity_watchlist_screening_reviews
[object]
List of entity watchlist screening reviews
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.
source
string
A type indicating whether a dashboard user, an API-based user, or Plaid last touched this object.

Possible values: dashboard, link, api, system
dashboard_user_id
nullable string
ID of the associated user.
timestamp
string
An ISO8601 formatted timestamp.

Format: date-time
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}

/watchlist_screening/entity/hit/list

List hits for entity watchlist screenings

List all hits for the entity watchlist screening.

watchlist_screening/entity/hit/list

Request 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
watchlist_screening/entity/hit/list

Response fields and example

entity_watchlist_screening_hits
[object]
List of entity watchlist screening hits
id
string
ID of the associated entity screening hit.
review_status
string
The current state of review. All watchlist screening hits begin in a pending_review state but can be changed by creating a review. When a hit is in the pending_review state, it will always show the latest version of the watchlist data Plaid has available and be compared against the latest customer information saved in the watchlist screening. Once a hit has been marked as confirmed or dismissed it will no longer be updated so that the state is as it was when the review was first conducted.

Possible values: confirmed, pending_review, dismissed
first_active
string
An ISO8601 formatted timestamp.

Format: date-time
inactive_since
nullable string
An ISO8601 formatted timestamp.

Format: date-time
historical_since
nullable string
An ISO8601 formatted timestamp.

Format: date-time
list_code
string
Shorthand identifier for a specific screening list for entities.

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
plaid_uid
string
A universal identifier for a watchlist individual that is stable across searches and updates.
source_uid
nullable string
The identifier provided by the source sanction or watchlist. When one is not provided by the source, this is null.

Min length: 1
analysis
object
Analysis information describing why a screening hit matched the provided entity information
documents
string
An enum indicating the match type between data provided by user and data checked against an external data source.
match indicates that the provided input data was a strong match against external data.
partial_match indicates the data approximately matched against external data. For example, "Knope" vs. "Knope-Wyatt" for last name.
no_match indicates that Plaid was able to perform a check against an external data source and it did not match the provided input data.
no_data indicates that Plaid was unable to find external data to compare against the provided input data.
no_input indicates that Plaid was unable to perform a check because no information was provided for this field by the end user.

Possible values: match, partial_match, no_match, no_data, no_input
email_addresses
string
An enum indicating the match type between data provided by user and data checked against an external data source.
match indicates that the provided input data was a strong match against external data.
partial_match indicates the data approximately matched against external data. For example, "Knope" vs. "Knope-Wyatt" for last name.
no_match indicates that Plaid was able to perform a check against an external data source and it did not match the provided input data.
no_data indicates that Plaid was unable to find external data to compare against the provided input data.
no_input indicates that Plaid was unable to perform a check because no information was provided for this field by the end user.

Possible values: match, partial_match, no_match, no_data, no_input
locations
string
An enum indicating the match type between data provided by user and data checked against an external data source.
match indicates that the provided input data was a strong match against external data.
partial_match indicates the data approximately matched against external data. For example, "Knope" vs. "Knope-Wyatt" for last name.
no_match indicates that Plaid was able to perform a check against an external data source and it did not match the provided input data.
no_data indicates that Plaid was unable to find external data to compare against the provided input data.
no_input indicates that Plaid was unable to perform a check because no information was provided for this field by the end user.

Possible values: match, partial_match, no_match, no_data, no_input
names
string
An enum indicating the match type between data provided by user and data checked against an external data source.
match indicates that the provided input data was a strong match against external data.
partial_match indicates the data approximately matched against external data. For example, "Knope" vs. "Knope-Wyatt" for last name.
no_match indicates that Plaid was able to perform a check against an external data source and it did not match the provided input data.
no_data indicates that Plaid was unable to find external data to compare against the provided input data.
no_input indicates that Plaid was unable to perform a check because no information was provided for this field by the end user.

Possible values: match, partial_match, no_match, no_data, no_input
phone_numbers
string
An enum indicating the match type between data provided by user and data checked against an external data source.
match indicates that the provided input data was a strong match against external data.
partial_match indicates the data approximately matched against external data. For example, "Knope" vs. "Knope-Wyatt" for last name.
no_match indicates that Plaid was able to perform a check against an external data source and it did not match the provided input data.
no_data indicates that Plaid was unable to find external data to compare against the provided input data.
no_input indicates that Plaid was unable to perform a check because no information was provided for this field by the end user.

Possible values: match, partial_match, no_match, no_data, no_input
urls
string
An enum indicating the match type between data provided by user and data checked against an external data source.
match indicates that the provided input data was a strong match against external data.
partial_match indicates the data approximately matched against external data. For example, "Knope" vs. "Knope-Wyatt" for last name.
no_match indicates that Plaid was able to perform a check against an external data source and it did not match the provided input data.
no_data indicates that Plaid was unable to find external data to compare against the provided input data.
no_input indicates that Plaid was unable to perform a check because no information was provided for this field by the end user.

Possible values: match, partial_match, no_match, no_data, no_input
search_terms_version
number
The version of the entity screening's search_terms that were compared when the entity screening hit was added. entity screening hits are immutable once they have been reviewed. If changes are detected due to updates to the entity screening's search_terms, the associated entity program, or the list's source data prior to review, the entity screening hit will be updated to reflect those changes.
data
object
Information associated with the entity watchlist hit
documents
[object]
Documents associated with the watchlist hit
analysis
object
Summary object reflecting the match result of the associated data
summary
string
An enum indicating the match type between data provided by user and data checked against an external data source.
match indicates that the provided input data was a strong match against external data.
partial_match indicates the data approximately matched against external data. For example, "Knope" vs. "Knope-Wyatt" for last name.
no_match indicates that Plaid was able to perform a check against an external data source and it did not match the provided input data.
no_data indicates that Plaid was unable to find external data to compare against the provided input data.
no_input indicates that Plaid was unable to perform a check because no information was provided for this field by the end user.

Possible values: match, partial_match, no_match, no_data, no_input
data
object
An official document, usually issued by a governing body or institution, with an associated identifier.
type
string
The kind of official document represented by this object.
bik - Russian bank code
business_number - A number that uniquely identifies the business within a category of businesses
imo - Number assigned to the entity by the International Maritime Organization
other - Any document not covered by other categories
swift - Number identifying a bank and branch.
tax_id - Identification issued for the purpose of collecting taxes

Possible values: bik, business_number, imo, other, swift, tax_id
number
string
The numeric or alphanumeric identifier associated with this document.

Min length: 4
Pattern: ^\S+(\s+\S+)*$
email_addresses
[object]
Email addresses associated with the watchlist hit
analysis
object
Summary object reflecting the match result of the associated data
summary
string
An enum indicating the match type between data provided by user and data checked against an external data source.
match indicates that the provided input data was a strong match against external data.
partial_match indicates the data approximately matched against external data. For example, "Knope" vs. "Knope-Wyatt" for last name.
no_match indicates that Plaid was able to perform a check against an external data source and it did not match the provided input data.
no_data indicates that Plaid was unable to find external data to compare against the provided input data.
no_input indicates that Plaid was unable to perform a check because no information was provided for this field by the end user.

Possible values: match, partial_match, no_match, no_data, no_input
data
object
Email address information for the associated entity watchlist hit
email_address
string
A valid email address.

Format: email
locations
[object]
Locations associated with the watchlist hit
analysis
object
Summary object reflecting the match result of the associated data
summary
string
An enum indicating the match type between data provided by user and data checked against an external data source.
match indicates that the provided input data was a strong match against external data.
partial_match indicates the data approximately matched against external data. For example, "Knope" vs. "Knope-Wyatt" for last name.
no_match indicates that Plaid was able to perform a check against an external data source and it did not match the provided input data.
no_data indicates that Plaid was unable to find external data to compare against the provided input data.
no_input indicates that Plaid was unable to perform a check because no information was provided for this field by the end user.

Possible values: match, partial_match, no_match, no_data, no_input
data
object
Location information for the associated individual watchlist hit
full
string
The full location string, potentially including elements like street, city, postal codes and country codes. Note that this is not necessarily a complete or well-formatted address.
country
string
Valid, capitalized, two-letter ISO code representing the country of this object. Must be in ISO 3166-1 alpha-2 form.

Min length: 2
Pattern: ^[A-Z]{2}$
names
[object]
Names associated with the watchlist hit
analysis
object
Summary object reflecting the match result of the associated data
summary
string
An enum indicating the match type between data provided by user and data checked against an external data source.
match indicates that the provided input data was a strong match against external data.
partial_match indicates the data approximately matched against external data. For example, "Knope" vs. "Knope-Wyatt" for last name.
no_match indicates that Plaid was able to perform a check against an external data source and it did not match the provided input data.
no_data indicates that Plaid was unable to find external data to compare against the provided input data.
no_input indicates that Plaid was unable to perform a check because no information was provided for this field by the end user.

Possible values: match, partial_match, no_match, no_data, no_input
data
object
Name information for the associated entity watchlist hit
full
string
The full name of the entity.
is_primary
boolean
Primary names are those most commonly used to refer to this entity. Only one name will ever be marked as primary.
weak_alias_determination
string
Names that are explicitly marked as low quality either by their source list, or by plaid by a series of additional checks done by Plaid. Plaid does not ever surface a hit as a result of a weak name alone. If a name has no quality issues, this value will be none.

Possible values: none, source, plaid
phone_numbers
[object]
Phone numbers associated with the watchlist hit
analysis
object
Summary object reflecting the match result of the associated data
summary
string
An enum indicating the match type between data provided by user and data checked against an external data source.
match indicates that the provided input data was a strong match against external data.
partial_match indicates the data approximately matched against external data. For example, "Knope" vs. "Knope-Wyatt" for last name.
no_match indicates that Plaid was able to perform a check against an external data source and it did not match the provided input data.
no_data indicates that Plaid was unable to find external data to compare against the provided input data.
no_input indicates that Plaid was unable to perform a check because no information was provided for this field by the end user.

Possible values: match, partial_match, no_match, no_data, no_input
data
object
Phone number information associated with the entity screening hit
type
string
An enum indicating whether a phone number is a phone line or a fax line.

Possible values: phone, fax
phone_number
string
A phone number in E.164 format.

Pattern: ^\+[1-9]\d{6,14}$
urls
[object]
URLs associated with the watchlist hit
analysis
object
Summary object reflecting the match result of the associated data
summary
string
An enum indicating the match type between data provided by user and data checked against an external data source.
match indicates that the provided input data was a strong match against external data.
partial_match indicates the data approximately matched against external data. For example, "Knope" vs. "Knope-Wyatt" for last name.
no_match indicates that Plaid was able to perform a check against an external data source and it did not match the provided input data.
no_data indicates that Plaid was unable to find external data to compare against the provided input data.
no_input indicates that Plaid was unable to perform a check because no information was provided for this field by the end user.

Possible values: match, partial_match, no_match, no_data, no_input
data
object
URLs associated with the entity screening hit
url
string
An 'http' or 'https' URL (must begin with either of those).

Format: uri
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": 1
20      },
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}

/watchlist_screening/entity/program/get

Get entity watchlist screening program

Get an entity watchlist screening program

watchlist_screening/entity/program/get

Request 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
watchlist_screening/entity/program/get

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.
source
string
A type indicating whether a dashboard user, an API-based user, or Plaid last touched this object.

Possible values: dashboard, link, api, system
dashboard_user_id
nullable string
ID of the associated user.
timestamp
string
An ISO8601 formatted timestamp.

Format: date-time
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",