Sign in

v8

OpenAPI 3.1.02026-08-033623795.0 MB
Verifications

Update Verification

Updates editable profile details or submits answers for items returned in requested_information. Once a verification is approved its profile details are locked and can no longer be edited.

patch/verifications/{verification_id}

Path parameters

verification_idstring required

Verification profile ID, prefixed idpf_.

Request body

OR

Response

verification updated

business_namestring nullable

Legal business name.

business_structurestring nullable

Legal entity structure of the business, such as private_corporation or sole_proprietorship. Supported values vary by country of incorporation — see Business structures.

countrystring nullable

Two-letter ISO 3166-1 country code, for example US, DE, or GB.

created_atstring

When the verification profile was created, as an ISO 8601 timestamp.

date_of_birthstring nullable

Formatted as YYYY-MM-DD.

first_namestring nullable
idstring

Verification profile ID, prefixed idpf_.

kind'individual' | 'business'
last_namestring nullable
session_urlstring nullable

Hosted verification session URL for the user to complete identity checks. Expires 7 days after creation.

status'not_started' | 'pending' | 'processing' | 'manual_review' | 'approved' | 'rejected' | 'action_required'

Current verification state. not_started before any session exists; pending while a session needs the user's input; processing while the provider reviews documents; action_required when requested_information needs answers; manual_review during a manual compliance review — nothing to submit, usually done within 3 business days; approved on success; rejected on failure. Call Create Verification again to start a new session.

updated_atstring

When the verification profile was last updated, as an ISO 8601 timestamp.