List document types

GET

https://devapi.withverifa.com/api/v1/settings/document-types

GET

/api/v1/settings/document-types

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

1 {
2   "data": [
3     {
4       "id": "doc_8f3a2b7c9d4e",
5       "org_id": "org_5a7c9e2f1b3d",
6       "slug": "auto-insurance-card",
7       "label": "Auto Insurance Card",
8       "category": "financial",
9       "is_active": true,
10       "created_at": "2024-01-15T09:30:00Z",
11       "updated_at": "2024-01-15T09:30:00Z",
12       "description": "Auto insurance proof-of-coverage card showing policy number, VIN, named insured, and effective and expiration dates of coverage.",
13       "extraction_hints": {
14         "vin": "Vehicle Identification Number, 17 alphanumeric characters",
15         "policy_number": "Insurance policy reference number",
16         "issue_date": "Effective start date of the policy (YYYY-MM-DD)",
17         "expiry_date": "End date of the policy coverage (YYYY-MM-DD)"
18       },
19       "check_suite": [
20         [
21           "document_authenticity",
22           "identity",
23           "required"
24         ],
25         [
26           "policy_validity",
27           "financial",
28           "optional"
29         ]
30       ]
31     }
32   ]
33 }

Returns all custom document types configured for your organization.

Required scope: documents:read.

List document types

List document types

Authentication

Headers

Response

Errors

Authentication

Headers

Response

Errors

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

1	{
2	"data": [
3	{
4	"id": "doc_8f3a2b7c9d4e",
5	"org_id": "org_5a7c9e2f1b3d",
6	"slug": "auto-insurance-card",
7	"label": "Auto Insurance Card",
8	"category": "financial",
9	"is_active": true,
10	"created_at": "2024-01-15T09:30:00Z",
11	"updated_at": "2024-01-15T09:30:00Z",
12	"description": "Auto insurance proof-of-coverage card showing policy number, VIN, named insured, and effective and expiration dates of coverage.",
13	"extraction_hints": {
14	"vin": "Vehicle Identification Number, 17 alphanumeric characters",
15	"policy_number": "Insurance policy reference number",
16	"issue_date": "Effective start date of the policy (YYYY-MM-DD)",
17	"expiry_date": "End date of the policy coverage (YYYY-MM-DD)"
18	},
19	"check_suite": [
20	[
21	"document_authenticity",
22	"identity",
23	"required"
24	],
25	[
26	"policy_validity",
27	"financial",
28	"optional"
29	]
30	]
31	}
32	]
33	}