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 API keys
      • POSTCreate API key
      • GETRetrieve API key
      • PATCHUpdate API key
      • POSTExpire API key
      • POSTClone API key
      • GETGet rate limit status
API ReferenceAPI Keys

Update API key

PATCH
https://devapi.withverifa.com/api/v1/api-keys/:api_key_id
PATCH
/api/v1/api-keys/:api_key_id
$curl -X PATCH https://devapi.withverifa.com/api/v1/api-keys/api_key_id \
>     -H "X-API-Key: <apiKey>" \
>     -H "Content-Type: application/json" \
>     -d '{}'
1{
2  "id": "key_abc123",
3  "type": "api-key",
4  "environment": "live",
5  "key_prefix": "vk_live_abc1",
6  "is_active": true,
7  "created_at": "2024-01-15T09:30:00Z",
8  "label": "string",
9  "note": "string",
10  "scopes": [
11    "string"
12  ],
13  "api_version": "string",
14  "default_key_inflection": "camel",
15  "allowed_ips": [
16    "string"
17  ],
18  "expires_at": "2024-01-15T09:30:00Z",
19  "last_used_at": "2024-01-15T09:30:00Z"
20}
Updates an API key's label, note, scopes, allowed IPs, or expiry. Only provided fields are changed.
Was this page helpful?
Previous

Expire API key

Next
Built with

Authentication

X-API-Keystring

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

Path parameters

api_key_idstringRequired

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.
labelstring or nullOptional
notestring or nullOptional
scopeslist of strings or nullOptional
allowed_ipslist of strings or nullOptional
expires_atstring or nullOptional
ISO 8601 expiration timestamp. Set to null to remove expiry.

Response

Updated API key.
idstring
typeenum
Allowed values:
environmentenum
Allowed values:
key_prefixstring
First characters of the key for identification.
is_activeboolean
created_atdatetime
labelstring or null
notestring or null
scopeslist of strings or null
Permission scopes granted to this key.
api_versionstring or null
default_key_inflectionenum
Allowed values:
allowed_ipslist of strings or null
IP allowlist. Null means all IPs are allowed.
expires_atdatetime or null
last_used_atdatetime or null

Errors

401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error