v51

latestOpenAPI 3.0.0raw.githubusercontent.com2026-07-313352,3122.9 MB

plaid

List hits for entity watchlist screenings

List all hits for the entity watchlist screening.

post/watchlist_screening/entity/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.

entity_watchlist_screening_idstring required

ID of the associated entity screening.

cursorstring nullable

An identifier that determines which page of results you receive.

Example request

{
  "entity_watchlist_screening_id": "entscr_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

{
  "entity_watchlist_screening_hits": [
    {
      "id": "enthit_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": "EU_CON",
      "plaid_uid": "uid_3NggckTimGSJHS",
      "source_uid": "26192ABC",
      "sub_programs": [
        "SDGT",
        "SDNTK"
      ],
      "analysis": {
        "documents": "match",
        "email_addresses": "match",
        "locations": "match",
        "names": "match",
        "phone_numbers": "match",
        "urls": "match",
        "search_terms_version": 1
      },
      "data": {
        "documents": [
          {
            "analysis": {
              "summary": "match"
            },
            "data": {
              "type": "swift",
              "number": "C31195855"
            }
          }
        ],
        "email_addresses": [
          {
            "analysis": {
              "summary": "match"
            },
            "data": {
              "email_address": "user@example.com"
            }
          }
        ],
        "locations": [
          {
            "analysis": {
              "summary": "match"
            },
            "data": {
              "full": "Florida, US",
              "country": "US"
            }
          }
        ],
        "names": [
          {
            "analysis": {
              "summary": "match"
            },
            "data": {
              "full": "Al Qaida",
              "weak_alias_determination": "none"
            }
          }
        ],
        "phone_numbers": [
          {
            "analysis": {
              "summary": "match"
            },
            "data": {
              "phone_number": "+14025671234"
            }
          }
        ],
        "urls": [
          {
            "analysis": {
              "summary": "match"
            },
            "data": {
              "url": "https://example.com"
            }
          }
        ]
      }
    }
  ],
  "next_cursor": "eyJkaXJlY3Rpb24iOiJuZXh0Iiwib2Zmc2V0IjoiMTU5NDM"
}