Documentos

A plataforma Clicksign oferece recursos para gerenciar, acessar e interagir com os documentos de seus envelopes, proporcionando um fluxo de trabalho ágil e eficiente para suas necessidades de assinatura eletrônica. Aqui você encontrará todas as informações necessárias para adicionar e atualizar documentos dentro dos envelopes da Clicksign.

Visão Geral

A adição de documentos a um envelope é uma etapa fundamental no processo de preparação para assinatura digital. Nesta página, você encontrará todas as informações necessárias para adicionar documentos a um envelope utilizando a Clicksign API.

Ao adicionar um documento a um envelope, você está incorporando esse documento ao conjunto de arquivos que serão enviados para assinatura digital. Isso permite que os signatários visualizem e assinem o documento como parte do processo de assinatura.

Existem duas formas principais de adicionar documentos a um envelope: upload de arquivos ou uso de modelos (templates). Ambas as opções oferecem flexibilidade para atender diferentes necessidades e cenários.

Upload do Arquivo (Base64)

Uma forma de adicionar documentos a um envelope é fornecendo o conteúdo do arquivo em formato base64. Esse método permite que você inclua arquivos diretamente na requisição, sem necessidade de armazená-los separadamente.

Esse processo é simples e eficiente, ideal para quando você deseja integrar diretamente os arquivos ao fluxo de criação do envelope. Após criar o envelope, basta adicionar o(s) documento(s) que farão parte do processo de assinatura.

Para mais informações sobre como realizar esse procedimento, consulte a página de referência para a requisição de Criar Documento por Upload.

Veja mais detalhes na página de Referência da API.

Utilização de um Modelo (Template)

Outra forma de adicionar documentos a um envelope é através do uso de modelos (templates) previamente configurados. Os templates permitem que você crie documentos de forma padronizada, otimizando o processo de criação e garantindo consistência nos documentos gerados.

Ao utilizar um modelo, você pode optar por personalizar variáveis dentro do documento ou reutilizar modelos existentes, agilizando o processo. Se necessário, também é possível modificar o nome do arquivo, desde que a extensão seja .docx.

Para mais informações sobre como criar documentos a partir de um modelo, consulte a seção de Modelos ou a página de referência para a requisição de Criar Documento por Modelo.

Veja mais detalhes na página de Referência da API.

Atualização de Documentos

A plataforma Clicksign também oferece funcionalidades para atualizar documentos dentro de um envelope, permitindo alterações no status do documento conforme o andamento do processo de assinatura.

O principal ajuste possível é a alteração do status de um documento para "cancelado" (canceled) ou "finalizado" (closed), quando necessário. Isso proporciona flexibilidade no gerenciamento de documentos em andamento, garantindo que o processo se adapte às necessidades do fluxo de trabalho.

É importante lembrar que a alteração de status só pode ser feita quando o documento se encontra com o status "em andamento" (running). A modificação do status está restrita a essa função, mantendo a integridade do processo de assinatura.

Na Prática

Desenvolvemos um guia passo a passo para realizar requisições utilizando cURL como demonstração:

Conte com a nossa ajuda!

Estamos comprometidos em fornecer a você todas as ferramentas necessárias para simplificar e aprimorar seus processos de assinatura eletrônica. Não hesite em nos contatar se tiver alguma dúvida ou precisar de assistência adicional. Estamos sempre disponíveis através do e-mail [email protected].