List document groups

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

{
  "data": [
    {
      "id": "grp_8f3a2b1c9d4e5f6a7b8c9d0e",
      "org_id": "org_1234567890abcdef",
      "name": "Identity Documents",
      "is_default": false,
      "is_active": true,
      "priority": 10,
      "created_at": "2024-01-15T09:30:00Z",
      "updated_at": "2024-04-10T14:45:00Z",
      "description": "Group for all government-issued identity documents like passports and driver licenses.",
      "classifications": [
        "passport",
        "driver_license",
        "national_id"
      ],
      "check_config": [
        [
          "document_authenticity",
          "identity",
          "required"
        ],
        [
          "photo_match",
          "biometric",
          "optional"
        ]
      ],
      "recency_config": {
        "enabled": true,
        "max_age_days": 180
      }
    }
  ]
}

Returns all document groups configured for your organization. Groups bundle related document types with shared routing and check configuration.

Required scope: documents:read.

Authentication

X-API-Keystring

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

Response

A list of document groups.

datalist of objects

Errors

401

Unauthorized Error

List document groups

Authentication

Headers

Response

Errors

Authentication

Headers

Response

Errors

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

1	{
2	"data": [
3	{
4	"id": "grp_8f3a2b1c9d4e5f6a7b8c9d0e",
5	"org_id": "org_1234567890abcdef",
6	"name": "Identity Documents",
7	"is_default": false,
8	"is_active": true,
9	"priority": 10,
10	"created_at": "2024-01-15T09:30:00Z",
11	"updated_at": "2024-04-10T14:45:00Z",
12	"description": "Group for all government-issued identity documents like passports and driver licenses.",
13	"classifications": [
14	"passport",
15	"driver_license",
16	"national_id"
17	],
18	"check_config": [
19	[
20	"document_authenticity",
21	"identity",
22	"required"
23	],
24	[
25	"photo_match",
26	"biometric",
27	"optional"
28	]
29	],
30	"recency_config": {
31	"enabled": true,
32	"max_age_days": 180
33	}
34	}
35	]
36	}