DocumentationAPI Reference
DocumentationAPI ReferenceStatus

Inquiry Fields

Inquiries store values collected from the customer in fields, and inquiry template versions define the field schemas.

You can configure custom fields on your template field schema to support your use cases. Please contact support or your CSM to get started.

❗️

Field values and customers

Fields are expressly intended for storing customer-supplied information. and are meant to be readable and writable by the end user.

Field Types

Name

Format

boolean

true | false

date

'YYYY-MM-DD'

number

123

string

'hello world'

choices

'enum_1'

multi_choices

['enum_1', 'enum_2']

Reading Fields

An inquiry's fields can be retrieved via the external API using a GET request. Fields are also passed back to the caller in inquiry flows on completion.

Fields are serialized as a nested map of field name to field type and field value. For example:

{
  "name-first": {
    "type": "string",
    "value": "John",
  },
  "name-first": {
    "type": "string",
    "value": "Doe",
  },
  "birthdate": {
    "type": "date",
    "value": "1980-12-25",
  }
}

Writing Fields

When updating an inquiry via API, fields should be passed as a map of field name to field value. Field type does not need to be specified.

{
  "name-first": "John",
  "name-first": "Doe",
  "birthdate": "1980-12-25"
}

Field schema policies

🚧

Experimental

Field policies are currently in beta and are not generally available. If you think field policies fit your use case, please contact support or your CSM for more information.

Field behavior can be modified with field policies.

Field write policies

Description

none

Default. No special behavior.

write_once

The field will become immutable after it has been set for the first time (via the end user, query string parameters, or external API).

Setting a default value on the field schema will NOT cause the field to become immutable.

Setting the field value to be null WILL cause the field to become immutable.

Field redaction policies

Description

none

Default. No special behavior.

never

This field will never be redacted. This is intended to be used for fields such as timestamps or tracking terms of service acceptance, and is NOT intended to be used for fields containing PII.