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

Export identity data (GDPR Art. 15 DSAR)

GET
https://devapi.withverifa.com/api/v1/identities/:identity_id/export
GET
/api/v1/identities/:identity_id/export
$curl https://devapi.withverifa.com/api/v1/identities/identity_id/export \
> -H "X-API-Key: <apiKey>"
1{
2 "identity": {
3 "id": "idn_abc123",
4 "status": "string",
5 "session_count": 1,
6 "is_sandbox": true,
7 "created_at": "2024-01-15T09:30:00Z",
8 "external_ref": "string",
9 "latest_session_id": "string",
10 "latest_result_id": "string",
11 "latest_session_snapshot": {
12 "result_id": "string",
13 "session_id": "string",
14 "status": "string",
15 "face_match_passed": true,
16 "face_match_score": 1.1,
17 "age_check_passed": true,
18 "extracted_age": 1,
19 "rejection_reason": "string",
20 "rejection_reason_code": "document_unreadable",
21 "check_results": {},
22 "reviewed_by": "string",
23 "reviewed_at": "2024-01-15T09:30:00Z",
24 "created_at": "2024-01-15T09:30:00Z"
25 },
26 "country": "string",
27 "extracted_data": {
28 "first_name": "string",
29 "last_name": "string",
30 "date_of_birth": "string",
31 "address": {
32 "line1": "string",
33 "line2": "string",
34 "city": "string",
35 "state": "string",
36 "zip": "string"
37 },
38 "document_number": "string",
39 "nationality": "string",
40 "gender": "string",
41 "ssn": "string",
42 "document_type": "string",
43 "document_expiration_date": "string",
44 "document_issuing_state": "string"
45 },
46 "first_verified_at": "2024-01-15T09:30:00Z",
47 "last_verified_at": "2024-01-15T09:30:00Z",
48 "archived_at": "2024-01-15T09:30:00Z",
49 "identity_type_id": "string",
50 "custom_fields": {},
51 "tags": [
52 "string"
53 ],
54 "updated_at": "2024-01-15T09:30:00Z"
55 },
56 "sessions": [
57 {
58 "session": {
59 "id": "ses_abc123",
60 "status": "pending",
61 "is_sandbox": true,
62 "environment": "string",
63 "created_at": "2024-01-15T09:30:00Z",
64 "updated_at": "2024-01-15T09:30:00Z",
65 "external_ref": "string",
66 "metadata": {},
67 "country": "string",
68 "checks": [
69 "string"
70 ],
71 "workflow_id": "string",
72 "document_type": "string",
73 "retention_status": "string",
74 "processing_attempts": 1,
75 "consent_ip": "string",
76 "capture_url": "string",
77 "token_expires_at": "2024-01-15T09:30:00Z",
78 "case_id": "string",
79 "case_status": "string",
80 "tags": [
81 "string"
82 ]
83 },
84 "result": {
85 "session_id": "ses_abc123",
86 "status": "needs_review",
87 "is_sandbox": true,
88 "created_at": "2024-01-15T09:30:00Z",
89 "face_match_passed": true,
90 "face_match_score": 1.1,
91 "age_check_passed": true,
92 "extracted_age": 1,
93 "extracted_data": {
94 "first_name": "string",
95 "last_name": "string",
96 "date_of_birth": "string",
97 "address": {
98 "line1": "string",
99 "line2": "string",
100 "city": "string",
101 "state": "string",
102 "zip": "string"
103 },
104 "document_number": "string",
105 "nationality": "string",
106 "gender": "string",
107 "ssn": "string",
108 "document_type": "string",
109 "document_expiration_date": "string",
110 "document_issuing_state": "string"
111 },
112 "rejection_reason": "string",
113 "rejection_reason_code": "document_unreadable",
114 "processing_mode": "auto",
115 "country_used": "string",
116 "sensitive_data_expired": true
117 },
118 "documents": [
119 {
120 "id": "doc_abc123",
121 "document_type": "passport",
122 "download_url": "string",
123 "download_url_expires_at": "2024-01-15T09:30:00Z",
124 "page": "front",
125 "mime_type": "string",
126 "size_bytes": 1,
127 "captured_at": "2024-01-15T09:30:00Z"
128 }
129 ],
130 "screening": [
131 {
132 "id": "schk_abc123",
133 "check_type": "sanction",
134 "status": "pending",
135 "has_match": true,
136 "hit_count": 1,
137 "provider": "string",
138 "session_id": "string",
139 "identity_id": "string",
140 "external_ref": "string",
141 "monitoring_enabled": true,
142 "is_sandbox": true,
143 "tags": [
144 "string"
145 ],
146 "batch_id": "string",
147 "pep_risk_tier": "tier_1",
148 "pep_recommended_action": "string",
149 "redacted_at": "2024-01-15T09:30:00Z",
150 "last_checked_at": "2024-01-15T09:30:00Z",
151 "created_at": "2024-01-15T09:30:00Z",
152 "expires_at": "2024-01-15T09:30:00Z",
153 "result": {},
154 "hits": [
155 {
156 "id": "string",
157 "created_at": "2024-01-15T09:30:00Z",
158 "matched_name": "string",
159 "name_similarity": 1.1,
160 "dob_match": true,
161 "combined_score": 1.1,
162 "hit_source": "string",
163 "hit_type": "string",
164 "provider_ref": "string",
165 "deceased": true,
166 "is_false_positive": true,
167 "pep_details": {
168 "sources": [
169 "string"
170 ],
171 "positions": [
172 {
173 "title": "string",
174 "country": "string",
175 "from": "string",
176 "to": "string"
177 }
178 ],
179 "associates": [
180 {
181 "name": "string",
182 "relationship": "string"
183 }
184 ],
185 "pep_class": "string"
186 },
187 "sanction_details": {
188 "sources": [
189 "string"
190 ],
191 "list_name": "string",
192 "program": "string",
193 "listed_on": "string"
194 },
195 "adverse_media_details": {
196 "sources": [
197 {
198 "name": "string",
199 "url": "string",
200 "date": "string"
201 }
202 ]
203 }
204 }
205 ]
206 }
207 ],
208 "review_case": {
209 "id": "rvc_abc123",
210 "session_id": "string",
211 "status": "open",
212 "created_at": "2024-01-15T09:30:00Z",
213 "decision": "approved",
214 "assigned_to": "string",
215 "claimed_at": "2024-01-15T09:30:00Z",
216 "entered_review_at": "2024-01-15T09:30:00Z",
217 "decided_at": "2024-01-15T09:30:00Z"
218 },
219 "case_notes": [
220 {}
221 ],
222 "fraud_signals": [
223 {}
224 ],
225 "webhook_deliveries": [
226 {
227 "id": "whd_abc123",
228 "event": "session.approved",
229 "url": "string",
230 "status": "pending",
231 "attempts": 1,
232 "max_attempts": 1,
233 "created_at": "2024-01-15T09:30:00Z",
234 "http_status": 1,
235 "last_error": "string"
236 }
237 ]
238 }
239 ],
240 "identity_links": [
241 {}
242 ],
243 "identity_relationships": [
244 {}
245 ],
246 "face_embeddings_count": 3
247}
Returns a JSON bundle containing every record Verifa holds for this identity, decrypted and ready to deliver as part of a GDPR Article 15 Subject Access Request (DSAR). For each session linked to the identity, this endpoint runs the same aggregation as `GET /api/v1/sessions/{session_id}/export` and embeds the result under `sessions[]`. It also adds identity-level fields, `identity_links`, `identity_relationships`, and a `face_embeddings_count` (count only — raw embedding bytes are never returned, even in a DSAR). **Audit:** Every successful call writes an `api.identity.export` audit-log entry recording the actor, identity ID, and IP. **Required scope:** `identities:read`
Was this page helpful?
Previous

Search identities

Next
Built with

Returns a JSON bundle containing every record Verifa holds for this identity, decrypted and ready to deliver as part of a GDPR Article 15 Subject Access Request (DSAR).

For each session linked to the identity, this endpoint runs the same aggregation as GET /api/v1/sessions/{session_id}/export and embeds the result under sessions[]. It also adds identity-level fields, identity_links, identity_relationships, and a face_embeddings_count (count only — raw embedding bytes are never returned, even in a DSAR).

Audit: Every successful call writes an api.identity.export audit-log entry recording the actor, identity ID, and IP.

Required scope: identities:read

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:

Response

Decrypted DSAR bundle for the identity.
identityobject
sessionslist of objects

Per-session export bundles for every session linked to the identity.

identity_linkslist of maps from strings to any

Same-person links between identity records.

identity_relationshipslist of maps from strings to any

Typed relationships to other identities (e.g. spouse, employer).

face_embeddings_countinteger
Number of face embeddings stored against this identity. Raw embedding bytes are intentionally excluded from DSAR output.

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error