Modalidades
O endpoint de Originador (POST /banking/originator/applications) permite a criação de requisições com diferentes variações de fluxo de assinatura, definidas pela combinação dos seguintes elementos:
- Serviço de geração de assinatura (provedor de assinatura)
- Como a identidade é validada (método de assinatura)
- Por onde o signatário recebe o convite (forma de coleta)
Essas três elementos definem o fluxo de assinatura.
Visão Geral Rápida
| Você define… | Campo da API |
|---|---|
| Provedor de assinatura | signature_provider |
| Método de autenticação | signature_authentication_options.mode |
| Forma de envio ao signatário | signature_collect_method |
Provedor de Assinatura
Define qual plataforma executará a assinatura.
| Valor | Descrição |
|---|---|
| CLICKSIGN | Plataforma da Clicksign |
| ZAPSIGN | Plataforma da ZapSign |
| UNICO | Plataforma da UNICO |
Método de Assinatura
Define como o signatário comprova sua identidade ou aceita o documento.
CLICKSIGN
| Método | Quando usar |
|---|---|
| HANDWRITTEN | Assinatura simples, manuscrita |
| SELFIE | Selfie com documento |
| LIVENESS | Selfie dinâmica (prova de vida) |
| FACIAL_BIOMETRICS | Biometria facial |
| ADDRESS_PROOF | Validação por comprovante de endereço |
| OFFICIAL_DOCUMENT | Validação por documento oficial |
| PIX | Aceite mediante autenticação via PIX |
| ICP_BRASIL | Certificado digital |
| Aceite por e-mail | |
| SMS | Aceite por SMS |
| Aceite por WhatsApp |
UNICO
| Método | Quando usar |
|---|---|
| DOC_SIGN_SERPRO | Assinatura com integração Serpro |
| DOC_SIGN | Assinatura padrão UNICO |
ZAPSIGN
| Método | Quando usar |
|---|---|
| FACIAL_BIOMETRICS | Biometria facial |
Formas de Envio do Convite de Assinatura
Define como o convite de assinatura será entregue ao signatário.
| Valor | Descrição |
|---|---|
| Envio via WhatsApp | |
| Envio via e-mail | |
| LINK | Geração de link |
| SMS | Envio via SMS |
Provedores, Métodos de Assinatura e Forma de Envio
Abaixo está a tabela organizada por provedor, método de assinatura e forma de coleta.
| Provedor de Assinatura | Método de Assinatura | Descrição do Método | Formas de Envio do Convite de Assinatura |
|---|---|---|---|
| Clicksign | HANDWRITTEN | Assinatura manuscrita | WhatsApp, E-mail, Link |
| Clicksign | SELFIE | Selfie com documento | WhatsApp, E-mail, Link |
| Clicksign | ADDRESS_PROOF | Envio de comprovante de endereço | WhatsApp, E-mail, Link |
| Clicksign | OFFICIAL_DOCUMENT | Envio de documento oficial | WhatsApp, E-mail, Link |
| Clicksign | LIVENESS | Selfie dinâmica (prova de vida) | WhatsApp, E-mail, Link |
| Clicksign | PIX | Assinatura vinculada à validação via PIX | WhatsApp, E-mail, Link |
| Clicksign | FACIAL_BIOMETRICS | Biometria facial | WhatsApp, E-mail, Link |
| Clicksign | ICP_BRASIL | Certificado Digital (ICP-Brasil) | WhatsApp, E-mail, Link |
| Clicksign | Validação/autenticação via e-mail | WhatsApp, E-mail, Link | |
| Clicksign | SMS | Validação/autenticação via SMS | WhatsApp, E-mail, Link |
| Clicksign | Validação/autenticação via WhatsApp | WhatsApp, E-mail, Link | |
| ZapSign | FACIAL_BIOMETRICS | Biometria facial | WhatsApp, E-mail, Link |
| Unico | DOC_SIGN_SERPRO | Assinatura via integração Serpro | WhatsApp, SMS, Link |
| Unico | DOC_SIGN | Assinatura padrão UNICO | WhatsApp, SMS, Link |
Modelo Base de Estrutura de Assinatura no Corpo da Requisição
Todos os fluxos utilizam a mesma estrutura base.
Você apenas altera os valores, não o formato.
{
"signature_collect_method": "<COLLECT_METHOD>",
"signature_provider": "<PROVIDER>",
"signature_collect_options": {
"require_self_photo": false,
"require_document_photo": false,
"require_selfie_validation": false
},
"signature_authentication_options": {
"mode": "<MODE>"
}Exemplos de Uso
CLICKSIGN + SELFIE + EMAIL
{
"signature_collect_method": "EMAIL",
"signature_provider": "CLICKSIGN",
"signature_collect_options": {
"require_self_photo": false,
"require_document_photo": false,
"require_selfie_validation": false
},
"signature_authentication_options": {
"mode": "SELFIE"
}ZAPSIGN + WHATSAPP
{
"signature_collect_method": "WHATSAPP",
"signature_provider": "ZAPSIGN",
"signature_collect_options": {
"require_self_photo": false,
"require_document_photo": false,
"require_selfie_validation": false
},
"signature_authentication_options": {
"mode": "FACIAL_BIOMETRICS"
}UNICO + SERPRO + LINK
{
"signature_collect_method": "LINK",
"signature_provider": "UNICO",
"signature_collect_options": {
"require_self_photo": false,
"require_document_photo": false,
"require_selfie_validation": false
},
"signature_authentication_options": {
"mode": "DOC_SIGN_SERPRO"
}Consultar Links de Assinatura
Após a criação da solicitação, utilize o application_id (identificador da solicitação) para consultar os links de assinatura.
A consulta é realizada por meio do endpoint abaixo:
GET {{api_host}}/banking/originator/applications/{{application_id}}/signaturesO QUE ESSE ENDPOINT RETORNA
Esse endpoint retorna todas as informações relacionadas ao fluxo de assinatura configurado para a CCB.
EXEMPLO DE RESPOSTA
[
{
"id": "a855c72a-2d21-4b9a-94e5-ed699311c3a2",
"ip_address": "18.229.22.249",
"user_agent": null,
"signed_at": null,
"person": {
"id": "e42a304d-6640-42e6-8634-27414f48258d",
"full_name": "Carlos Eduardo Moreira Silva",
"taxpayer_id": "11144477735"
},
"collect_sign_link": "https://sandbox.clicksign.com/notarial/widget/signatures/af6fdfa8-8787-4516-84c5-402e475e6689/redirect",
"created_at": "2026-01-13T23:45:37.467201Z",
"updated_at": "2026-01-13T23:45:46.865224Z",
"version": 1,
"external_id": "af6fdfa8-8787-4516-84c5-402e475e6689"
}
]Observação: o campo
collect_sign_linkpode ser utilizado para direcionar o signatário ao fluxo de assinatura, conforme o provedor e a forma de coleta configurados na criação da solicitação.
Updated about 2 hours ago