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
Use Cases
Core Concepts
Integration Guides
API Details
Tutorials
Best Practices
- Changelog
API Reference

API Reference Custom Fields

List custom field definitions

GET

https://devapi.withverifa.com/api/v1/identity-types/:type_id/fields

GET

/api/v1/identity-types/:type_id/fields

$ curl https://devapi.withverifa.com/api/v1/identity-types/type_id/fields \
>      -H "X-API-Key: <apiKey>"

1 {
2   "data": [
3     {
4       "id": "cfield_abc123",
5       "org_id": "org_abc123",
6       "identity_type_id": "idtype_abc123",
7       "name": "employee_id",
8       "label": "Employee ID",
9       "field_type": "string",
10       "is_required": true,
11       "created_at": "2024-01-15T09:30:00Z",
12       "is_unique": true,
13       "is_encrypted": true,
14       "enum_values": [
15         "string"
16       ],
17       "validation_regex": "string",
18       "sort_order": 1
19     }
20   ]
21 }

Was this page helpful?

Create a custom field definition

Authentication

X-API-Keystring

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

Path parameters

type_idstringRequired

Identity type ID (idtype_*).

Headers

Verifa-VersiondateOptional

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

Key-InflectionenumOptionalDefaults to snake

Response key casing. Defaults to snake.

Allowed values:

Response

A list of custom field definitions.

datalist of objects

Errors

401

Unauthorized Error

404

Not Found Error