Central de Ajuda

Leitura de 20 min

IXC Assina v2 - Configuração da Integração com o IXC Provedor

Introdução

Definição - IXC Assina v2

O IXC Assina v2 é uma solução aprimorada de assinatura eletrônica integrada ao Sistema IXC, desenvolvida para provedores de internet. A ferramenta permite a formalização de contratos e termos de forma digital e segura, incluindo novos recursos, como reconhecimento facial para validação do contratante e coleta estruturada das informações necessárias ao processo.

O IXC Assina v2 é uma solução de assinatura digital integrada ao sistema IXC Provedor, desenvolvida para a formalização digital de documentos. A ferramenta possibilita que termos, contratos e outros documentos que exijam assinatura sejam gerados, enviados e assinados de forma segura e remota, garantindo validade jurídica e coleta estruturada de informações.

Acesso ao Formulário

Caminho: Configurações > Integrações > Integrações Assinatura Digital

Benefícios

  • Selfie com detecção facial: detecta se há uma face no ato da assinatura de um documento
  • Selfie e foto de documento com validação de identidade: compara a seflie com a foto do documento e valida se é a mesma pessoa que está realizando a assinatura. Além disso, compara o nome, CPF do Signatário com os dados no documento
  • Registros complementares: IP, geolocalização, dispositivo, entre outros
  • Utilização via API (IXC Provedor/IXC Oner) ou pela própria plataforma
  • Prestação de suporte seguro (registros de atividades, permissões e tempo de sessão)
  • Espaço do Signatário (acesso ao histórico de documentos)
  • Custo-benefício com mais funcionalidades disponíveis

Requisitos de Uso

Módulo

Para utilizar o IXC Assina, é necessário realizar a contratação do produto diretamente com o departamento Comercial. Após essa etapa o cliente será direcionado ao setor Financeiro, departamento responsável pela liberação do módulo.

Operacional

Para utilizar esta funcionalidade, é necessário atender as seguintes condições:

  • Ser um cliente Opa! Suite: Para enviar documentos para assinatura por WhatsApp, é necessário utilizar a integração Omnichannel disponível para clientes Opa! Suite;
  • Conta de E-mail SMTP: Para enviar documentos para assinatura digital por e-mail, é necessário ter uma integração de E-mail SMTP no sistema.

Cadastro do Cliente

Campos necessários no cadastro do cliente:

  • Razão social/Nome:* Obrigatório para a criação e envio do documento;
  • CPF/CNPJ:* Obrigatório para a criação e envio do documento;
  • E-mail: Necessário para receber o link de assinatura quando o envio for configurado via E-mail SMTP. Caso o cliente possua mais de um e-mail cadastrado, o link será enviado apenas para o primeiro e-mail registrado;
  • Telefone Celular: Necessário para receber o link de assinatura caso a opção de envio seja Integração Omnichannel - Opa! Suite
  • Modelo de contrato/termo: É necessário configurar previamente um Modelo de Contrato do Cliente personalizado para cada tipo de contrato, de acordo com a necessidade da empresa. Este documento será enviado ao cliente no momento da geração e envio do link de assinatura digital, portanto deve ser configurado antes do envio. Os mesmos critérios se aplicam ao uso de termos, quando utilizados pelo provedor.

Cadastro da Testemunha Cliente

A testemunha de um cliente deve ser um Contato e os seguintes campos são obrigatórios no formulário:

  • Razão social/Nome:* Obrigatório para a criação e envio do documento;
  • CPF/CNPJ:* Obrigatório para a criação e envio do documento;

Cadastro do Colaborador

Este formulário contempla o Responsável Provedor e a Testemunha Provedor. Os campos obrigatórios são:

  • Razão social/Nome:* Obrigatório para a criação e envio do documento;
  • CPF/CNPJ:* Obrigatório para a criação e envio do documento;
  • E-mail e Número de telefone:* Necessários para que seja possível validar as informações de cadastro do responsável na plataforma através do token de responsável ou testemunha;

Visão Geral dos Processos da Integração

A integração da plataforma IXC Assina está estruturada nos seguintes processos:

  1. Contratação do serviço através do contato com o Departamento Comercial - IXC Soft
  2. Parametrização do Modelo de Contrato e inserção de Variáveis de Modelo de Contrato conforme necessário. Certifique-se de concluir essa configuração antes de realizar a integração de assinatura digital
  3. Contato com o suporte de Integrações Gerais para a implantação da integração no IXC Provedor/IXC Oner
  4. Configuração da integração no sistema
  5. Parametrização do envio de assinatura
  6. Parametrização de métodos de ativação do contrato

Atenção: Cobrança por Pacote

O valor do pacote contratado é cobrado integralmente, independentemente da quantidade emitida ou assinada. Caso a quantidade de documentos ultrapasse o limite do plano, será cobrado o valor de excedente por cada documento adicional.

Parametrização e Usabilidade da Integração

Passo 1: Configuração da Integração

A configuração da integração do serviço IXC Assina no sistema consiste, inicialmente, no cadastro do Token integração, informação disponível na plataforma IXC Assina. Este processo promove a comunicação entre as plataformas, permitindo a geração e envio de links de assinatura, bem como a ativação de contratos através do sistema. Siga os passos abaixo para prosseguir:

  1. Acesse o formulário Integrações de Assinatura Digital através do caminho: Configurações > Integrações > Integrações de Assinatura Digital
  2. Clique no botão Novo para iniciar o cadastro
  3. Na aba Integração, preencha os campos:
    • Integrador: Selecione a opção IXC Assina v2
    • Descrição: Insira uma breve descrição da integração para identificação
    • Ambiente: Defina se o ambiente virtual utilizado é de produção (ambiente real utilizado operacionalmente) ou homologação (ambiente de testes e simulações)
    • Token integração: insira o Token de integração gerado na plataforma
  4. Acesse a aba Configurações e preencha os campos de acordo com as seções Parâmetros e Assinaturas:
    • Método de envio de link de assinatura digital: Defina a origem da criação do documento, se ocorrerá através do contrato do cliente ou se através da abertura de ordem de serviço
    • Documento de identidade: Defina se a foto do documento de identidade será um item obrigatório no ato da assinatura
    • Selfie: Defina se a foto de identificação (selfie) será um item obrigatório no ato da assinatura

Dica:

Os itens requeridos para a assinatura definidas nesta etapa são definidos como padrão para todos os contratos, mas também é possível definir em cada contrato, de forma individual, sobre como o cliente final irá assinar. Para isso, acesse: menu Sistema > Contrato > Selecione o contrato > Aba Avalista/assinatura digital.

Método de envio:

  • Contrato: se o método de envio escolhido for Contrato, o link de assinatura será gerado assim que o contrato for criado e salvo.

  • Ordem de Serviço/Processo: se o método de envio escolhido for Ordem de Serviço, o link de assinatura é gerado automaticamente ao salvar uma O.S. com o assunto em que o parâmetro Integração assinatura digital como Sim. Para mais detalhes, acesse a documentação: Assinatura digital pela Ordem de Serviço

  1. Na seção Assinaturas, preencha os campos:
    • Responsável provedor: Indica o Signatário do provedor (representante legal pela empresa). Clique na lupa e selecione o cadastro de colaborador responsável pela assinatura da empresa
    • Token usuário API Responsável: Configuração de token do representante legal. Insira o token coletado na plataforma
    • Testemunha provedor: Configuração opcional. Ao utilizar esta função, defina um Claborador como testemunha da assinatura do provedor
    • Token usuário API testemunha: Se o parâmetro anterior estiver configurado, insira o Token disponibilizado pela plataforma
  2. Na aba Notificações, defina o método de envio do link de assinatura digital de acordo com as seções Notificações de e-mails e Notificações omnichannel:
    • E-mail marketing: Corresponde a mensagem de e-mail configurada para o envio do link de assinatura ao cliente. Ao utilizar este método, vincule uma mensagem de e-mail cadastrada para este fim. Caso o cliente possua mais de um e-mail cadastrado, o link será enviado apenas para o primeiro e-mail registrado
    • E-mail marketing para assinatura da testemunha do cliente: Corresponde a mensagem de e-mail configurada para o envio do documento à testemunha do cliente. Ao utilizar este método, vincule uma mensagem de e-mail cadastrada para este fim
    • Mensagem omnichannel para assinatura do cliente: Corresponde ao template de Mensagem Omnichannel (Opa! Suite) para Assinatura Digital que será enviado ao cliente via WhatsApp. Ao utilizar este método, vincule uma mensagem de e-mail cadastrada para este fim
    • Mensagem omnichannel para assinatura da testemunha do cliente: Corresponde ao template de Mensagem Omnichannel (Opa! Suite) para Assinatura Digital que será enviado à testemunha do cliente via WhatsApp. Ao utilizar este método, vincule uma mensagem de e-mail cadastrada para este fim
  3. Após definir as configurações da integração, clique em Salvar para concluir o cadastro da integração
  4. Acesse o formulário Filial através do caminho: Configurações > Empresa > Filiais > selecione a filial que deseja configurar > Editar > aba Integrações para relacionar a integração à filial
  5. No campo Integração assinatura digital da aba Integrações, selecione a integração de assinatura digital cadastrada
  6. Clique em Salvar para validar as modificações

Multifilial

Para cada filial, é possível criar uma nova integração utilizando os mesmos dados e vinculá-la à unidade correspondente, garantindo operação independente e sem duplicidade de cadastros. Para isso, basta repetir o processo de configuração para a nova integração e associá-la à filial desejada.

Passo 2: Parametrização de Geração de Documento

2.1 Parametrização Geral

A parametrização geral consiste em uma configuração padrão que contempla todos os contratos do sistema, que implica na geração do documento para todos os contratos criados. Para realizar a parametrização geral, siga as etapas abaixo:

  1. Acesse o menu **Configurações > Parâmetros > Parâmetros gerais
  2. Siga ate a aba Contratos
  3. Em seguida, siga até a seção Assinatura digital, marque o parâmetro Assinatura Digital dos contratos como Sim. Esta ação habilitará os demais campos necessários para a configuração
  4. No campo Utilizar integração digital, marque Sim. Desta forma, todos os contratos terão a geração do link de assinatura digital. Se marcado como Não, todos os contratos serão criados com o padrão Não e o link do documento não será gerado automaticamente. Para o segundo cenário, é possível definir em cada contrato se deseja utilizar a integração para que o link seja gerado individualmente (confira no tópico 2.2)
  5. Clique em Salvar para validar as modificações

2.2 Parametrização Individual Através do Contrato do Cliente e Ativação Automática

Além da parametrização geral da integração, no contrato do cliente também será possível escolher se um contrato específico utilizará a assinatura pelo IXC Assina ou não, selecionando a opção desejada em Utilizar integração assinatura digital. Para isto, siga as etapas a seguir:

  1. Acesse menu Sistema e depois Cadastros
  2. Selecione a opção Contratos
  3. Selecione o contrato que será editado e clique no botão Editar
  4. Em seguida, na aba Contrato, no campo Utilizar integração assinatura digital, marque Sim para permitir a geração do link de assinatura para este contrato. Se marcar não, não será gerado o documento através da integração

Hierarquia de Parâmetros

Considerando a existência de parâmetros gerais e parâmetros específicos, é aplicada uma hierarquia e ordem de prioridade para os parâmetros, a fim de garantir que as operações ocorram com sucesso, evitando conflitos.

Portanto, para esta integração, as configurações específicas de um contrato têm prioridade sobre as configurações gerais do sistema. Ou seja, o parâmetro do contrato é mais importante do que o parâmetro geral.

Por isso, mesmo que a configuração geral esteja marcada como “não”, dentro de um contrato específico ela pode ser alterada para “sim”, se for o caso.

  1. Defina se o contrato será ativado automaticamente no ato da assinatura ou através da execução de um processo através do campo Ativar automaticamente o contrato. Selecione uma das opções:
    • No ato da assinatura: Se esta opção estiver marcada, assim que a assinatura do cliente for identificada, o contrato é automaticamente ativado
    • Não ativar: Se esta opção estiver marcada, mesmo com a assinatura do cliente identificada, o contrato não é automaticamente ativado. Neste cenário, é necessário realizar a ativação do contrato através de um processo.

Para mais informações, acesse:

Casos de Uso

Criação do Documento

O sistema permite a criação de um documento de três formas principais:

Envio de documentos de contrato com e sem termos

  • Contrato sem termo: Para contratos de cliente que não utilizam o documento de termo, o sistema irá gerar o link de assinatura digital de forma automática, contendo o documento único de modelo de contrato, assim que o contrato for salvo (botão Salvar).
  • Contrato com termo: Para contratos de cliente que utilizam termos atrelados ao modelo de contrato, o sistema irá gerar um único link de assinatura digital de forma automática, contendo todos os documentos (modelo de contrato e termos), assim que o contrato for salvo (botão Salvar).

::: details Criação Automática do Documento pelo Contrato Para esta ação ocorrer, é necessário atender os seguintes requisitos:

  • O parâmetro de Método para envio do link de assinatura digital igual à Contrato;
  • O parâmetro Utilizar integração assinatura digital no contrato deve estar igual à sim ou então padrão. Se igual à padrão, o parâmetro geral deve estar igual à Sim;
  • A filial atribuída ao contrato deve ter uma integração atrelada (aba Integrações no cadastro da Filial.
  1. Acesse o formulário Contratos através do caminho menu Sistema > Cadastros > Contratos
  2. Clique em Novo para iniciar o cadastro de um novo contrato
  3. Selecione o cliente para o qual o contrato será criado
  4. Preencha os campos obrigatórios nas abas Contrato e Faturamento
  5. Se o parâmetro Utilizar integração assinatura digital no contrato estiver definido como Padrão, verifique se o parâmetro geral com o mesmo nome está configurado como Sim. Caso o parâmetro geral não esteja habilitado, ajuste diretamente no contrato, selecionando a opção Sim
  6. Após preencher todos os campos, clique em Salvar. O sistema gerará um link com o(s) documento(s) para assinatura digital e enviará esse link ao cliente, de acordo com a forma de envio definida na parametrização da integração :::

::: details Criação Manual de um Documento pelo Contrato Para esta ação ocorrer, é necessário atender os seguintes requisitos:

  • O parâmetro Utilizar integração assinatura digital no contrato deve estar igual à sim ou então padrão. Se igual à padrão, o parâmetro geral deve estar igual à Sim;
  • A filial atribuída ao contrato deve ter uma integração atrelada (aba Integrações no cadastro da Filial;
  • O contrato deve estar com o status de acesso igual a Aguardando assinatura.
  1. Acesse o formulário de Contrato do Cliente através do caminho: Sistema > Cadastros > Contrato
  2. Selecione um contrato do qual deseja realizar a geração de um novo documento/link de assinatura digital e clique em Editar
  3. Após editar o contrato, altere o status do contrato para Aguardando assinatura, para que o sistema permita uma nova ativação do contrato a partir da nova assinatura. Para isso, clique sobre o botão Status acesso e em seguida, na opção de Aguardando assinatura
  4. Clique no botão Assinatura digital. Em seguida, clique em Gerar novo documento de assinatura digital
  5. O sistema irá retornar um pop-up para a confirmação da ação, clique em Ok para confirmar a geração do link
  6. O link será gerado e ficará disponível para conferência na aba Histórico de Assinaturas Digitais. Além disso, o sistema enviará o link ao cliente conforme a forma de envio definida na parametrização da integração :::

::: details Criação do Documento via Processo/Ordem de Serviço Para esta ação ocorrer, é necessário atender os seguintes requisitos:

  • O parâmetro de Método para envio do link de assinatura digital igual à Ordem de Serviço;
  • O parâmetro Utilizar integração assinatura digital no contrato deve estar igual à sim ou então padrão. Se igual à padrão, o parâmetro geral deve estar igual à Sim;
  • A filial atribuída ao contrato deve ter uma integração atrelada (aba Integrações no cadastro da Filial;
  • O Assunto da Ordem de Serviço deve possuir o parâmetro Integração assinatura digital igual à sim;
  • O contrato deve estar com o status de acesso igual a Aguardando assinatura.

Configuração do Processo

Para realizar a parametrização do assunto e processo da ordem de serviço, acesse: Assinatura Digital Pela Ordem de Serviço.

1. Abertura Manual de O.S. de Assinatura

A criação manual de O.S. permite a geração do link de assinatura digital diretamente pelo contrato do cliente:

  1. Com a parametrização do assunto concluída, acesse o contrato do cliente através do caminho menu Sistema > Cadastros > Contratos
  2. Selecione o contrato do cliente e clique em Editar
  3. Acesse a aba O.S. e clique no botão Novo
  4. Preencha os campos:
    • Assunto: Clique na lupa e selecione o assunto que utiliza a integração de assinatura digital;**
    • Origem do endereço: Ajuste a origem do endereço, se necessário;
    • Prioridade: Ajuste a prioridade, se necessário;
    • Setor: Clique na lupa e selecione o setor responsável pela O.S.
  5. Clique em Salvar para concluir o cadastro da O.S. O documento será gerado e a Ordem se Serviço constará relacionada ao contrato do cliente e assim que o contrato for assinado, será finalizada automaticamente.

2. Abertura Manual de Atendimento de Assinatura

Esta funcionalidade exige a configuração de um processo relacionado ao contrato do cliente.

  1. Com a parametrização do processo concluída, acesse o contrato do cliente e siga até a aba Atendimentos;
  2. Clique no botão Novo e preencha os campos:
    • Assunto: Clique na lupa e selecione o assunto correspondente à abertura do atendimento;
    • Processo: Clique na lupa e selecione o processo criado para a assinatura digital;
    • Descrição: Insira uma breve descrição relacionada ao atendimento;
  3. Clique em Salvar para concluir o cadastro do Atendimento. O Processo será ativado e o documento gerado automaticamente. Além disso, a Ordem se Serviço constará relacionada ao contrato do cliente e assim que o contrato for assinado, será finalizada automaticamente. :::

::: details Criação do Documento de Termo Avulso Para esta ação ocorrer, é necessário atender os seguintes requisitos:

  • O parâmetro Utilizar integração assinatura digital no contrato deve estar igual à sim ou então padrão. Se igual à padrão, o parâmetro geral deve estar igual à Sim;
  • A filial atribuída ao contrato deve ter uma integração atrelada (aba Integrações no cadastro da Filial;
  • Deve existir um modelo de termo previamente configurado.
  1. Acesse o contrato do cliente através do caminho menu Sistema > Cadastros > Contratos
  2. Siga até a aba Termos e clique em Novo
  3. No campo Termo, clique na lupa, selecione o termo do qual deseja que o cliente assine e vincule-o ao campo
  4. No parâmetro Assinado, marque a opção Não
  5. Clique em Salvar para relacionar o termo ao contrato. O termo será enviado ao cliente conforme a parametrização definida no cadastro da integração. Para conferir o link gerado, acesse a aba Histórico de Assinaturas Digitais no contrato do cliente. Na grid, o registro aparecerá como tipo de documento Termo, e o status será atualizado de acordo com o andamento da assinatura. Além disso, o sistema enviará o link ao cliente conforme a forma de envio definida na parametrização da integração :::

Resumo do Pacote

Você pode acompanhar o consumo do seu pacote contratado diretamente no sistema. Nele, é possível verificar quantos documentos estão disponíveis no plano e quantos já foram utilizados dentro do período de um mês. Para acessar o resumo, siga este passo a passo:

  1. Vá até o menu Configurações > Integrações > Integrações de Assinatura Digital
  2. Encontre a integração IXC Assina v2 e clique em Editar
  3. Clique no botão Resumo do Pacote, localizado ao lado do botão Cancelar
  4. O sistema mostrará um relatório com:
    • O pacote contratado (quantidade de documentos)
    • O período de vigência
    • A quantidade de documentos já utilizados do limite do pacote

Parametrização da Testemunha do Cliente

No contrato do cliente, está disponível a Aba Avalista Assinatura Digital, onde é possível definir a testemunha de assinatura digital, que é a testemunha do cliente. Para Lead/Contatos do cliente (necessário inserir número de telefone ou e-mail).

Também é possível definir se será solicitado Selfie e Documento de identidade no momento da assinatura.

Documento de identidade: define se a foto do documento será um item obrigatório no ato da assinatura para este contrato

  • Sim/Não: Define se será necessário inserir foto de documento ao assinar;
  • Padrão: Define de acordo com o padrão do parâmetro da integração.
  • Selfie: define se a foto de identificação (selfie) será um item obrigatório no ato da assinatura para este contrato;
  • Sim/Não: Define se será necessário tirar Selfie ao assinar;
  • Padrão: Define de acordo com o padrão do parâmetro da integração.

Funcionalidades Principais

::: details Envio de Contratos para Assinatura O IXC Assina permite o envio de contratos para assinatura por WhatsApp, através da integração com o Opa! Suite, ou por e-mail. Essa flexibilidade facilita o processo de assinatura e se adapta às preferências do cliente.
:::

::: details Acompanhamento dos Documentos Gerados por Cliente No contrato, a aba Histórico de Assinaturas Digitais reúne todos os documentos emitidos para assinatura, apresentando o status de cada registro, a data da assinatura, bem como o ID do contrato e da integração. Já na aba Informações Adicionais, é possível visualizar detalhes como os Signatários, o e-mail utilizado para o envio do link, o CPF, o status individual de cada assinatura e a URL de acesso ao documento.

Além disso, o acompanhamento completo de todos os documentos pode ser realizado pelos Logs de assinatura digital, que exibem os registros de forma consolidada e abrangente. :::

::: details Acompanhamento do Consumo do Pacote O sistema permite acompanhar o consumo mensal do pacote contratado, apresentando um resumo que inclui o total de documentos disponíveis no plano, o período de vigência e a quantidade de documentos já utilizados.
:::

::: details Sincronização Manual A sincronização manual permite atualizar informações de assinaturas já realizadas, mas que ainda não retornaram ao sistema. Esse recurso deve ser utilizado em documentos com status Pendente. Se o documento ainda não tiver sido assinado, será exibida a mensagem de pendência. O retorno das assinaturas ocorre de forma automática, e a sincronização manual deve ser usada apenas em casos de instabilidade da API. Para mais informações, acesse: Sincronizar Assinatura. :::

Fluxo de Trabalho

flowchart TD
    B[Contratação do serviço com o Departamento Comercial - IXC Soft] --> C[Contato com o Suporte Integrações Gerais]
    C --> D[Criar conta na plataforma IXC Assina v2]
    D --> E[Configuração da integração no IXC Provedor]
    E --> F[Configuração do Modelo de Contrato e Termos]
    F --> G[Inserção de Variáveis do Modelo de Contrato]
    G --> H[Parametrização de Geração de Documento - geral ou individual por contrato]
    H --> I[Parametrização do Método de Envio de Link - E-mail ou WhatsApp]
    I --> J[Configuração de métodos de ativação do contrato]
    J --> K[Envio do link de assinatura ao cliente]
    K --> L[Envio do link para testemunha - opcional]
    L --> M[Recebimento da assinatura digital]
    M --> N[Ativação do contrato]
    N --> O[Registro da assinatura no sistema]
    O --> P[Armazenamento do contrato assinado]

Considerações Finais

Com a integração do IXC Assina v2 ao IXC Provedor, toda a assinatura digital é gerenciada de forma centralizada, do envio até o registro do status e histórico dos documentos. Os principais benefícios incluem rastreabilidade total, controle do consumo do pacote, flexibilidade no envio e segurança reforçada. Esse processo otimizado torna a operação mais eficiente, reduz riscos de falhas e melhora significativamente a experiência do cliente em todas as etapas da assinatura digital.

Leia Também

Visão de gráfico

Páginas relacionadas