ConsentForm

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

entries_countintegerrequired

Example: 42

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

optionsstring[]

Example: ["CL","PE"]

]

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

]

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

validation object

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

created_atdate-timerequired

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

updated_atdate-timerequired

Example: 2024-03-21T10:15:00Z

descriptionstringnullable

Example: Formulario de autorización de datos personales

per_page_headersboolean

Example: false

pages object[]

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 objectnullable

hide_logoboolean

Example: false

hide_titleboolean

Example: false

hide_descriptionboolean

Example: false

font_familystringnullable

Example: Inter

primary_colorstringnullable

Example: #4F46E5

button_alignmentstring

Possible values: [left, center, right]

Example: left

progress_indicator_stylestring

Possible values: [bar, steps]

Example: bar

progress_indicator_positionstring

Possible values: [top, center, bottom]

Example: center

logo objectnullable

urluri

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

filenamestringnullable

Example: logo.png

sizeintegernullable

Example: 24576

mime_typestringnullable

Example: image/png

success_screen objectnullable

titlestringnullable

Example: ¡Listo!

messagestringnullable

Example: Tu consentimiento ha sido registrado.

button_textstringnullable

Example: Volver al inicio

redirect_urlstringnullable

Example: https://example.com/done

ConsentForm

{
  "id": "cform_wAspvmEr4ACDZaPUtfwjsA",
  "version": 1,
  "name": "Consentimiento onboarding",
  "slug": "consentimiento-onboarding",
  "title": "Autorización de tratamiento de datos",
  "status": "published",
  "entries_count": 42,
  "fields": [
    {
      "key": "full_name",
      "label": "Nombre completo",
      "type": "text",
      "required": true,
      "options": [
        "CL",
        "PE"
      ]
    }
  ],
  "consent_templates": [
    {
      "consent_template_id": "constpl_wAspvmEr4ACDZaPUtfwjsA",
      "consent_template_version": 2,
      "required": true
    }
  ],
  "auto_update_consent_template_versions": true,
  "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
  },
  "created_at": "2024-03-20T15:30:00Z",
  "updated_at": "2024-03-21T10:15:00Z",
  "description": "Formulario de autorización de datos personales",
  "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": "#4F46E5",
    "button_alignment": "left",
    "progress_indicator_style": "bar",
    "progress_indicator_position": "center"
  },
  "logo": {
    "url": "https://cdn.example.com/logo.png",
    "filename": "logo.png",
    "size": 24576,
    "mime_type": "image/png"
  },
  "success_screen": {
    "title": "¡Listo!",
    "message": "Tu consentimiento ha sido registrado.",
    "button_text": "Volver al inicio",
    "redirect_url": "https://example.com/done"
  }
}