Métodos de envio do envelope e documentos de identificação aceitos

Este artigo explica os métodos de envio de envelopes e códigos de autenticação no processo de assinatura eletrônica, bem como os tipos de documentos de identificação aceitos

🛠️ Fluxos de Integração

Integração via LaaS

Quando a integração é realizada pelo time LaaS, o cliente deve alinhar com nossa equipe os métodos de envio desejados para:

• Link de assinatura do envelope: Enviado por SMS, e-mail ou WhatsApp.

• Código de autenticação: Um código enviado durante a assinatura para verificar o e-mail ou telefone do signatário, também por SMS, e-mail ou WhatsApp.

O cliente deve especificar as preferências de envio durante o planejamento com o time LaaS. Além disso, para habilitar tipos de documentos de identificação específicos, o cliente deve solicitar ao time LaaS a liberação dos documentos desejados (veja a seção "Documentos Aceitos").

Integração Gerenciada pelo Cliente

Na integração gerenciada pelo cliente, o método de envio é definido diretamente na criação do envelope via API, utilizando os campos document_submission_method (para o link de assinatura) e authentication_submission_method (para o código de autenticação). Os métodos disponíveis são SMS, e-mail e WhatsApp.

Exemplo de chamada API para criar um envelope com métodos de envio definidos:

curl -X POST \
  https://api.sign.qitech.com.br/sign/envelope \
  -H 'Content-Type: application/json' \
  -H "Authorization: EXAMPLE_API_KEY" \
  -d '{
    "id": "814e7ed3-4080-4cae-a853-8e12812817ea",
    "subject": "CCB QiTech",
    "expiration_date": "2023-09-20",
    "signers": [
      {
        "id": "1",
        "name": "John Sample",
        "email": "johnsample@test.com",
        "birthdate": "1992-09-15",
        "document_number": "111.111.111-11",
        "phone": {
          "international_dial_code": "55",
          "area_code": "11",
          "number": "988878722"
        },
        "document_submission_method": "email",
        "authentication_submission_method": "sms"
      }
    ]
  }'

Para habilitar tipos de documentos de identificação, o cliente deve solicitar a liberação ao time de Risk Solutions da QI Tech (veja a seção "Documentos Aceitos").

📇 Documentos de Identificação Aceitos

Os tipos de documentos de identificação aceitos para o fluxo de formalização são:

• cnh_digital (formato PDF)

• cnh (frente e verso)

• rg (frente e verso)

• rne (frente e verso)

• ctps (frente e verso)

• passport (frente e verso)

• crnm (frente e verso)

Para utilizar esses documentos, o cliente deve solicitar a habilitação:

• Integração via LaaS: Contate o time LaaS.

• Integração pelo cliente: Contate o time de Risk Solutions.

A habilitação dos documentos permite que sejam utilizados na etapa de formalização, onde o signatário envia seu documento de identificação.

🗃️ Personalização de Documentos e Etapas (Integração pelo Cliente)

Quando o cliente gerencia a integração, é possível personalizar os tipos de documentos aceitos e as etapas de assinatura para cada envelope, utilizando o objeto signature_settings na criação do envelope. Este objeto é incluído na raiz do JSON da chamada API e define as configurações do fluxo de assinatura.

Estrutura do signature_settings

O objeto signature_settings contém, entre outros, o campo steps, que lista as etapas do processo de assinatura e suas configurações. A etapa personal_document permite especificar quais tipos de documentos são aceitos, usando o campo document_templates. Exemplo de configuração:

{
  "signature_settings": {
    "steps": [
      {
        "step": "personal_document",
        "settings": {
          "document_templates": ["cnh_digital", "rg", "passport"],
          "send_webhook_notification": true
        }
      },
      {
        "step": "authentication_code",
        "settings": {
          "allow_update_authentication_data": true,
          "send_webhook_notification": true
        }
      }
    ],
    "geo_location_required": false,
    "require_personal_document_before_signature": true
  }
}

🚥 Etapas Disponíveis

As etapas que podem ser configuradas no steps incluem:

• device_scan: Escaneamento do dispositivo.

• document_display: Exibição do documento.

• resume_operation: Resumo da operação.

• resume_insurance: Resumo do seguro.

• term_of_authorization: Termo de autorização.

• fraud_warning: Aviso de fraude.

• authentication_code: Código de autenticação.

• terms_of_use: Termos de uso.

• personal_document: Envio de documento de identificação.

• additional_document: Envio de documento adicional.

• face_recognition: Reconhecimento facial.

• enrich_personal_data: Enriquecimento de dados pessoais.

Cada etapa pode incluir configurações específicas, como document_templates para limitar os tipos de documentos aceitos ou send_webhook_notification para ativar notificações.

💬 Considerações Finais