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
      • GETGet SDK configuration for a capture session
      • GETGet a device attestation challenge
      • POSTSubmit a device attestation
      • POSTSubmit NFC chip data
      • GETGet CSCA certificate bundle
API ReferenceSDK

Get SDK configuration for a capture session

GET
https://devapi.withverifa.com/api/v1/sdk/config
GET
/api/v1/sdk/config
$curl -G https://devapi.withverifa.com/api/v1/sdk/config \
>     -H "X-API-Key: <apiKey>" \
>     -H "Content-Type: application/json" \
>     -d token=token
1{
2  "session_id": "sess_9f8b7c6d5e4a3b2c1d0e",
3  "status": "in_progress",
4  "steps": [
5    "welcome",
6    "document_capture",
7    "selfie_capture",
8    "proof_of_address",
9    "otp_verification",
10    "liveness_check",
11    "nfc_scan",
12    "final_review"
13  ],
14  "document": {
15    "accepted_types": [
16      "passport",
17      "driver_license",
18      "id_card"
19    ],
20    "requires_back": true
21  },
22  "selfie": {
23    "required": true
24  },
25  "user_info": {
26    "first_name": "Alice",
27    "last_name": "Johnson",
28    "date_of_birth": "1990-05-15"
29  },
30  "proof_of_address": {
31    "enabled": true
32  },
33  "otp": {
34    "verify_phone": true,
35    "verify_email": false
36  },
37  "liveness": {
38    "enabled": true
39  },
40  "nfc": {
41    "enabled": false
42  },
43  "signals": {
44    "enabled": true,
45    "nonce": "a1b2c3d4e5f67890",
46    "categories": [
47      "device_fingerprint",
48      "location",
49      "behavioral_biometrics"
50    ]
51  },
52  "branding": {
53    "primary_color": "#0047AB",
54    "logo_url": "https://cdn.withverifa.com/assets/logo-verifa-blue.png",
55    "company_name": "Acme Corp"
56  },
57  "resume_state": {
58    "last_completed_step": "document_capture",
59    "document_front_uploaded": true,
60    "document_back_uploaded": false
61  }
62}

Returns the mobile SDK configuration for a capture session, including the ordered step list, accepted document types, branding colours, liveness/NFC/signals config, and any partially completed state used for resume.

Authenticated by capture session token (query parameter), not by API key.

Was this page helpful?
Previous

Get a device attestation challenge

Next
Built with

Authentication

X-API-Keystring

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

Headers

Verifa-VersiondateOptional

API version date string (e.g. 2026-02-01). If omitted, the version pinned to your API key is used.

Query parameters

tokenstringRequired
Capture session token.

Response

SDK configuration.
session_idstring
statusstring
stepslist of strings
documentobject
selfieobject
user_infomap from strings to any
proof_of_addressobject
otpobject
livenessobject
nfcobject
signalsobject
brandingobject
resume_statemap from strings to any

Errors

400
Bad Request Error
404
Not Found Error