Create a custom field definition | Verifa

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

Request

This endpoint expects an object.

namestringRequired

Machine-readable field name.

labelstringRequired

Human-readable label.

field_typeenumRequired

Data type for this field.

is_requiredbooleanOptionalDefaults to false

Whether this field is required on identities of this type.

is_uniquebooleanOptionalDefaults to false

Whether values must be unique across identities.

is_encryptedbooleanOptionalDefaults to false

Whether values are encrypted at rest.

enum_valueslist of stringsOptional

Allowed values when field_type is enum.

validation_regexstringOptional

Optional regex pattern for value validation.

sort_orderintegerOptional

Display order for the field.

Response

Custom field definition created.

idstring

org_idstring

identity_type_idstring

namestring

labelstring

field_typeenum

is_requiredboolean

created_atdatetime

is_uniqueboolean

is_encryptedboolean

enum_valueslist of strings

validation_regexstring

sort_orderinteger

Errors

401

Unauthorized Error

404

Not Found Error

422

Unprocessable Entity Error

$	curl -X POST https://devapi.withverifa.com/api/v1/identity-types/type_id/fields \
>	-H "X-API-Key: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"name": "employee_id",
>	"label": "Employee ID",
>	"field_type": "string"
>	}'

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

$	curl -X POST https://devapi.withverifa.com/api/v1/identity-types/type_id/fields \
>	-H "X-API-Key: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"name": "employee_id",
>	"label": "Employee ID",
>	"field_type": "string"
>	}'

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