Get verification stats by document type

GET

https://devapi.withverifa.com/api/v1/analytics/by-document-type

GET

/api/v1/analytics/by-document-type

$ curl https://devapi.withverifa.com/api/v1/analytics/by-document-type \
>      -H "X-API-Key: <apiKey>" \
>      -H "Content-Type: application/json"

1 {
2   "data": [
3     {
4       "document_type": "passport",
5       "total": 1500,
6       "verified": 1400,
7       "failed": 100,
8       "verification_rate": 0.933
9     },
10     {
11       "document_type": "drivers_license",
12       "total": 1200,
13       "verified": 1100,
14       "failed": 100,
15       "verification_rate": 0.917
16     },
17     {
18       "document_type": "state_id",
19       "total": 800,
20       "verified": 750,
21       "failed": 50,
22       "verification_rate": 0.938
23     },
24     {
25       "document_type": "unknown",
26       "total": 200,
27       "verified": 180,
28       "failed": 20,
29       "verification_rate": 0.9
30     }
31   ],
32   "days": 30
33 }

Returns verification counts grouped by document classification (passport, drivers_license, state_id, etc.). Unclassified documents are grouped as unknown.

Required scope: sessions:read

Authentication

X-API-Keystring

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

Query parameters

daysintegerOptional7-90Defaults to 30

Response

Per-document-type verification stats.

datalist of objects

daysinteger

Errors

401

Unauthorized Error

Authentication

Headers

Query parameters

Response

Errors