Docs · Validators

`enum` validator

Reject any value not in an exact, case-sensitive allow-list.

One of 19 validator types · pure compute, no AI cost

Reference

Format

Membership test against an explicit `values` array. Comparison is strict equality — case-sensitive, whitespace-sensitive. Normalise upstream (lowercase, trim) if your data is dirty.

Examples

values: ['male', 'female', 'other', 'unknown']
values: ['permanent', 'fixed_term', 'apprentice']
values: ['USD', 'EUR', 'CHF']

How it runs

Implementation

A faithful summary of lib/validators.ts. Validators are pure functions and run identically in the Worker, the Workbench and the MCP server — one implementation, so the three cannot disagree about whether a value is valid.

lib/validators.ts

function validEnum(value, params) {
  const vs = Array.isArray(params.values) ? params.values : []
  return vs.includes(value)
    ? OK
    : fail('enum_invalid', `expected one of ${vs.join(', ')}`)
}

Config

Use in a template

Validators attach to a field on a custom template. The cascade runs them after mapping but before commit; failures surface in the per-row validation report.

template.yaml

fields:
  - column: gender
    type: enum
    enum_values: [male, female, other, unknown]
    validators:
      - type: enum
        values: [male, female, other, unknown]

Watch out

Common gotchas

Strict equality only — `Male` will fail against `male`. Lowercase in your transform first.
The validator does not consult `enum_values` on the field; you must pass `values` to the validator separately.
No partial match, no synonym mapping. Use a transform step for synonyms like `M → male`.

Where it runs

Three routes, no AI cost.

POST/v1/validate-rowValidate one row against a template. Stateless, no key, pure compute — the fastest way to try enum against a real value.no key
POST/v1/uploads/:id/validateRun every field validator over the parsed upload, without committing. Returns errors and warnings per row.read
POST/v1/uploads/:id/commitValidates on the way out. skip_invalid_rows drops the failures instead of failing the commit.commit

Validators are pure functions, so they add nothing to the AI bill. Every map draws a small flat per-map fee from your prepaid token wallet ($10 minimum, shared across the phi-cloud suite); only columns that reach the metered LLM layer, plus any-to-any convert and structural reshape, bill real AI tokens. See pricing

Catalogue

Related templates

No template in the default catalogue ships with enum preconfigured. Use it on a custom template via the YAML snippet above, or through the template editor.

Explore

All 19 validator types

The complete list a template field can declare. There is no SNOMED validator — it required an affiliate licence, no template used it, and it was removed in 2026.

Back to the documentation index or browse the template catalogue.

Ready when you are

Validate every row — before it lands.

Attach checksum-strict validators to any field, and gate risky commits behind the requires_hitl flag. One key runs the whole cascade.

Get an API key See pricing

Prepaid token wallet · schema-only data-minimization mode · no free tier

enum validator