Search identities
Search for identities by field-match filters. PII fields (name, DOB,
document number, SSN) are matched via HMAC hashes — the plaintext
values provided in the request are hashed and compared against stored
hashes, never stored themselves.
For name+DOB search, all three fields (`first_name`, `last_name`,
`date_of_birth`) must be provided together.
Non-PII filters (`external_ref`, `status`, `country`) use direct
matching.
Authentication
X-API-Keystring
Organization API key. Keys are prefixed with vk_live_ (production) or
vk_sandbox_ (sandbox).
Headers
Verifa-Version
API version date string (e.g. 2026-02-01). If omitted, the version
pinned to your API key is used.
Key-Inflection
Response key casing. Defaults to snake.
Allowed values:
Request
This endpoint expects an object.
external_ref
Exact match on external reference.
status
Filter by identity status.
first_name
First name (used with last_name + date_of_birth for hash match).
last_name
Last name (used with first_name + date_of_birth for hash match).
date_of_birth
Date of birth as YYYY-MM-DD (used with first_name + last_name).
document_number
Document number for hash match.
ssn
SSN for hash match.
country
ISO 3166-1 alpha-2 country code.
email
Email address for hash match.
phone
Phone number for hash match.
city
City for hash match.
state
State/province for hash match.
zip_code
Zip/postal code for hash match.
limit
offset
Response
Search results.
data
pagination
Errors
401
Unauthorized Error
422
Unprocessable Entity Error