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
      • GETGet custom list matches for a session
      • GETList custom lists
      • POSTCreate a custom list
      • GETGet a custom list
      • PATCHUpdate a custom list
      • POSTArchive a custom list
      • GETList items in a custom list
      • POSTAdd an item to a custom list
      • GETGet a list item
      • DELDelete a list item
      • POSTBulk add items to a list
      • POSTImport items from CSV
      • GETExport items as CSV
      • POSTCheck a subject against custom lists
      • POSTMark a list match as false positive
API ReferenceLists

Get a custom list

GET
https://devapi.withverifa.com/api/v1/lists/:list_id
GET
/api/v1/lists/:list_id
$curl https://devapi.withverifa.com/api/v1/lists/list_id \
>     -H "X-API-Key: <apiKey>"
1{
2  "created_at": "2024-01-15T09:30:00Z",
3  "id": "lst_abc123",
4  "is_active": true,
5  "item_count": 1,
6  "list_type": "string",
7  "match_mode": "string",
8  "name": "string",
9  "description": "string",
10  "org_id": "string",
11  "updated_at": "2024-01-15T09:30:00Z",
12  "used_by_workflows": [
13    {
14      "id": "string",
15      "name": "string"
16    }
17  ]
18}
Was this page helpful?
Previous

Update a custom list

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

Headers

Verifa-VersiondateOptional

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

Key-InflectionenumOptionalDefaults to snake

Response key casing. Defaults to snake.

Allowed values:

Response

List details.
created_atdatetime
idstring
is_activeboolean
item_countinteger
list_typestring
match_modestring
namestring
descriptionstring or null
org_idstring
updated_atdatetime
used_by_workflowslist of objects

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error