Skip to main content

Fields

description : String

Human friendly description of the requested input.

isRequired : Boolean

True if the requested user input is required.

isValidated : Boolean

True if the submitted user input has been successfully validated.

isVerified : Boolean

Verification against the device happens after validation is successful. False means the input must be corrected.

key : String

Identifier for the requested user input.

regex : String

An optional regex pattern used to validate the user input. Uses Python re module syntax (evaluated with re.fullmatch). None if no pattern validation is applied.

value : String

The value that has been submitted for this input. Can be a string, integer, or boolean.

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

{ "description": "finish-as-tree-wide-wide", "isRequired": true, "isValidated": true, "isVerified": true, "key": "born-Democrat-pay-woman-myself", "regex": "read-product-else-must-film", "value": "east-bank-exactly-work-language" }