Carga de documentos para firma

La funcionalidad de Carga de Documentos para Firma permite integrar, a través del SDK, la subida segura de documentos que deben ser firmados electrónicamente.

Ejemplos de integración

aviso

Para la integración es necesario tener un elemento <iframe id='iframeId'> donde se renderizará el SDK y a la funcion AucoSDK se le debe indicar el id de este elemento

info

Sigue el siguiente enlace para ver la referencia de los eventos que se requieren en una integración de SDK 👉🏻 Eventos

Integración básica

import { AucoSDK } from 'auco-sdk-integration';

const unsubscribe = AucoSDK({
  iframeId: 'iframeId',
  sdkType: 'upload',
  language: 'es', // Lenguajes aceptados 'es' | 'en'
  keyPublic: 'prk_xxxxx', // Llave privada de la compañía necesaria para la creación del proceso
  events: {
    onSDKReady,
    onSDKClose,
    onSDKToken,
  },
  sdkData: {
    userAttributes: {
      email: 'admin@company.com', // Email de usuario registrado en Auco, se recomienda usar el correo del admin de la compañía
    },
    uxOptions: {
      primaryColor: '#021c30',
      alternateColor: '#a557f2',
    },
  },
  env: process.env.PUBLIC_ENVIRONMENT == 'dev' ? 'DEV' : 'PROD',
});

Integración con firmantes precargados (ESTABLE)

peligro

Este método será deprecado en un futuro, se recomienda utilizar el método detallado en el siguiente item.

info

Sigue el siguiente enlace para ver la referencia de los países y tipos de documentos aceptados 👉🏻 Documentos y paises

import { AucoSDK } from 'auco-sdk-integration';

const unsubscribe = AucoSDK({
  iframeId: 'iframeId',
  sdkType: 'upload',
  language: 'es', // Lenguajes aceptados 'es' | 'en'
  keyPublic: 'prk_xxxxx', // Llave privada de la compañía necesaria para la creación del proceso
  events: {
    onSDKReady,
    onSDKClose,
    onSDKToken,
  },
  sdkData: {
    userAttributes: {
      email: 'admin@company.com', // Email de usuario registrado en Auco, se recomienda usar el correo del admin de la compañía
    },
    users: [
        {
            name: 'Firmante';
            email: 'firmante@auco.ai';
            phone: '+573151234567';
            country: 'CO';
            identification: '1234567890';
            identificationType: 'CC';
        }
    ],
    uxOptions: {
      primaryColor: '#021c30',
      alternateColor: '#a557f2',
    },
  },
  env: process.env.PUBLIC_ENVIRONMENT == 'dev' ? 'DEV' : 'PROD',
});

Integración con firmantes precargados

aviso

Esta función solo está disponible desde v1.0.0 en adelante

info

Sigue el siguiente enlace para ver la referencia de los países y tipos de documentos aceptados 👉🏻 Documentos y paises

import { AucoSDK } from 'auco-sdk-integration';

const unsubscribe = AucoSDK({
  iframeId: 'iframeId',
  sdkType: 'upload',
  language: 'es', // Lenguajes aceptados 'es' | 'en'
  keyPublic: 'prk_xxxxx', // Llave privada de la compañía necesaria para la creación del proceso
  events: {
    onSDKReady,
    onSDKClose,
    onSDKToken,
  },
  sdkData: {
    userAttributes: {
      email: 'admin@company.com', // Email de usuario registrado en Auco, se recomienda usar el correo del admin de la compañía
    },
    flowData: {
      type: 'participants',
      participants: [
        {
          id: 'id1',
          type: 'signer',
          name: 'Firmante',
          email: 'firmante@auco.ai',
          phone: '+573161979572',
          country: 'CO',
          identification: '123',
          identificationType: 'CC',
          locked: true, // Este participante no podrá ser editado ni eliminado
        },
        {
          id: 'id2',
          type: 'approver',
          name: 'Aprobador',
          email: 'aprobador@auco.ai',
          phone: '+573161979572',
          country: 'CO',
          identification: '1234',
          identificationType: 'CC',
        },
        {
          id: 'id3',
          type: 'reader',
          name: 'Lector',
          email: 'lector@auco.ai',
          locked: true, // Este participante no podrá ser editado ni eliminado
        },
      ],
    },
    uxOptions: {
      primaryColor: '#021c30',
      alternateColor: '#a557f2',
    },
  },
  env: 'DEV',
});

Integración con flujo precargado

En este tipo de integración al abrir el SDK el usuario solo deberá posicionar las firmas

aviso

Esta función solo está disponible desde v1.0.0 en adelante

info

Sigue el siguiente enlace para ver la referencia de los países y tipos de documentos aceptados 👉🏻 Documentos y paises

import { AucoSDK } from 'auco-sdk-integration';

const unsubscribe = AucoSDK({
  iframeId: 'iframeId',
  sdkType: 'upload',
  language: 'es', // Lenguajes aceptados 'es' | 'en'
  keyPublic: 'prk_xxxxx', // Llave privada de la compañía necesaria para la creación del proceso
  events: {
    onSDKReady,
    onSDKClose,
    onSDKToken,
  },
  sdkData: {
    userAttributes: {
      email: 'admin@company.com', // Email de usuario registrado en Auco, se recomienda usar el correo del admin de la compañía
    },
    flowData: {
      type: 'complete',
      files: [file1, file2], // Array de documentos a cargar (tipo File), Auco se encargará de unirlos en un solo PDF
      emailData: {
        name: 'Flujo precargado',
        message: 'Mensaje',
        subject: 'Sujeto',
        expire: new Date(), // (opcional) Fecha de expiración del flujo
        remember: '48', // (opcional) Cada cuantas horas se enviará recordatorio
        notificationOff: true, // Auco no le enviará correos a los participantes
      },
      platform: 'whatsapp', // Plataforma donde se harán los procesos de firma ('auco' | 'whatsapp')
      validations: {
        otpCode: 'phone', // (opcional) Medio por donde se enviará OTP  ('phone' | 'email')
        flow: false, // Validación de identidad guiada
        identification: true, // Validación de documento de identidad
        identificationCardBack: true, // Validación de documento de identidad trasero
        selfie: true, // Validación con foto del rostro
      },
      participants: [
        {
          id: 'id_1',
          type: 'signer',
          name: 'Firmante',
          email: 'firmante@auco.ai',
          phone: '+573151234567',
          country: 'CO',
          identificationType: 'CC',
          identification: '1234',
        },
        {
          id: 'id_2',
          type: 'approver',
          name: 'Aprobador',
          email: 'aprobador@auco.ai',
          phone: '+573151234567',
          country: 'CO',
          identificationType: 'CC',
          identification: '1234',
        },
        {
          id: 'id_3',
          type: 'reader',
          email: 'lector@auco.ai',
          name: 'Lector',
        },
      ],
    },
    uxOptions: {
      primaryColor: '#021c30',
      alternateColor: '#a557f2',
    },
  },
  env: 'DEV',
});