Saltar al contenido principal

ConsentAction

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
subject_idstringnullable

Identificador del sujeto asociado. Puede ser una Entity o Identity.

Example: id_5F6Q6C2EwkXtkEpB1TlGjk
subject_typestringnullable

Tipo del sujeto asociado.

Possible values: [Entity, Identity]

Example: Identity
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_titlestring

Título de la versión de la plantilla capturada por la acción cuando no se expande la relación.

Example: Autorización para comunicaciones de marketing
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_atdate-time

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

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

Indica si la acción fue importada desde un sistema externo (consentimiento previo).

Example: false
source_systemstringnullable

Sistema de origen cuando la acción fue importada.

Example: legacy_crm
third_party_idstringnullable

ID del tercero pre-registrado que capturó el consentimiento en nombre de la empresa. Solo presente cuando la acción fue capturada por un tercero. Requiere el módulo third_party_consent.

Example: tp_1B2M2Y8AsgTpgAmY7PhCfg
third_party_namestringnullable

Nombre comercial del tercero que capturó el consentimiento. Solo presente cuando aplica.

Example: Corredora Andes
capture_kindstring

Cómo se capturó el consentimiento. direct cuando la empresa lo capturó directamente; third_party_captured cuando un tercero transfirió la acción del propio titular; third_party_attestation cuando el tercero solo declaró haberlo obtenido.

Possible values: [direct, third_party_captured, third_party_attestation]

Example: direct
attestor objectnullable

Persona que actuó por el tercero al capturar el consentimiento. Solo presente cuando aplica.

tinstring

RUT de la persona, normalizado.

Example: 12345678-5
namestring

Nombre de la persona.

Example: Juan Pérez
internalboolean

Indica si la persona es un ejecutivo interno de la empresa actuando por el tercero.

Example: false
external_referencestring

Identificador de la persona en los sistemas de la empresa.

Example: EMP-1234
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
    scope_namestringnullable

    Nombre para mostrar del recurso scope (display name del producto o de la sucursal).

    Example: Sucursal Santiago
    scope_legal_namestringnullable

    Razón social de la sucursal. Solo presente para scopes de tipo branch.

    Example: Soyio Chile SpA
  • ]
    • 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
    redecboolean

    Indica si la acción corresponde a un consentimiento REDEC.

    Example: true
    redec_data object

    Datos REDEC asociados a la acción de consentimiento. Solo presente en acciones con datos REDEC.

    redec_idstring

    Identificador REDEC de 20 caracteres alfanuméricos.

    Example: A1b2C3d4E5f6G7h8I9j0
    executive_ninstringnullable

    RUT del ejecutivo que facilitó el consentimiento.

    Example: 12345678-5
    audio_referenceurinullable

    URL de referencia al audio de consentimiento verbal.

    Example: https://example.com/audio/consent_12345.mp3
    audio_hashstringnullable

    Hash SHA256 del audio de consentimiento.

    Example: a3b2c1d4e5f67890abcdef1234567890abcdef1234567890abcdef1234567890
    redec_receipt_pdfurinullable

    URL temporal del PDF REDEC generado por Soyio. Se omite mientras está pendiente.

    Example: https://files.example.com/redec/consent.pdf
    redec_receipt_pdf_referencestringnullable

    Referencia de un comprobante REDEC administrado externamente.

    Example: receipts/vendor/consent-123.pdf
    redec_pdf_hashstringnullable

    Hash SHA256 del comprobante REDEC.

    Example: a3b2c1d4e5f67890abcdef1234567890abcdef1234567890abcdef1234567890
    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",
      "subject_id": "id_5F6Q6C2EwkXtkEpB1TlGjk",
      "subject_type": "Identity",
      "user_reference": "user_123",
      "consent_template_id": "ctmpl_1B2M2Y8AsgTpgAmY7PhCfg",
      "consent_commit_id": "ccmt_1B2M2Y8AsgTpgAmY7PhCfg",
      "consent_template_name": "Essential Services Template",
      "consent_template_title": "Autorización para comunicaciones de marketing",
      "consent_template_version": 1,
      "origin": "web_signup",
      "channel": "digital",
      "kind": "grant",
      "data_use": "essential",
      "created_at": "2024-03-20T15:30:00Z",
      "imported": false,
      "source_system": "legacy_crm",
      "third_party_id": "tp_1B2M2Y8AsgTpgAmY7PhCfg",
      "third_party_name": "Corredora Andes",
      "capture_kind": "direct",
      "attestor": {
        "tin": "12345678-5",
        "name": "Juan Pérez",
        "internal": false,
        "external_reference": "EMP-1234"
      },
      "scope_selection_behavior": "replace",
      "metadata": {
        "checkbox_id": "cb_123"
      },
      "selected_scopes": [
        {
          "scope_type": "product",
          "scope_id": "prod_1B2M2Y8AsgTpgAmY7PhCfg",
          "scope_version": 1,
          "scope_name": "Sucursal Santiago",
          "scope_legal_name": "Soyio Chile SpA"
        }
      ],
      "contextual_data": {
        "ip": "192.168.1.1",
        "user_agent": "Mozilla/5.0",
        "url": "https://example.com",
        "phone_number": "+56912345678"
      },
      "redec": true,
      "redec_data": {
        "redec_id": "A1b2C3d4E5f6G7h8I9j0",
        "executive_nin": "12345678-5",
        "audio_reference": "https://example.com/audio/consent_12345.mp3",
        "audio_hash": "a3b2c1d4e5f67890abcdef1234567890abcdef1234567890abcdef1234567890"
      },
      "redec_receipt_pdf": "https://files.example.com/redec/consent.pdf",
      "redec_receipt_pdf_reference": "receipts/vendor/consent-123.pdf",
      "redec_pdf_hash": "a3b2c1d4e5f67890abcdef1234567890abcdef1234567890abcdef1234567890",
      "evidence_id": "evd_wCntp5aXB5q7fKSthevwrw",
      "agreement_id": "agr_wCntp5aXB5q7fKSthevwrw",
      "agreement_version": 1,
      "data_categories": [
        "user.name.first",
        "user.contact.email"
      ]
    }