For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
  • Getting Started
    • Introduction
    • How Verifa Works
    • Quickstart
    • Choosing an Integration Method
  • Use Cases
    • KYC Onboarding
    • Age Verification
    • AML Compliance
    • Fraud Prevention
    • Marketplace Trust & Safety
  • Core Concepts
    • Overview
    • Sessions
    • Verifications & Checks
    • Workflows
    • Identities
    • Cases
    • Screening & Reports
    • Lists
  • Integration Guides
    • Overview
    • JavaScript SDK
    • Web Capture Flow
    • API-Only Integration
    • Mobile SDK
    • Webhooks Guide
    • MCP Server
    • Migrating from Persona
  • API Details
    • Overview
    • Authentication
    • Pagination
    • Rate Limiting
    • Versioning
    • Errors
    • Webhooks
    • Idempotency
    • Key Inflection
    • Data Access
    • Data Retention
  • Tutorials
    • Creating Your First Verification Session
    • Creating a Workflow
    • Receiving Webhooks & Validating Signatures
    • Handling Webhook Events
    • Custom Document Types & AI Extraction
  • Best Practices
    • Testing
    • Preventing Duplicates
    • Fraud Signals
    • Changelog
  • API Reference
      • GETList checks
      • POSTCreate a check
      • POSTCreate multiple checks at once
      • GETGet check detail with hits
      • POSTDismiss AML hits
      • POSTRe-run check
      • POSTGDPR redact check PII
      • GETMonitoring history
      • POSTAdd tags
      • PUTSet tags (replace all)
      • DELRemove a tag
      • GETGenerate PDF report for a check
      • GETList checks for session
      • GETList checks for identity
      • GETList watchlists
      • GETGet a watchlist
      • GETList watchlist items
API ReferenceChecks

Get a watchlist

GET
https://devapi.withverifa.com/api/v1/screening/lists/:list_id
GET
/api/v1/screening/lists/:list_id
$curl https://devapi.withverifa.com/api/v1/screening/lists/list_id \
>     -H "X-API-Key: <apiKey>"
1{
2  "id": "wl_abc123",
3  "name": "Internal Blocklist",
4  "list_type": "ofac_sdn",
5  "entry_count": 1,
6  "is_active": true,
7  "is_system": true,
8  "created_at": "2024-01-15T09:30:00Z",
9  "description": "string",
10  "updated_at": "2024-01-15T09:30:00Z"
11}

Retrieves a watchlist by ID. Works for both system-managed and custom lists.

Was this page helpful?
Previous

List watchlist items

Next
Built with

Authentication

X-API-Keystring

Organization API key. Keys are prefixed with vk_live_ (production) or vk_sandbox_ (sandbox).

Path parameters

list_idstringRequired

Watchlist ID (wl_*).

Headers

Verifa-VersiondateOptional

API version date string (e.g. 2026-02-01). If omitted, the version pinned to your API key is used.

Response

Watchlist details.
idstring
namestring
list_typeenum
Allowed values:
entry_countinteger
is_activeboolean
is_systemboolean

true for system-managed lists (OFAC/SDN), false for custom.

created_atdatetime
descriptionstring or null
updated_atdatetime

Errors

401
Unauthorized Error
404
Not Found Error