Saltar al contenido principal

Configuration

Representa a los aspectos configurables de tu empresa, tales como canales de comunicación u otros datos relevantes.

alert_notification_emailstring

Dirección de correo electrónico que recibirá alertas de eventos críticos en el sistema, por ejemplo, notificaciones sobre fallas de webhooks.

Example: alerts@example.com
icon_variantstring

Variante de íconos preferida.

Possible values: [duotone, outline, solid]

Default value: duotone
whitelisted_domainsstring[]

Lista de dominios permitidos para el contenido de tu embed.

validation object

Configuración exclusiva para las validaciones de identidad.

government_checkboolean

Indica si se debe hacer un cruce con la base de datos del gobierno al validar una identidad.

Default value: false
ephemeral_transaction_databoolean

Indica si los datos de la transacción deben ser eliminados después de la validación.

Default value: true
disclosure object

Configuración exclusiva para el módulo de Disclosure Request.

skip_passkey_registrationboolean

Indica si se debe saltar el registro de llave de acceso para usuarios que no creen cuenta con Soyio. Si el usuario desea crear una cuenta, de todas maneras se le pedirá que registre su llave de acceso.

Default value: false
consent object

Configuración exclusiva para el módulo de consentimiento.

whitelisted_domainsstring[]

Lista de dominios permitidos para el contenido de tu embed. Los dominios especificados acá se agregarán a la lista de dominios permitidos para el contenido de tu embed.

label_displaystring

Los consentimientos pueden ser opcionales o obligatorios. Si el consentimiento es obligatorio y el label_display es mandatory_only, entonces sólo se mostrará el label de Requerido en los consentimietos. Por el contrario, si el consentimiento es opcional y el label_display es optional_only, entonces sólo se mostrará el label de Opcional en los consentimietos. Puedes ver un ejemplo acá.

Possible values: [optional_only, mandatory_only]

Default value: optional_only
mandatory_label_textstring

Texto del label de consentimiento cuando el label_display es mandatory_only. Si es required, entonces el label será Requerido. Si es mandatory, entonces el label será Obligatorio.

Possible values: [required, mandatory]

Default value: required
privacy_center object

Configuración exclusiva para el módulo de Centro de Privacidad.

contact_emailstring

Email de contacto para el Centro de Privacidad.

Example: privacy@example.com
public_urlstring

URL pública del Centro de Privacidad. Puedes encontrar más información sobre los modos de integración acá.

Example: https://public-privacy.example.com
private_urlstring

URL privada del Centro de Privacidad. Revisa funcionalidades y modos del Centro de Privacidad para más información.

Example: https://private-privacy.example.com
data_subject_request object

Configuración exclusiva para el Data Subject Request, módulo que se encuentra en el Centro de Privacidad.

mandatory_validationboolean

Determina si la validación de identidad es obligatoria durante el proceso de solicitud de derechos del titular de datos (DSR).

  • false (por defecto): El usuario recibe confirmación de que su solicitud fue creada exitosamente y puede elegir validar su identidad inmediatamente o en un momento posterior.
  • true: El usuario debe completar el proceso de validación de identidad antes de poder proceder con su solicitud.
Default value: false
disable_functional_emailsboolean

Determina si se deben enviar correos electrónicos funcionales (recuperación de código de solicitud por ejemplo) al titular de datos.

  • false (por defecto): Se envían correos electrónicos funcionales.
  • true: No se envían correos electrónicos funcionales. Si eliges esta opción, debes manejar el envío de estos correos electrónicos por tu cuenta, o el usuario no recibirá ningún correo electrónico funcional.
Default value: false
disable_informative_emailsboolean

Determina si se deben enviar correos electrónicos informativos (confirmación de solicitud, etc.) al titular de datos.

  • false (por defecto): Se envían correos electrónicos informativos.
  • true: No se envían correos electrónicos informativos.
Default value: false
validation_timeout_periodstringnullable

Período de tiempo durante el cual el titular de datos puede validar su identidad después de crear una solicitud en formato ISO 8601.

  • Si no se especifica (null): La solicitud no expira y el usuario puede validar su identidad en cualquier momento.
  • Si se especifica: La solicitud expirará después del período indicado, y el usuario deberá crear una nueva solicitud.

El período total debe ser mayor que 0.

Example: P1D
allow_many_data_categories_mutationsboolean

Determina si las solicitudes de mutación (rectificación, oposición, supresión) pueden especificar más de una categoría de datos.

  • true (por defecto): Las solicitudes de mutación pueden incluir múltiples categorías de datos.
  • false: Las solicitudes de mutación están limitadas a una sola categoría de datos por solicitud.
Default value: true
Example: true
contact_field_configs object[]

Configuración de los campos adicionales de contacto que puede completar el titular al crear su solicitud.

Cada elemento permite controlar la visibilidad y obligatoriedad de los campos soportados (names, last_names, phone).

  • Array [
    • field_namestringrequired

    Campo de contacto al que se aplica la configuración.

    Possible values: [names, last_names, phone]

    Example: phone
    visiblebooleanrequired

    Determina si el campo se muestra en los formularios del Centro de Privacidad. Si es false, el titular no verá este campo.

    Example: true
    requiredbooleanrequired

    Indica si el campo debe ser completado cuando es visible. No puede establecerse en true cuando visible es false.

    Example: false
  • ]
    • appliable_scopesstring[]

    Define si las solicitudes deben asociarse obligatoriamente a una sucursal de la empresa.

    • Si está vacío (por defecto): Las solicitudes son de alcance general (sin asociación a sucursal).
    • Si contiene "branch": El solicitante debe seleccionar una sucursal al crear la solicitud.

    Possible values: [branch]

    Default value: []
    Example: ["branch"]
    dashboard object

    Configuración exclusiva para el dashboard de la empresa.

    auth_methodsstring[]

    Lista de métodos de autenticación habilitados para el dashboard de la empresa. Los métodos disponibles son:

    • password: Autenticación con contraseña
    • google: Autenticación con Google OAuth
    • azure: Autenticación con Azure AD
    • passkeys: Autenticación con llaves de acceso (WebAuthn)

    Possible values: [password, google, azure, passkeys]

    Default value: ["password"]
    Example: ["password","google","passkeys"]
    Configuration
    {
      "alert_notification_email": "alerts@example.com",
      "icon_variant": "duotone",
      "whitelisted_domains": [
        "string"
      ],
      "validation": {
        "government_check": false,
        "ephemeral_transaction_data": true
      },
      "disclosure": {
        "skip_passkey_registration": false
      },
      "consent": {
        "whitelisted_domains": [
          "string"
        ],
        "label_display": "optional_only",
        "mandatory_label_text": "required"
      },
      "privacy_center": {
        "contact_email": "privacy@example.com",
        "public_url": "https://public-privacy.example.com",
        "private_url": "https://private-privacy.example.com"
      },
      "data_subject_request": {
        "mandatory_validation": false,
        "disable_functional_emails": false,
        "disable_informative_emails": false,
        "validation_timeout_period": "P1D",
        "allow_many_data_categories_mutations": true,
        "contact_field_configs": [
          {
            "field_name": "phone",
            "visible": true,
            "required": false
          }
        ],
        "appliable_scopes": [
          "branch"
        ]
      },
      "dashboard": {
        "auth_methods": [
          "password",
          "google",
          "passkeys"
        ]
      }
    }