Módulos do ClickFlow

Nesta página:

• Módulos de Aceite e de Notificação (consent)
• Módulo de Assinatura (signature e embedded_signature)
• Módulo de Autenticação (verify)
• Módulo de Coleta de Dados (ClickForm) (form)
• Módulo de KYC (kyc)

Para entender a jornada antes das regras de cada módulo, leia Como funciona o ClickFlow.

Os módulos são as capacidades de negócio que o ClickFlow combina para formar uma jornada. Cada módulo resolve uma parte específica do processo — coletar dados, coletar a prova de presença, avaliar risco, formalizar documentos ou registrar comunicações — enquanto o ClickFlow coordena a ordem e acompanha o avanço da execução.

Essa separação permite montar jornadas diferentes com os mesmos blocos. Uma operação pode começar com um formulário e terminar em assinatura; outra pode exigir autenticação e KYC antes da formalização. O flow usa apenas os módulos necessários para cada caso.

Alguns módulos também podem ser contratados e usados de forma independente. Nesses casos, sua empresa integra diretamente com a API do módulo, sem precisar criar uma jornada no ClickFlow.

Como os módulos participam da jornada

Cada etapa configurada no flow referencia um módulo e informa o contexto necessário para sua execução. O ClickFlow preserva o estado da execução e aciona cada etapa na ordem definida, mas não incorpora as regras internas dos módulos.

Na prática:

• o ClickFlow controla a sequência e o andamento;
• o módulo executa sua capacidade especializada;
• o Executor entrega a experiência ao canal e conduz a transição entre as etapas.

Os schemas de steps e seus respectivos contextos estão em Orquestrador. Exemplos completos estão no Try It! de Criar Flow.

Módulos de Aceite e de Notificação (consent)

Os Módulos de Aceite e de Notificação usam o mesmo motor de templates, canais e relatórios. O Aceite registra uma decisão do destinatário. A Notificação envia um aviso, sem aceite nem recusa.

No Flow, o step consent envia a comunicação e acompanha seu status. No Aceite, aguarda a decisão. Na Notificação, avança conforme o status final da comunicação. Os dois também podem ser integrados sem o ClickFlow.

Saiba mais em Módulos de Aceite e de Notificação. Schema do step: Orquestrador.

Módulo de Assinatura (signature e embedded_signature)

O Módulo de Assinatura formaliza o documento na API da Clicksign. Há duas experiências. Na padrão (signature), a pessoa assina no widget da Clicksign, com os requisitos declarados em auths. Na incorporada (embedded_signature), assina no ClickWidget, a tela de assinatura usada somente nesse passo, sem sair da jornada. Essa experiência ainda não está disponível no canal web.

Saiba mais em Módulo de Assinatura. Schema do step: Orquestrador.

Módulo de Autenticação (verify)

O Módulo de Autenticação coleta a prova de presença e, conforme o tipo, a face, em webview. Quando compara identidade, o retorno diz se a face corresponde ao CPF enviado. Não descobre de quem é a face. Na API o passo é verify. É independente do requisito de autenticação do envelope: aprovar aqui não libera a assinatura, e o contrário também vale.

Há três tipos. Prova de vida (liveness) termina em aprovado ou reprovado. Biometria comportamental (biometric_behavior) olha prova de vida, identidade e alerta de comportamento. Biometria (base ampliada) (identity_biometrics) compara o rosto sem o alerta de comportamento. Na comportamental, os dois inconclusivos não são a mesma coisa. Na identidade, a base não confirmou a face com o CPF, e a etapa encerra. No comportamento, a face não tem alerta, e a etapa segue. Para a identidade inconclusiva seguir, contrate o KYC.

Saiba mais em Módulo de Autenticação. Schema do step: Orquestrador.

Módulo de Coleta de Dados (ClickForm) (form)

O Módulo de Coleta de Dados (ClickForm) coleta, valida e estrutura dados sem depender da geração de documentos. No Flow, o step form abre uma experiência de preenchimento e devolve as respostas para a continuidade da jornada. Esses dados podem pré-preencher etapas posteriores e alimentar outros módulos.

O ClickForm também pode ser usado de forma independente para coletar dados e enviá-los ao sistema da sua empresa.

Saiba mais em Módulo de Coleta de Dados (ClickForm). Schema do step: Orquestrador.

Módulo de KYC (kyc)

O Módulo de KYC decide se a conta faz negócio com aquela pessoa a partir dos resultados da biometria comportamental. Não é a coleta da face e não tem tela. A resposta deste passo é aprovado ou reprovado. O passo entra depois da biometria comportamental e não a substitui. A combinação padrão da esteira encerra quando a identidade fica inconclusiva. Para deixar esse resultado seguir, contrate o KYC. A alteração é feita no motor do KYC, para aquela conta, e não muda a regra das demais. Depois da contratação, o time da Clicksign faz essa alteração.

Saiba mais em Módulo de KYC. Schema do step: Orquestrador.

Observações

• O Flow lista steps e serviços que não são módulos. Quem decide o próximo passo e quem aciona o módulo está em Primeiros passos do Flow.
• Orquestrador e Executor. São os dois serviços da esteira (cérebro e músculo), não unidades de negócio plugáveis. Orquestrador · Executor.
• acceptance. Confirmação de leitura. Mensagem no WhatsApp com botão de continuar — serve para a pessoa seguir a jornada, não para registrar aceite de termo. Não é módulo. Resposta fora de accept_replies é ignorada e a etapa continua em andamento. Não há recusa que falhe a execução. Aceite formal é o módulo de Aceite (consent). Os dois convivem; nenhum substitui o outro. Se o passo precisa de evidência de consentimento, use consent. context de acceptance (template_key, accept_replies) está no Orquestrador.

Próximo passo ➡️

• Módulos de Aceite e de Notificação — conheça confirmação e aviso.
• Módulo de Assinatura — as duas experiências de formalização.
• Módulo de Autenticação — prova de vida, biometrias e o que cada resultado faz.
• Módulo de Coleta de Dados (ClickForm) — conheça a coleta de dados.
• Módulo de KYC — a decisão da conta sobre aqueles resultados.
• Webhooks — avisos dos módulos ao longo da jornada.
• FAQ: dúvidas em ClickFlow — respostas curtas para as dúvidas mais comuns.