plaid

List hits for individual watchlist screening

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

post/watchlist_screening/individual/hit/list

Request body

secretstring

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_idstring

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_idstring required

ID of the associated screening.

cursorstring nullable

An identifier that determines which page of results you receive.

Example request

{
  "watchlist_screening_id": "scr_52xR9LKo77r1Np",
  "cursor": "eyJkaXJlY3Rpb24iOiJuZXh0Iiwib2Zmc2V0IjoiMTU5NDM"
}

Response

next_cursorstring nullable required

An identifier that determines which page of results you receive.

request_idstring required

A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

Example response

{
  "watchlist_screening_hits": [
    {
      "id": "scrhit_52xR9LKo77r1Np",
      "review_status": "pending_review",
      "first_active": "2020-07-24T03:26:02Z",
      "inactive_since": "2020-07-24T03:26:02Z",
      "historical_since": "2020-07-24T03:26:02Z",
      "list_code": "US_SDN",
      "plaid_uid": "uid_3NggckTimGSJHS",
      "source_uid": "26192ABC",
      "sub_programs": [
        "SDGT",
        "SDNTK"
      ],
      "analysis": {
        "dates_of_birth": "match",
        "documents": "match",
        "locations": "match",
        "names": "match",
        "search_terms_version": 1
      },
      "data": {
        "dates_of_birth": [
          {
            "analysis": {
              "summary": "match"
            },
            "data": {
              "ending": "1966-06-30",
              "beginning": "1966-06-01"
            }
          }
        ],
        "documents": [
          {
            "analysis": {
              "summary": "match"
            },
            "data": {
              "type": "passport",
              "number": "C31195855"
            }
          }
        ],
        "locations": [
          {
            "analysis": {
              "summary": "match"
            },
            "data": {
              "full": "Florida, US",
              "country": "US"
            }
          }
        ],
        "names": [
          {
            "analysis": {
              "summary": "match"
            },
            "data": {
              "full": "Aleksey Potemkin",
              "weak_alias_determination": "none"
            }
          }
        ]
      }
    }
  ],
  "next_cursor": "eyJkaXJlY3Rpb24iOiJuZXh0Iiwib2Zmc2V0IjoiMTU5NDM"
}

Changes

Changed in 4 of the 52 revisions of this API.412

Jun 10, 2026fb8c3f188d8b1See the full diff
- ○
  added the required property watchlist_screening_hits/items/sub_programs to the response with the 200 status
  response-required-property-added
This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Mar 26, 202509cbc84449131See the full diff
- ●
  added the new US_SAM enum value to the watchlist_screening_hits/items/list_code response property for the response status 200
  response-property-enum-value-added
This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jun 18, 2024be701ec931613See the full diff
- ▲
  the watchlist_screening_hits/items/data/documents/items/data/number response property's minLength was decreased from 4 to 0 for the response status 200
  response-property-min-length-decreased
- ▲
  the watchlist_screening_hits/items/data/locations/items/data/country response property's minLength was decreased from 2 to 0 for the response status 200
  response-property-min-length-decreased
- ▲
  the watchlist_screening_hits/items/source_uid response property's minLength was decreased from 1 to 0 for the response status 200
  response-property-min-length-decreased
Feb 21, 20245de70cc1e6ca11See the full diff
- ▲
  removed the required property watchlist_screening_hits/items/sub_programs from the response with the 200 status
  response-required-property-removed
- ○
  removed the US_SAM enum value from the watchlist_screening_hits/items/list_code response property for the response status 200
  response-property-enum-value-removed
This revision also has 699 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history