ConsentForm

Un consent form es una configuración versionada que agrupa uno o más consent templates y define los campos dinámicos a solicitar antes de registrar el consentimiento.

idstringrequired

Identificador único. Debe empezar con cform_.

Example: cform_wAspvmEr4ACDZaPUtfwjsA

versionintegerrequired

Example: 1

namestringrequired

Example: Consentimiento onboarding

slugstringrequired

Identificador del formulario en la URL. Acepta letras minúsculas, números y guiones.

Possible values: >= 3 characters and <= 80 characters, Value must match regular expression ^[a-z0-9]([a-z0-9-]*[a-z0-9])?$

Example: consentimiento-onboarding

titlestringrequired

Example: Autorización de tratamiento de datos

statusstringrequired

Possible values: [draft, published, archived]

Example: published

fields object[]required

Array [

keystringrequired

Llave del campo a guardar en data.

Example: full_name

labelstringrequired

Etiqueta para renderizar el campo en frontend.

Example: Nombre completo

typestringrequired

Possible values: [text, name, email, nin, phone, textarea, select, checkbox, date]

Example: text

requiredbooleanrequired

Example: true

hiddenboolean

Oculta el campo a quien completa el formulario. Su valor lo entrega el integrador al cargar el formulario y se guarda en data con su key, igual que los campos visibles.

Default value: false

Example: false

optionsstring[]required

Opciones permitidas para campos select. Se ignora y persiste como vacío para otros tipos.

Example: ["CL","PE"]

placeholderstringnullablerequired

Texto de ayuda mostrado dentro del campo.

Example: Jane Doe

page_indexintegerrequired

Índice de la página donde se muestra el campo.

Possible values: >= 0

Default value: 0

Example: 0

positionintegerrequired

Posición del campo dentro de su página.

Possible values: >= 0

Default value: 0

Example: 1

]

consent_templates object[]required

Array [

consent_template_idstringrequired

Example: constpl_wAspvmEr4ACDZaPUtfwjsA

consent_template_versionintegerrequired

Versión que el formulario presenta hoy. Con auto_update_consent_template_versions en true es la versión latest del template; con false es la versión fijada en el formulario.

Example: 2

requiredbooleanrequired

Example: true

redec_compatiblebooleanrequired

Compatibilidad REDEC de la versión exacta actualmente presentada.

Example: true

redec_compatibility_mismatchbooleanrequired

Indica si la compatibilidad REDEC cambió respecto del snapshot guardado en el formulario.

Example: false

page_indexintegerrequired

Possible values: >= 0

Example: 0

positionintegerrequired

Possible values: >= 0

Example: 2

data_usesstring[]required

Categorías raíz de uso de datos declaradas por el template seleccionado.

Example: ["marketing"]

namestringnullablerequired

Nombre interno resuelto del template seleccionado.

Example: Marketing

titlestringnullablerequired

Título visible resuelto del template seleccionado.

Example: Comunicaciones comerciales

]

validation objectrequired

Configuración de validación previa al registro de una entrada del formulario.

government_check_enabledboolean

Si está activo, el formulario valida RUT y número de documento antes de crear el ConsentFormEntry.

Example: true

early_government_check_enabledboolean

Solo aplica cuando government_check_enabled es true. Si está activo, el formulario valida RUT y número de documento al avanzar desde la página que los contiene, en lugar de esperar al envío final. Por defecto es false. Desactivar government_check_enabled lo vuelve a false.

Default value: false

Example: false

rut_field_keystringnullable

Key del campo tipo nin usado como RUT.

Example: cl_carnet_rut

document_number_field_keystringnullable

Key del campo texto usado como número de documento.

Example: cl_carnet_doc_number

document_number_field_managedboolean

Indica si el campo de número de documento fue creado por el editor al activar la validación.

Example: true

entries_countintegerrequired

Total de entries registradas para todas las versiones del formulario.

Possible values: >= 0

Example: 42

created_atdate-timerequired

Example: 2024-03-20T15:30:00Z

auto_update_consent_template_versionsboolean

Indica si el formulario presenta siempre la última versión de cada consent template (true) o si queda fijado en las versiones seleccionadas (false).

Example: true

redec objectnullable

Mapeo de campos usados para capturar consentimientos REDEC. RUT y correo son obligatorios al publicar un formulario con templates REDEC. Si también se usa validación gubernamental, entity_nin_field_key debe coincidir con validation.rut_field_key.

entity_nin_field_keystringnullable

Key del campo requerido tipo nin usado como RUT del titular.

Example: entity_rut

email_field_keystringnullable

Key del campo requerido tipo email usado para enviar el comprobante REDEC.

Example: email

executive_nin_field_keystringnullable

Key opcional de un campo tipo nin usado como RUT del ejecutivo.

Example: executive_rut

descriptionstringnullablerequired

Example: Completa tus datos y preferencias.

per_page_headersbooleanrequired

Example: false

pages object[]required

Array [

indexinteger

Índice de la página (base 0) al que aplica el título y descripción.

Example: 0

titlestringnullable

Título visible de la página. Si queda vacío, la página usa el title del formulario.

Example: Datos personales

descriptionstringnullable

Descripción visible de la página. Si queda vacía, la página usa el description del formulario.

Example: Cuéntanos sobre ti

]

appearance objectnullablerequired

hide_logoboolean

Default value: false

Example: false

hide_titleboolean

Default value: false

Example: false

hide_descriptionboolean

Default value: false

Example: false

font_familystringnullable

Example: Inter

primary_colorstringnullable

Possible values: Value must match regular expression ^#(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6})$

Example: #003058

button_alignmentstringnullable

Possible values: [left, center, right]

Default value: left

Example: left

text_alignmentstring

Possible values: [left, center, right]

Example: left

logo_alignmentstring

Possible values: [left, center, right]

Example: left

progress_indicator_stylestringnullable

Possible values: [bar, steps]

Default value: bar

Example: bar

progress_indicator_positionstringnullable

Possible values: [top, center, bottom]

Default value: center

Example: center

logo objectnullablerequired

urlurinullablerequired

URL pública del logo.

Example: https://cdn.example.com/logo.png

filenamestringnullablerequired

Example: logo.png

sizeintegernullablerequired

Tamaño del archivo en bytes.

Example: 4812

mime_typestringnullablerequired

Example: image/png

success_screen objectnullablerequired

titlestringnullable

Example: Gracias

messagestringnullable

Example: Recibimos tu información.

button_textstringnullable

Example: Continuar

redirect_urlurinullable

Possible values: Value must match regular expression ^https?://

Example: https://example.com/thanks

ConsentForm
{
  "id": "cform_wAspvmEr4ACDZaPUtfwjsA",
  "version": 1,
  "name": "Consentimiento onboarding",
  "slug": "consentimiento-onboarding",
  "title": "Autorización de tratamiento de datos",
  "status": "published",
  "fields": [
    {
      "key": "full_name",
      "label": "Nombre completo",
      "type": "text",
      "required": true,
      "hidden": false,
      "options": [
        "CL",
        "PE"
      ],
      "placeholder": "Jane Doe",
      "page_index": 0,
      "position": 1
    }
  ],
  "consent_templates": [
    {
      "consent_template_id": "constpl_wAspvmEr4ACDZaPUtfwjsA",
      "consent_template_version": 2,
      "required": true,
      "redec_compatible": true,
      "redec_compatibility_mismatch": false,
      "page_index": 0,
      "position": 2,
      "data_uses": [
        "marketing"
      ],
      "name": "Marketing",
      "title": "Comunicaciones comerciales"
    }
  ],
  "validation": {
    "government_check_enabled": true,
    "early_government_check_enabled": false,
    "rut_field_key": "cl_carnet_rut",
    "document_number_field_key": "cl_carnet_doc_number",
    "document_number_field_managed": true
  },
  "entries_count": 42,
  "created_at": "2024-03-20T15:30:00Z",
  "auto_update_consent_template_versions": true,
  "redec": {
    "entity_nin_field_key": "entity_rut",
    "email_field_key": "email",
    "executive_nin_field_key": "executive_rut"
  },
  "description": "Completa tus datos y preferencias.",
  "per_page_headers": false,
  "pages": [
    {
      "index": 0,
      "title": "Datos personales",
      "description": "Cuéntanos sobre ti"
    }
  ],
  "appearance": {
    "hide_logo": false,
    "hide_title": false,
    "hide_description": false,
    "font_family": "Inter",
    "primary_color": "#003058",
    "button_alignment": "left",
    "text_alignment": "left",
    "logo_alignment": "left",
    "progress_indicator_style": "bar",
    "progress_indicator_position": "center"
  },
  "logo": {
    "url": "https://cdn.example.com/logo.png",
    "filename": "logo.png",
    "size": 4812,
    "mime_type": "image/png"
  },
  "success_screen": {
    "title": "Gracias",
    "message": "Recibimos tu información.",
    "button_text": "Continuar",
    "redirect_url": "https://example.com/thanks"
  }
}