Get an identity | Verifa

curl https://devapi.withverifa.com/api/v1/identities/identity_id \
     -H "X-API-Key: <apiKey>"

{
  "id": "idn_abc123",
  "status": "string",
  "session_count": 1,
  "is_sandbox": true,
  "created_at": "2024-01-15T09:30:00Z",
  "external_ref": "string",
  "latest_session_id": "string",
  "latest_result_id": "string",
  "face_match_passed": true,
  "age_check_passed": true,
  "extracted_age": 1,
  "rejection_reason": "string",
  "country": "string",
  "extracted_data": {
    "first_name": "string",
    "last_name": "string",
    "date_of_birth": "string",
    "address": {
      "line1": "string",
      "line2": "string",
      "city": "string",
      "state": "string",
      "zip": "string"
    },
    "document_number": "string",
    "nationality": "string",
    "gender": "string",
    "ssn": "string",
    "document_type": "string",
    "document_expiration_date": "string",
    "document_issuing_state": "string"
  },
  "first_verified_at": "2024-01-15T09:30:00Z",
  "last_verified_at": "2024-01-15T09:30:00Z",
  "archived_at": "2024-01-15T09:30:00Z",
  "identity_type_id": "string",
  "custom_fields": {},
  "tags": [
    "string"
  ],
  "updated_at": "2024-01-15T09:30:00Z"
}

Retrieves a verified identity by its ID or external reference. Includes the latest verification result and extracted document data.

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.

Response

Identity details.

idstring

statusstring

session_countinteger

is_sandboxboolean

created_atdatetime

external_refstring or null

latest_session_idstring or null

latest_result_idstring or null

face_match_passedboolean or null

age_check_passedboolean or null

extracted_ageinteger or null

rejection_reasonstring or null

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

Authentication

Path parameters

Headers

Response

Errors