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

Check a subject against custom lists

POST
https://devapi.withverifa.com/api/v1/lists/check
POST
/api/v1/lists/check
$curl -X POST https://devapi.withverifa.com/api/v1/lists/check \
>     -H "X-API-Key: <apiKey>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "subject_data": {}
>}'
1{
2  "data": [
3    {
4      "list_id": "string",
5      "list_type": "string",
6      "match_type": "string",
7      "match_score": 1.1,
8      "list_item_id": "string"
9    }
10  ],
11  "total_matches": 1
12}
Performs a standalone check of subject data against custom lists without persisting a match record.
Was this page helpful?
Previous

Mark a list match as false positive

Next
Built with

Authentication

X-API-Keystring

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

Headers

Verifa-VersiondateOptional

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

Request

This endpoint expects an object.
subject_datamap from strings to anyRequired
Subject data to check.
list_idslist of strings or nullOptional
Specific list IDs to check against. Omit to check all active lists.

Response

Check results.
datalist of objects
total_matchesinteger

Errors

401
Unauthorized Error
403
Forbidden Error