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

titlestringrequired

Example: Autorización de tratamiento de datos

enabledbooleanrequired

Example: true

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, 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

Example: 2

requiredbooleanrequired

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

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

ConsentForm

{
  "id": "cform_wAspvmEr4ACDZaPUtfwjsA",
  "version": 1,
  "name": "Consentimiento onboarding",
  "title": "Autorización de tratamiento de datos",
  "enabled": true,
  "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
    }
  ],
  "validation": {
    "government_check_enabled": true,
    "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"
}