Get SDK configuration for a capture session

GET

https://api.withverifa.com/api/v1/sdk/config

GET

/api/v1/sdk/config

$ curl -G https://api.withverifa.com/api/v1/sdk/config \
>      -H "X-API-Key: <apiKey>" \
>      -d token=token

1 {
2   "session_id": "string",
3   "status": "string",
4   "steps": [
5     "string"
6   ],
7   "document": {
8     "accepted_types": [
9       "string"
10     ],
11     "requires_back": true
12   },
13   "selfie": {
14     "required": true
15   },
16   "user_info": {},
17   "proof_of_address": {
18     "enabled": true,
19     "accepted_types": [
20       "utility_bill"
21     ],
22     "accepted_type_options": [
23       {
24         "key": "utility_bill",
25         "label": "Utility bill",
26         "category": "utility",
27         "default_max_age_days": 90,
28         "review_only": true,
29         "counts_as_independent": true
30       }
31     ],
32     "retry_reasons": [
33       {
34         "code": "too_old",
35         "severity": "fail"
36       }
37     ],
38     "require_issuing_country": true,
39     "default_issuing_country": "string"
40   },
41   "otp": {
42     "verify_phone": true,
43     "verify_email": true
44   },
45   "liveness": {
46     "enabled": true
47   },
48   "nfc": {
49     "enabled": true
50   },
51   "signals": {
52     "enabled": true,
53     "nonce": "string",
54     "categories": [
55       "string"
56     ]
57   },
58   "branding": {
59     "primary_color": "string",
60     "logo_url": "string",
61     "company_name": "string"
62   },
63   "resume_state": {}
64 }

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.

Authentication

X-API-Keystring

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

Query parameters

tokenstringRequired

Capture session token.

Response

SDK configuration.

session_idstringOptional

statusstringOptional

stepslist of stringsOptional

documentobjectOptional

selfieobjectOptional

user_infomap from strings to anyOptional

proof_of_addressobjectOptional

otpobjectOptional

livenessobjectOptional

nfcobjectOptional

signalsobjectOptional

brandingobjectOptional

resume_statemap from strings to anyOptional

Errors

400

Bad Request Error

404

Not Found Error

Authentication

Headers

Query parameters

Response

Errors