Pular para o conteúdo principal

Envio de documentos para assinatura

O recurso Envio de documentos para assinatura permite integrar, por meio do SDK, o envio seguro de documentos que precisam ser assinados eletronicamente.

Exemplos de integração​

aviso

Para a integração, é necessário ter um elemento <iframe id='iframeId'> onde o SDK será renderizado, e a função AucoSDK deve receber o ID desse elemento.

info

Siga o link para ver a referência dos eventos necessários para a integração do SDK: 👉🏻 Eventos

Integração básica​

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

const unsubscribe = AucoSDK({
  iframeId: 'iframeId',
  sdkType: 'upload',
  language: 'es', // Idiomas aceitos 'es' | 'en'
  keyPublic: 'prk_xxxxx', // Chave privada da empresa necessária para criar o processo
  events: {
    onSDKReady,
    onSDKClose,
    onSDKToken,
  },
  sdkData: {
    userAttributes: {
      email: 'admin@company.com', // E-mail do usuário cadastrado na Auco, recomenda-se usar o e-mail do administrador da empresa
    },
    uxOptions: {
      primaryColor: '#021c30',
      alternateColor: '#a557f2',
    },
  },
  env: process.env.PUBLIC_ENVIRONMENT == 'dev' ? 'DEV' : 'PROD',
});

Integração com dados personalizados​

O atributo custom permite enviar, dentro de sdkData, um objeto com informações personalizadas adicionais. Esse objeto é armazenado no banco de dados associado ao processo e incluído no payload do webhook, se configurado.

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

const unsubscribe = AucoSDK({
  iframeId: 'iframeId',
  sdkType: 'upload',
  language: 'es', // Idiomas aceitos 'es' | 'en'
  keyPublic: 'prk_xxxxx', // Chave privada da empresa necessária para criar o processo
  events: {
    onSDKReady,
    onSDKClose,
    onSDKToken,
  },
  sdkData: {
    userAttributes: {
      email: 'admin@company.com', // E-mail do usuário cadastrado na Auco, recomenda-se usar o e-mail do administrador da empresa
    },
    custom: {
      // (opcional) Objeto com dados personalizados, salvo no banco de dados e enviado via webhook
      internalId: 'ORD-12345',
      department: 'legal',
      priority: 'high',
    },
    uxOptions: {
      primaryColor: '#021c30',
      alternateColor: '#a557f2',
    },
  },
  env: process.env.PUBLIC_ENVIRONMENT == 'dev' ? 'DEV' : 'PROD',
});

Integração com signatários pré-carregados (STABLE)​

perigo

Este método será descontinuado no futuro; recomenda-se usar o método detalhado no próximo item.

info

Siga o link para ver a referência dos países e tipos de documento aceitos 👉🏻 Documentos e países

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

const unsubscribe = AucoSDK({
  iframeId: 'iframeId',
  sdkType: 'upload',
  language: 'es', // Idiomas aceitos 'es' | 'en'
  keyPublic: 'prk_xxxxx', // Chave privada da empresa necessária para a criação do processo
  events: {
    onSDKReady,
    onSDKClose,
    onSDKToken,
  },
  sdkData: {
    userAttributes: {
      email: 'admin@company.com', // E-mail do usuário cadastrado na Auco, recomenda-se usar o e-mail do administrador da empresa
    },
    users: [
      {
        name: 'Signer';
        email: 'signer@auco.ai';
        phone: '+573151234567';
        country: 'CO';
        id: '1234567890';
        idType: 'CC';
      }
    ],
    uxOptions: {
      primaryColor: '#021c30',
      alternateColor: '#a557f2',
    },
  },
  env: process.env.PUBLIC_ENVIRONMENT == 'dev' ? 'DEV' : 'PROD',
});

Integração com signatários pré-carregados​

aviso

Este recurso só está disponível a partir da versão v1.0.0.

info

Siga o link para ver a referência dos países e tipos de documento aceitos 👉🏻 Documentos e países

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

const unsubscribe = AucoSDK({
  iframeId: 'iframeId',
  sdkType: 'upload',
  language: 'es', // Idiomas aceitos 'es' | 'en'
  keyPublic: 'prk_xxxxx', // Chave privada da empresa necessária para criar o processo
  events: {
    onSDKReady,
    onSDKClose,
    onSDKToken,
  },
  sdkData: {
    userAttributes: {
      email: 'admin@company.com', // E-mail do usuário cadastrado na Auco, recomenda-se usar o e-mail do administrador da empresa
    },
    flowData: {
      type: 'participants',
      participants: [
        {
          id: 'id1',
          type: 'signer',
          name: 'Signer',
          email: 'signer@auco.ai',
          phone: '+573161979572',
          country: 'CO',
          identification: '123',
          identificationType: 'CC',
          locked: true, // Este participante não pode ser editado nem excluído.
          disableAutoSign: true, // (opcional) Desativa a assinatura automática para este participante
        },
        {
          id: 'id2',
          type: 'approver',
          name: 'Approver',
          email: 'approver@auco.ai',
          phone: '+573161979572',
          country: 'CO',
          identification: '1234',
          identificationType: 'CC',
        },
        {
          id: 'id3',
          type: 'reader',
          name: 'Reader',
          email: 'reader@auco.ai',
          locked: true, // Este participante não pode ser editado nem excluído.
        },
      ],
    },
    uxOptions: {
      primaryColor: '#021c30',
      alternateColor: '#a557f2',
    },
  },
  env: 'DEV',
});

Integração com fluxo pré-preenchido​

Neste tipo de integração, ao abrir o SDK, o usuário só precisa posicionar as assinaturas.

aviso

Este recurso só está disponível a partir da versão v1.0.0.

info

Siga o link para ver a referência dos países e tipos de documento aceitos 👉🏻 Documentos e países

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

const unsubscribe = AucoSDK({
  iframeId: 'iframeId',
  sdkType: 'upload',
  language: 'es', // Idiomas aceitos 'es' | 'en'
  keyPublic: 'prk_xxxxx', // Chave privada da empresa necessária para a criação do processo
  events: {
    onSDKReady,
    onSDKClose,
    onSDKToken,
  },
  sdkData: {
    userAttributes: {
      email: 'admin@company.com', // E-mail do usuário cadastrado na Auco, recomenda-se usar o e-mail do administrador da empresa
    },
    flowData: {
      type: 'complete',
      files: [file1, file2], // Array de documentos a enviar (tipo File), a Auco os unirá em um único PDF
      emailData: {
        name: 'Flujo precargado',
        message: 'Mensaje',
        subject: 'Sujeto',
        expire: new Date(), // (opcional) Data de expiração do fluxo
        remember: '48', // (opcional) De quantas em quantas horas um lembrete será enviado
        notificationOff: true, // A Auco não enviará e-mails aos participantes.
      },
      platform: 'whatsapp', // Plataforma em que os processos de assinatura serão realizados ('auco' | 'whatsapp')
      validations: {
        otpCode: 'phone', // (opcional) Meio pelo qual o OTP será enviado ('phone' | 'email')
        identification: true, // Validação do documento de identidade
        identificationCardBack: true, // Validação do verso do documento de identidade
        selfie: true, // Validação com foto do rosto
      },
      participants: [
        {
          id: 'id_1',
          type: 'signer',
          name: 'Signer',
          email: 'signer@auco.ai',
          phone: '+573151234567',
          country: 'CO',
          identificationType: 'CC',
          identification: '1234',
          disableAutoSign: true, // (opcional) Desativa a assinatura automática para este participante
        },
        {
          id: 'id_2',
          type: 'approver',
          name: 'Approver',
          email: 'approver@auco.ai',
          phone: '+573151234567',
          country: 'CO',
          identificationType: 'CC',
          identification: '1234',
        },
        {
          id: 'id_3',
          type: 'reader',
          email: 'reader@auco.ai',
          name: 'Reader',
        },
      ],
    },
    uxOptions: {
      primaryColor: '#021c30',
      alternateColor: '#a557f2',
    },
  },
  env: 'DEV',
});

Integração de edição básica​

Neste tipo de integração, você pode editar um documento que ainda não foi assinado; as informações do documento original serão preenchidas automaticamente.

aviso

Este recurso só está disponível a partir da versão v1.0.3.

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

const unsubscribe = AucoSDK({
  iframeId: 'iframeId',
  sdkType: 'upload',
  language: 'es', // Idiomas aceitos: 'es' | 'en'
  keyPublic: 'prk_xxxxx', // Chave privada da empresa necessária para a criação do processo
  events: {
    onSDKReady,
    onSDKClose,
    onSDKToken,
  },
  sdkData: {
    userAttributes: {
      email: 'admin@company.com', // E-mail do usuário cadastrado na Auco. Recomenda-se usar o e-mail do administrador da empresa
    },
    flowData: {
      type: 'edit',
      code: 'CODEDOCUM',
      keepPositions: true, // Opcional - Mantém as posições das assinaturas do documento original
    },
    uxOptions: {
      primaryColor: '#021c30',
      alternateColor: '#a557f2',
    },
  },
  env: 'DEV',
});

Integração de edição com sobrescrita​

Neste tipo de integração, você pode editar um documento que ainda não foi assinado e sobrescrever, na integração, as informações do documento original.

aviso

Este recurso só está disponível a partir da versão v1.0.3.

info

Se a integração sobrescrever todas as informações do documento original (files, emailData, platform, validations e participants), ao abrir o SDK o usuário só precisará posicionar as assinaturas.

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

const unsubscribe = AucoSDK({
  iframeId: 'iframeId',
  sdkType: 'upload',
  language: 'es', // Idiomas aceitos 'es' | 'en'
  keyPublic: 'prk_xxxxx', // Chave privada da empresa necessária para a criação do processo
  events: {
    onSDKReady,
    onSDKClose,
    onSDKToken,
  },
  sdkData: {
    userAttributes: {
      email: 'admin@company.com', // E-mail do usuário cadastrado na Auco. Recomenda-se usar o e-mail do administrador da empresa
    },
    flowData: {
      type: 'edit',
      code: 'CODEDOCUM',
      files: [file1], // Opcional - Array de documentos (tipo File) a enviar
      emailData: {...}, // Opcional - Configuração de e-mails e/ou lembretes
      platform: 'whatsapp', // Opcional - Plataforma em que a assinatura será realizada ('auco' | 'whatsapp')
      validations: {...}, // Opcional - Validações
      participants: [...], // Opcional - Lista de participantes para sobrescrever os originais
      keepPositions: true, // Opcional - Mantém as posições das assinaturas do documento original
    },
    uxOptions: {
      primaryColor: '#021c30',
      alternateColor: '#a557f2',
    },
  },
  env: 'DEV',
});