{
  "opencollection": "1.0.0",
  "info": {
    "name": "Onfido Watchlist API",
    "version": "v3.6"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "Authorization",
      "value": "{{Authorization}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Watchlist",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List monitors",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.{region}.onfido.com/v3.6/watchlist_monitors",
            "params": [
              {
                "name": "applicant_id",
                "value": "",
                "type": "query",
                "description": "The id of the applicant the watchlist monitors belong to. If omitted, all monitors for the account will be listed."
              },
              {
                "name": "include_deleted",
                "value": "",
                "type": "query",
                "description": "Whether to also include deleted (inactive) monitors."
              }
            ]
          },
          "docs": "List all available monitors for an applicant\n"
        },
        {
          "info": {
            "name": "Create monitor",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.{region}.onfido.com/v3.6/watchlist_monitors",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new monitor for the applicant\n"
        },
        {
          "info": {
            "name": "Retrieve monitor",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.{region}.onfido.com/v3.6/watchlist_monitors/:monitor_id",
            "params": [
              {
                "name": "monitor_id",
                "value": "",
                "type": "path",
                "description": "The watchlist monitor's unique identifier."
              }
            ]
          },
          "docs": "Retrieves a single monitor\n"
        },
        {
          "info": {
            "name": "Delete monitor",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.{region}.onfido.com/v3.6/watchlist_monitors/:monitor_id",
            "params": [
              {
                "name": "monitor_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Deactivates the given monitor\n"
        },
        {
          "info": {
            "name": "List matches (BETA)",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.{region}.onfido.com/v3.6/watchlist_monitors/:monitor_id/matches",
            "params": [
              {
                "name": "monitor_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "List match IDs on this monitor, as well as their enabled/disabled status\n"
        },
        {
          "info": {
            "name": "Set match status (BETA)",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.{region}.onfido.com/v3.6/watchlist_monitors/:monitor_id/matches",
            "params": [
              {
                "name": "monitor_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update the status of the given matches\n"
        },
        {
          "info": {
            "name": "Force new report creation (BETA)",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.{region}.onfido.com/v3.6/watchlist_monitors/:monitor_id/new_report",
            "params": [
              {
                "name": "monitor_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Triggers a new check with an updated report to be generated by the monitor, as if the monitor had received an update.\n"
        }
      ]
    }
  ],
  "bundled": true
}