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 document types
      • POSTCreate a document type
      • DELDelete a document type
      • PATCHUpdate a document type
      • GETList document groups
      • POSTCreate a document group
      • DELDelete a document group
      • PATCHUpdate a document group
API ReferenceDocument Types

Update a document group

PATCH
https://devapi.withverifa.com/api/v1/settings/document-groups/:group_id
PATCH
/api/v1/settings/document-groups/:group_id
$curl -X PATCH https://devapi.withverifa.com/api/v1/settings/document-groups/group_id \
>     -H "X-API-Key: <apiKey>" \
>     -H "Content-Type: application/json" \
>     -d '{}'
1{
2  "id": "string",
3  "org_id": "string",
4  "name": "string",
5  "is_default": true,
6  "is_active": true,
7  "priority": 1,
8  "created_at": "2024-01-15T09:30:00Z",
9  "updated_at": "2024-01-15T09:30:00Z",
10  "description": "string",
11  "classifications": [
12    "string"
13  ],
14  "check_config": [
15    [
16      "string"
17    ]
18  ],
19  "recency_config": {
20    "enabled": true,
21    "max_age_days": 90
22  }
23}

Updates mutable fields on a document group.

Required scope: settings:write (or legacy documents:write).

Was this page helpful?
Previous

List verification results

Next
Built with

Authentication

X-API-Keystring

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

Path parameters

group_idstringRequired
Document group ID.

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.
namestringOptional

Human-readable group name.

descriptionstring or nullOptional
Description of this group.
classificationslist of stringsOptional
Document classifications included in this group.
extraction_configmap from strings to any or nullOptional
Extraction configuration for this group.
check_configmap from strings to any or nullOptional
Check suite configuration for this group.
recency_configmap from strings to any or nullOptional

Recency/expiry rules for this group.

is_defaultbooleanOptional
Whether this is the default group for unmatched documents.
is_activebooleanOptional
Whether this group is active.
priorityintegerOptional

Evaluation priority order (lower is higher priority).

Response

Document group updated.
idstring
Document group ID.
org_idstring
Organization ID.
namestring

Human-readable group name.

is_defaultboolean
Whether this is the default group for unmatched documents.
is_activeboolean
Whether this group is active.
priorityinteger

Evaluation priority order (lower is higher priority).

created_atdatetime
updated_atdatetime
descriptionstring or null
Description of this group.
classificationslist of strings

Document classification slugs that match this group. When a document is uploaded and classified as one of these slugs, the group’s check_config and recency_config apply.

check_configlist of lists of strings or null

Override the verification check suite for documents matched to this group. Each entry is a [check_name, category, requirement] tuple. Highest priority — beats document-type and org-level overrides.

recency_configobject or null

Recency rule applied to documents in this group. When enabled is true, the recency_check reads the issue date from the document’s extracted_fields (issue_date, statement_date, effective_date, or document_date) and fails the check if the document is older than max_age_days.

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error