plaid

List reviews for individual watchlist screenings

Changed on

List all reviews for the individual watchlist screening.

post/watchlist_screening/individual/review/list

Request

  • Base URL
    https://production.plaid.com
  • URL
    https://production.plaid.com/watchlist_screening/individual/review/list
  • Auth
    API key in header PLAID-CLIENT-ID and API key in header PLAID-SECRET and API key in header Plaid-Version

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

OK

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_reviews": [
    {
      "id": "rev_aCLNRxK3UVzn2r",
      "confirmed_hits": [
        "scrhit_52xR9LKo77r1Np"
      ],
      "dismissed_hits": [
        "scrhit_52xR9LKo77r1Np"
      ],
      "comment": "These look like legitimate matches, rejecting the customer.",
      "audit_trail": {
        "dashboard_user_id": "54350110fedcbaf01234ffee",
        "timestamp": "2020-07-24T03:26:02Z"
      }
    }
  ],
  "next_cursor": "eyJkaXJlY3Rpb24iOiJuZXh0Iiwib2Zmc2V0IjoiMTU5NDM"
}

Changes

  • a1bbca018160Revision changes
    • warning

      added the new retro enum value to the /// response property for the response status

  • be701ec93161Revision changes
    • breaking

      the // response property's minLength was decreased from 1 to 0 for the response status