Skip to main content

Fields

code : String! required

The code to send this field's value under when enrolling.

description : String! required

What the field is for, as help text for a person filling it in.

name : String! required

A human-readable name for the field.

pattern : String

A regular expression a string value must match in full, if there is one.

required : Boolean! required

Whether the field must be provided.

The type of the field's value. Values are sent as strings: integers as digits, and booleans as true or false.

The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

Example

{ "code": "turn-us-police-difficult-fine", "description": "reach-what-require-front-particularly", "name": "rock-president-win-detail-TV", "pattern": "shake-population-happy-memory-society", "required": true, "type": "STRING" }