ConsentTemplate

Una consent template (template de consentimiento) es una configuración necesaria para el módulo de consent. Este modelo es versionado, por lo que cada cambio realizado genera una nueva versión, dejando trazable el historial de cambios.

idstringrequired

Identificador único. Debe empezar con constpl_

Example: constpl_wAspvmEr4ACDZaPUtfwjsA

namestringrequired

Nombre descriptivo de la template

Example: Consentimiento básico

versionintegerrequired

Versión del template de consentimiento

Example: 1

durationstringrequired

Periodo de retención de datos en formato ISO

Example: P12M3H

titlestringrequired

Titulo que aparecerá en el checkbox del módulo de consentimiento

Example: Consentimiento general

textstringrequired

Texto del consentimiento. Permite referenciar documentos de privacidad.

Example: De acuerdo a los {{ terms_and_conditions }} y {{ privacy_policy }} de Soyio.

data_requirements object[]required

Lista de requerimientos de datos con información adicional. Ver recurso para más información.

Possible values: >= 1

Array [

keystring

Clave del dato. Es un texto libre que identifica específicamente el dato involucrado en el consentimiento.

Example: first_name

data_categorystring

Categoría del dato según nuestra taxonomía. Revisa taxonomía para más información.

Example: user.name.first

data_usesstring[]

Lista de finalidades de tratamiento según nuestra taxonomía. Revisa taxonomía para más información.

]

data_subjectstringrequired

Sujeto de derecho para el cual se aplica este template de consentimiento. Define la categoría de persona o entidad cuyos datos personales serán procesados.

Possible values: [anonymous_user, citizen_voter, commuter, consultant, customer, employee, job_applicant, next_of_kin, passenger, patient, prospect, shareholder, supplier_vendor, trainee, visitor]

Example: customer

product_idstring

Identificador único del producto. No puede estar presente si se especifica branch_id.

Example: prod_1B2M2Y8AsgTpgAmY7PhCfg

branch_idstring

Identificador único de la branch. No puede estar presente si se especifica product_id.

Example: branch_1B2M2Y8AsgTpgAmY7PhCfg

optionalboolean

Indica si el template de consentimiento es opcional.

Example: false

enabledboolean

Indica si la plantilla de consentimiento se muestra en el centro de privacidad.

Default value: true

Example: true

created_atstring<date-time>required

Fecha y hora de creación del template de consentimiento

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

updated_atstring<date-time>

Fecha y hora de la última actualización del template de consentimiento

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

event_logs object[]required

Registro de eventos relacionados con el template de consentimiento (creación y actualización)

Array [

timestampstring<date-time>

Fecha y hora del evento

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

typestring

Tipo de evento

Example: created

descriptionstring

Descripción del evento

Example: Consent template created

payloadobject

Datos adicionales del evento

Example: {"version":1,"created_by":"cusr_123"}

]

ConsentTemplate

{
  "id": "constpl_wAspvmEr4ACDZaPUtfwjsA",
  "name": "Consentimiento básico",
  "version": 1,
  "duration": "P12M3H",
  "title": "Consentimiento general",
  "text": "De acuerdo a los {{ terms_and_conditions }} y {{ privacy_policy }} de Soyio.",
  "data_requirements": [
    {
      "key": "first_name",
      "data_category": "user.name.first",
      "data_uses": [
        "string"
      ]
    }
  ],
  "data_subject": "customer",
  "product_id": "prod_1B2M2Y8AsgTpgAmY7PhCfg",
  "branch_id": "branch_1B2M2Y8AsgTpgAmY7PhCfg",
  "optional": false,
  "enabled": true,
  "created_at": "2024-03-20T15:30:00Z",
  "updated_at": "2024-03-21T10:15:00Z",
  "event_logs": [
    {
      "timestamp": "2024-03-20T15:30:00Z",
      "type": "created",
      "description": "Consent template created",
      "payload": {
        "version": 1,
        "created_by": "cusr_123"
      }
    }
  ]
}