Modalidades

Métodos de Autenticação e Biometria por Provedor

O fluxo de assinatura é determinado pela combinação do provedor e do modo de autenticação.

Nota Restritiva:
A validação por biometria facial (FACIAL_BIOMETRICS ou LIVENESS) e os parâmetros de captura de imagem são exclusivos dos provedores CLICKSIGN e UNICO.


1. Provedores com Suporte a Biometria

CLICKSIGN

É o provedor com maior flexibilidade de métodos. Permite o uso de biometria facial e selfie junto com outros fatores de segurança.

  • Modos Biométricos:
    • FACIAL_BIOMETRICS
    • LIVENESS
    • SELFIE
  • Configurações Adicionais:
    • Suporta o uso completo dos campos em signature_collect_options para exigir fotos e validações específicas.

UNICO

Provedor especializado em fluxos biométricos e regulatórios.

  • Modos Biométricos:
    • DOC_SIGN: Assinatura biométrica padrão Unico
  • Configurações Adicionais:
    • Os campos de signature_collect_options definem se a selfie ou o documento serão processados pela inteligência da Unico.

2. Provedores Sem Suporte a Biometria

CELCOIN (Assinador Interno)

Utiliza a infraestrutura própria para gerar links de assinatura baseados em tokens internos.

  • Modo de Autenticação:
    • Deve ser definido como NONE
  • Comportamento:
    • Parâmetros de signature_collect_options (como require_selfie_validation) são ignorados, pois o fluxo interno não processa biometria facial externa nesta versão.

ZAPSIGN

Provedor para fluxos simplificados de assinatura eletrônica.

  • Modo de Autenticação:
    • Deve ser definido como NONE
  • Comportamento:
    • Embora a API aceite o envio dos campos em signature_collect_options, a integração atual com a ZapSign foca na assinatura eletrônica simples.
    • Validações de selfie ou foto de documento não são processadas como biometria facial neste provedor.

Resumo de Parâmetros de Captura (signature_collect_options)

Estes campos definem as exigências de imagem durante o fluxo de assinatura.

CampoDescriçãoAplicável em
require_self_photoExige foto do rosto (selfie) simplesCLICKSIGN, UNICO
require_document_photoExige foto do documento de identificaçãoCLICKSIGN, UNICO
require_selfie_validationAtiva a validação biométrica / liveness da selfieCLICKSIGN, UNICO

Nota:
Para ZAPSIGN e CELCOIN, recomenda-se enviar estes campos como false para evitar comportamentos inesperados, dado que esses provedores não realizam o processamento biométrico desses arquivos.


Exemplos de JSON por Provedor

CLICKSIGN — Biometria Facial com Selfie

{
  "signature_provider": "CLICKSIGN",
  "signature_collect_method": "EMAIL",
  "signature_authentication_options": {
    "mode": "FACIAL_BIOMETRICS"
  },
  "signature_collect_options": {
    "require_self_photo": true,
    "require_document_photo": true,
    "require_selfie_validation": true
  }
}

CLICKSIGN — Liveness com Envio por WhatsApp

{
  "signature_provider": "CLICKSIGN",
  "signature_collect_method": "WHATSAPP",
  "signature_authentication_options": {
    "mode": "LIVENESS"
  },
  "signature_collect_options": {
    "require_self_photo": true,
    "require_document_photo": false,
    "require_selfie_validation": true
  }
}

CLICKSIGN — Autenticação Simples sem Biometria

{
  "signature_provider": "CLICKSIGN",
  "signature_collect_method": "EMAIL",
  "signature_authentication_options": {
    "mode": "EMAIL"
  },
  "signature_collect_options": {
    "require_self_photo": false,
    "require_document_photo": false,
    "require_selfie_validation": false
  }
}

UNICO — Assinatura Biométrica

{
  "signature_provider": "UNICO",
  "signature_collect_method": "LINK",
  "signature_authentication_options": {
    "mode": "DOC_SIGN"
  },
  "signature_collect_options": {
    "require_self_photo": true,
    "require_document_photo": true,
    "require_selfie_validation": true
  }
}

ZAPSIGN — Assinatura Eletrônica Simples

{
  "signature_provider": "ZAPSIGN",
  "signature_collect_method": "EMAIL",
  "signature_authentication_options": {
    "mode": "NONE"
  },
  "signature_collect_options": {
    "require_self_photo": false,
    "require_document_photo": false,
    "require_selfie_validation": false
  }
}

ZAPSIGN — Envio por WhatsApp

{
  "signature_provider": "ZAPSIGN",
  "signature_collect_method": "WHATSAPP",
  "signature_authentication_options": {
    "mode": "NONE"
  },
  "signature_collect_options": {
    "require_self_photo": false,
    "require_document_photo": false,
    "require_selfie_validation": false
  }
}

CELCOIN — Assinador Interno via Link

{
  "signature_provider": "CELCOIN",
  "signature_collect_method": "LINK",
  "signature_authentication_options": {
    "mode": "NONE"
  },
  "signature_collect_options": {
    "require_self_photo": false,
    "require_document_photo": false,
    "require_selfie_validation": false
  }
}