FAQ: dúvidas em ClickFlow

Respostas curtas para quem está integrando o ClickFlow. O contrato de cada chamada fica nas páginas ligadas em cada resposta.

Dúvida de ambiente, token ou autenticação, comum a qualquer produto, está na FAQ: dúvidas gerais.

O produto

1. O ClickFlow substitui a assinatura eletrônica?

Não. A assinatura entra como uma etapa, signature ou embedded_signature. Antes dela, a esteira pode coletar, verificar, avaliar risco e registrar aceite.

2. Preciso usar todos os módulos?

Não. O flow leva só as etapas daquele caso.

3. O contato precisa baixar um aplicativo da Clicksign?

Não. No WhatsApp, as etapas abrem no próprio aplicativo de mensagem. Na Web, a jornada é uma página. Na API, ela acontece no aplicativo ou portal da sua empresa.

4. Posso testar antes de produção?

Sim. O sandbox está liberado. Produção só funciona para quem contratou o ClickFlow. A contratação é independente da API v3.

A esteira

5. Como a esteira é criada?

Pela API do Orquestrador, em JSON. O passo a passo está em Primeiros passos.

6. Dá para alterar um flow que já está publicado?

Não direto. Despublique, edite e publique de novo. Quem já estava numa execução segue a definição com a qual começou.

7. Onde vejo em qual etapa o contato parou?

Na consulta da execução, pelo Executor ou pelo Orquestrador, e na lista da plataforma Clicksign. Cada etapa tem o próprio status.

8. Qual a diferença entre consent e acceptance?

consent é a etapa do Módulo de Aceite e do Módulo de Notificação: aceitar ou recusar um termo, ou receber um aviso. acceptance é a confirmação de leitura no WhatsApp, para a pessoa seguir a jornada. Exige telefone em qualquer canal de disparo.

9. E se a pessoa responder algo que não está em accept_replies?

A resposta é ignorada e a etapa continua em andamento. Não há recusa que encerre a execução.

Desfecho

10. Se a biometria reprovar, o contato tenta de novo na mesma execução?

Não. A reprovação encerra a jornada. Uma nova tentativa é uma nova execução. A exceção é o passthrough, na pergunta seguinte.

11. O que o passthrough faz?

Na reprovação do verify, a etapa conclui e a execução segue. O veredito não é aplicado. O template de rejeição do WhatsApp não é enviado. É o caminho quando o KYC dá a palavra final. Falha operacional do provedor, sem resultado utilizável, ainda encerra a etapa e a execução.

12. Cancelar a execução cancela o envelope?

Não. O status da execução vai para canceled e não retoma. A etapa que estava em andamento também é cancelada. O envelope na API de Assinatura continua como estava.

13. O contato é avisado quando eu cancelo?

No WhatsApp, se a etapa em andamento era form, verify ou kyc, o contato recebe a mesma mensagem de falha usada quando a etapa falha por outro motivo. Em api e web, nada é enviado.

Disparo

14. Como mando o telefone?

Com DDI. O Executor grava só dígitos, com 55 na frente e sem +. 11999999999 e +5511999999999 viram 5511999999999.

15. Qual o tamanho máximo do disparo?

O context tem teto de 150 KiB. O body inteiro do POST /execute, incluindo files[], tem teto de 16 MiB. Acima de qualquer um dos dois, a execução não é criada.

16. Como sou avisado sem ficar consultando?

Informe callback_url no disparo do Executor. O campo é opcional. Os eventos estão em Webhooks. Sem o campo, consulte GET /api/v1/executions/{execution_id}. Se essa consulta for repetida, o espaçamento está em Integração resiliente.

17. Qual a diferença entre os canais?

O channel é escolhido no disparo. O flow não guarda canal.

• whatsapp: a Clicksign envia as mensagens. O telefone é obrigatório.
• api: a Clicksign não envia mensagem. A resposta traz current_step e a sua empresa entrega o link.
• web: também não envia mensagem. A resposta traz web_url, a jornada no navegador da Clicksign.

api e web não são o mesmo canal. A etapa acceptance continua no WhatsApp nos três. embedded_signature ainda não está disponível no canal web; em breve, passa a funcionar nesse canal. O detalhe está no Executor.

18. Como mando um PDF diferente a cada disparo?

No step signature, declare o documento com kind: "runner_files". No POST /execute, envie files[] com o mesmo key e o PDF em content_base_64, no formato data:application/pdf;base64,.... O nome do arquivo fica no flow. O body inteiro, incluindo files[], tem teto de 16 MiB. O passo a passo está no Executor.

19. Posso usar um modelo de contrato em vez de enviar o PDF?

Sim. O documento da etapa signature pode ser kind: "template", apontando para um modelo já criado na API de Assinatura. O modelo é reutilizado. Dados coletados na jornada e o context do disparo podem preencher o documento. Como criar e editar o modelo está em Automação com Modelos. Também existe kind: "file", um arquivo já guardado. O schema está no Orquestrador.

Outras FAQs

• Plataforma: FAQ: dúvidas gerais — ambientes, token, autenticação e suporte.
• Assinatura eletrônica: FAQ: dúvidas em assinatura — envelope, signatário e notificação.

Próximo passo ➡️

• Como funciona o ClickFlow — conceitos, canais e o ciclo de uma execução.
• Primeiros passos — autentique a integração e execute o primeiro flow.