Assistente de Criação (Wizard)
Anexar documento ao envelope
Anexa um PDF ao envelope. Pode ser chamada várias vezes para múltiplos documentos.
POST
Anexar documento ao envelope
Anexa um PDF a um envelope em rascunho. A chamada faz upload para o Google Cloud Storage e cria um registro no banco. Pode ser chamada várias vezes para anexar múltiplos documentos ao mesmo envelope.
Autenticação:
x-api-key no header. Também aceita Authorization: Bearer com headers de projeto/organização.
Parâmetros
string
required
UUID do envelope rascunho.
string
required
Nome do arquivo (ex.:
"contrato.pdf"). Usado para identificação e downloads.string
Conteúdo do PDF em Base64. Obrigatório se
url não for fornecido.string
URL remota do PDF (ex.:
"https://seu-servidor.com/doc.pdf"). Obrigatório se content não for fornecido. A URL é baixada pelo servidor.Respostas
string
UUID do arquivo recém-anexado. Use-o em chamadas futuras (ex.:
DELETE .../:uuid/documents/:fileUuid).string
Nome do arquivo.
integer
Tamanho em bytes.
string
Hash SHA-256 do conteúdo (Base64).
Erros
Veja Autenticação e erros.- 400: PDF vazio, formato inválido, ou nem
contentnemurlfornecidos. - 404: Envelope não encontrado ou não pertence ao seu projeto.
- 409: Envelope não está em rascunho.
Exemplo (Content)
Exemplo (URL)
Importante
- Múltiplos documentos: chame esta operação quantas vezes precisar. Todos ficam anexados ao mesmo envelope e todos serão assinados.
- Sem mudança de estado: anexar um documento não muda o estado do envelope (continua “Enviar arquivos”). Você avança manualmente com
POST .../:uuid/advance. - Validação de PDF: o arquivo é validado — PDFs corrompidos ou inválidos retornam 400.
Próximas etapas
- Anexe todos os PDFs necessários.
- Quando estiver pronto, chame
POST .../:uuid/advancepara ir ao passo de signatários.
Relacionado
DELETE .../:uuid/documents/:fileUuid— remover documentoPOST .../:uuid/advance— prosseguir com os signatáriosGET /signer/v1/envelopes/:uuid— listar documentos anexados