ConsentAction

Representa una acción de consentimiento realizada por un usuario

idstring

Identificador único de la acción de consentimiento

Example: consact_1B2M2Y8AsgTpgAmY7PhCfg

entity_idstringnullable

Identificador de la entidad asociada. Puede ser nulo.

Example: ent_5F6Q6C2EwkXtkEpB1TlGjk

user_referencestring

Referencia del usuario en el sistema del cliente

Example: user_123

consent_template_idstring

Identificador del template de consentimiento asociado.

Example: ctmpl_1B2M2Y8AsgTpgAmY7PhCfg

consent_commit_idstringnullable

Identificador del commit de consentimiento asociado a este recurso, en caso de se haya originado a través de un commit. De lo contrario, es nulo.

Example: ccmt_1B2M2Y8AsgTpgAmY7PhCfg

consent_template_namestring

Nombre de la plantilla de consentimiento asociado cuando no se expande la relación.

Example: Essential Services Template

consent_template_versioninteger

Versión de la plantilla de consentimiento asociada cuando no se expande la relación.

Example: 1

originstringnullable

Origen asociado a la acción de consentimiento.

Example: web_signup

contextstringnullabledeprecated

Deprecado: usar origin en su lugar. Contexto adicional asociado a la acción de consentimiento.

Example: web_signup

channelstring

Canal a través del cual se realizó la acción de consentimiento.

Possible values: [in_person, digital, phone_call]

Example: digital

kindstring

Tipo de acción realizada.

Possible values: [grant, revoke]

Example: grant

data_usestring

Uso principal de datos asociado a la acción de consentimiento.

Example: essential

created_atstring<date-time>

Fecha y hora de creación de la acción de consentimiento

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

scope_selection_behaviorstring

Semántica de selección de scopes para acciones de tipo grant. replace aplica intención final (puede revocar scopes no seleccionados). additive agrega solo los scopes seleccionados sin revocar los no seleccionados.

Possible values: [replace, additive]

Example: replace

metadataobject

Datos adicionales de la acción (máximo 4KB de tamaño serializado en JSON)

Example: {"checkbox_id":"cb_123"}

action_dataobjectdeprecated

Deprecado: usar metadata en su lugar. Datos adicionales de la acción.

Example: {"checkbox_id":"cb_123"}

action_typestringnullabledeprecated

Deprecado: campo eliminado, se mantiene por retrocompatibilidad.

Example: opt_in_click

selected_scopes object[]

Scopes seleccionados para esta acción. Si está vacío en templates sin scopes, la acción aplica de forma global.

Array [

scope_typestringrequired

Tipo de ámbito.

Possible values: [product, branch]

Example: product

scope_idstringrequired

Identificador público tokenizado del recurso scope.

Example: prod_1B2M2Y8AsgTpgAmY7PhCfg

scope_versionintegerrequired

Versión del recurso scope persistida en esta versión del template. Este valor queda fijado al guardar y no se actualiza automáticamente cuando aparecen nuevas versiones del scope.

Example: 1

]

contextual_data object

Datos contextuales como IP, user agent, etc.

ipstring

Example: 192.168.1.1

user_agentstring

Example: Mozilla/5.0

urlstring

Example: https://example.com

phone_numberstring

Example: +56912345678

evidence_idstringnullable

Identificador de la evidencia asociada al acuerdo generado por esta acción de consentimiento

Example: evd_wCntp5aXB5q7fKSthevwrw

agreement_idstringnullable

Identificador del acuerdo generado por esta acción de consentimiento

Example: agr_wCntp5aXB5q7fKSthevwrw

agreement_versionintegernullable

Versión del acuerdo generado por esta acción de consentimiento

Example: 1

data_categoriesstring[]

Lista de categorías de datos únicas cubiertas por el template de consentimiento asociado

Example: ["user.name.first","user.contact.email"]

ConsentAction
{
  "id": "consact_1B2M2Y8AsgTpgAmY7PhCfg",
  "entity_id": "ent_5F6Q6C2EwkXtkEpB1TlGjk",
  "user_reference": "user_123",
  "consent_template_id": "ctmpl_1B2M2Y8AsgTpgAmY7PhCfg",
  "consent_commit_id": "ccmt_1B2M2Y8AsgTpgAmY7PhCfg",
  "consent_template_name": "Essential Services Template",
  "consent_template_version": 1,
  "origin": "web_signup",
  "channel": "digital",
  "kind": "grant",
  "data_use": "essential",
  "created_at": "2024-03-20T15:30:00Z",
  "scope_selection_behavior": "replace",
  "metadata": {
    "checkbox_id": "cb_123"
  },
  "selected_scopes": [
    {
      "scope_type": "product",
      "scope_id": "prod_1B2M2Y8AsgTpgAmY7PhCfg",
      "scope_version": 1
    }
  ],
  "contextual_data": {
    "ip": "192.168.1.1",
    "user_agent": "Mozilla/5.0",
    "url": "https://example.com",
    "phone_number": "+56912345678"
  },
  "evidence_id": "evd_wCntp5aXB5q7fKSthevwrw",
  "agreement_id": "agr_wCntp5aXB5q7fKSthevwrw",
  "agreement_version": 1,
  "data_categories": [
    "user.name.first",
    "user.contact.email"
  ]
}