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 identities
      • POSTCreate an identity
      • GETGet an identity
      • PATCHUpdate an identity
      • DELRedact an identity
      • GETExport identity data (GDPR Art. 15 DSAR)
      • POSTSearch identities
      • GETList identity sessions
      • GETGet identity audit log
      • POSTAdd a tag
      • POSTRemove a tag
      • POSTSet tags
      • POSTPreview identity merge
      • POSTMerge identities
      • POSTArchive an identity
      • POSTRestore an archived identity
      • POSTPause continuous monitoring for an identity
      • POSTResume continuous monitoring for an identity
      • POSTAdvanced identity search
      • GETGet custom field values
      • PATCHSet custom field values
      • GETList identity relationships
      • POSTCreate an identity relationship
      • DELDelete an identity relationship
      • GETQuery identity relationship graph
      • GETFind cross-session image similarity matches
      • GETGet monitored lists for an identity
      • POSTAdd lists to identity monitoring
      • PUTReplace monitored lists for an identity
API ReferenceIdentities

Update an identity

PATCH
https://devapi.withverifa.com/api/v1/identities/:identity_id
PATCH
/api/v1/identities/:identity_id
$curl -X PATCH https://devapi.withverifa.com/api/v1/identities/identity_id \
>     -H "X-API-Key: <apiKey>" \
>     -H "Content-Type: application/json" \
>     -d '{}'
1{
2  "id": "idn_abc123",
3  "status": "string",
4  "session_count": 1,
5  "is_sandbox": true,
6  "created_at": "2024-01-15T09:30:00Z",
7  "external_ref": "string",
8  "latest_session_id": "string",
9  "latest_result_id": "string",
10  "latest_session_snapshot": {
11    "result_id": "string",
12    "session_id": "string",
13    "status": "string",
14    "face_match_passed": true,
15    "face_match_score": 1.1,
16    "age_check_passed": true,
17    "extracted_age": 1,
18    "rejection_reason": "string",
19    "rejection_reason_code": "document_unreadable",
20    "check_results": {},
21    "reviewed_by": "string",
22    "reviewed_at": "2024-01-15T09:30:00Z",
23    "created_at": "2024-01-15T09:30:00Z"
24  },
25  "country": "string",
26  "extracted_data": {
27    "first_name": "string",
28    "last_name": "string",
29    "date_of_birth": "string",
30    "address": {
31      "line1": "string",
32      "line2": "string",
33      "city": "string",
34      "state": "string",
35      "zip": "string"
36    },
37    "document_number": "string",
38    "nationality": "string",
39    "gender": "string",
40    "ssn": "string",
41    "document_type": "string",
42    "document_expiration_date": "string",
43    "document_issuing_state": "string"
44  },
45  "first_verified_at": "2024-01-15T09:30:00Z",
46  "last_verified_at": "2024-01-15T09:30:00Z",
47  "archived_at": "2024-01-15T09:30:00Z",
48  "identity_type_id": "string",
49  "custom_fields": {},
50  "tags": [
51    "string"
52  ],
53  "updated_at": "2024-01-15T09:30:00Z"
54}

Updates fields on an existing identity. PII fields are re-encrypted and HMAC hashes are recomputed. Redacted identities cannot be updated.

Was this page helpful?
Previous

Redact an identity

Next
Built with

Authentication

X-API-Keystring

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

Path parameters

identity_idstringRequired

Identity ID (idn_*) or external reference.

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:
Idempotency-KeystringOptional<=255 characters

Unique key for idempotent requests. Cached for 24 hours. Sending the same key with different parameters returns 422.

Request

This endpoint expects an object.
external_refstringOptional<=255 characters
New external reference for this identity.
first_namestringOptional<=200 characters

First name (PII, encrypted at rest).

last_namestringOptional<=200 characters

Last name (PII, encrypted at rest).

date_of_birthdateOptional

Date of birth as YYYY-MM-DD (PII, encrypted at rest).

address_line1stringOptional<=255 characters
Address line 1.
address_line2stringOptional<=255 characters
Address line 2.
citystringOptional<=120 characters
City.
statestringOptional<=120 characters
State or province.
zip_codestringOptional<=20 characters
Postal or ZIP code.
document_numberstringOptional<=64 characters

Document number (PII, encrypted at rest).

ssnstringOptional<=11 characters

Social Security Number (PII, encrypted at rest).

nationalitystringOptional=2 characters

ISO 3166-1 alpha-2 nationality code.

genderstringOptional<=32 characters
Gender.
countrystringOptional=2 characters

ISO 3166-1 alpha-2 country code.

emailstringOptionalformat: "email"<=320 characters

Email address (PII, encrypted at rest).

phonestringOptional<=32 characters

Phone number in E.164 format (PII, encrypted at rest).

statusstringOptional<=32 characters
New status for the identity.

Response

Updated identity.
idstring
statusstring
session_countinteger
is_sandboxboolean
created_atdatetime
external_refstring or null
latest_session_idstring or null
latest_result_idstring or null
latest_session_snapshotobject or null

Most-recent session result. null when the identity has no results yet (e.g. screening-only identities) or when the result row could not be loaded.

countrystring or null
extracted_dataobject

PII extracted from the identity document. Fields returned depend on your organization’s api_pii_fields configuration.

first_verified_atdatetime or null
last_verified_atdatetime or null
archived_atdatetime or null
identity_type_idstring or null
custom_fieldsmap from strings to any
tagslist of strings
updated_atdatetime

Errors

401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error