API ReferenceSessions

Get session result

Returns the verification result for a completed session, including biometric scores and extracted document data.

If the organization’s sensitive data window has elapsed, PII fields will be empty and sensitive_data_expired will be true.

Authentication

X-API-Keystring

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

Path parameters

session_idstringRequired

Session ID (ses_*).

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:

Response

Verification result.
session_idstring
statusenum
is_sandboxboolean
created_atdatetime
face_match_passedboolean or nullOptional
face_match_scoredouble or nullOptional
Similarity score between 0 and 1.
age_check_passedboolean or nullOptional
extracted_ageinteger or nullOptional
extracted_dataobjectOptional

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

rejection_reasonstring or nullOptional
rejection_reason_codeenumOptional

Structured reason a verification was rejected. Complements the free-text rejection_reason. Stable enum — clients can pivot UI and metrics off this without parsing prose.

processing_modeenumOptional
country_usedstring or nullOptional

ISO 3166-1 alpha-2 country code used for verification.

sensitive_data_expiredbooleanOptional

true if the organization’s sensitive data window has elapsed. When true, extracted_data will be empty.

Errors

401
Unauthorized Error
404
Not Found Error