ZapSign API
Search…
Adicionar anexo (documento extra)
Não utilize este endpoint caso algum signatário vá assinar com auth_mode:"certificadoDigital", pois este método de autenticação é, por enquanto, incompatível com documentos extras.
Caso você utilize a plataforma web da ZapSign, irá perceber que é possível subir vários PDFs de uma vez para serem assinados pelos mesmos signatários:
Exemplo na plataforma web de um envelope com 3 PDFs.
Assim, quando o signatário vai assinar o documento, ele se depara com a lista de todos eles, para assinar de uma vez só:
Essa funcionalidade agora está presente também na API da ZapSign, assim é possível adicionar "documentos extras" ao documento principal.
O documento principal será o número 1 e os documentos extras aparecerão para o signatário como documentos de número 2, 3, etc. Ao fazer um GET no documento principal, os documentos extras aparecerão no parâmetro "extra_docs".
Obs: não confunda a adição de anexos com a assinatura em lote via API, já que nesta última a assinatura é feita programaticamente pelo seu sistema via código. Os casos de uso são distintos.
post
https://api.zapsign.com.br
/api/v1/docs/{{doc_principal_token}}/upload-extra-doc/?api_token={{seu_token_de_acesso}}
Adicionar documento extra
Não há outros parâmetros a serem enviados na requisição, pois todos eles serão herdados do documento principal.

Exemplo de requisição

Os parâmetros devem estar em formato JSON no corpo da requisição
1
{
2
"name":"Anexo ao Contrato de Admissão João",
3
"base64_pdf":"JVBERi0xLjcNCiWhs8XXDQoxIDA...",
4
}
Copied!

Exemplo de retorno

1
{
2
"open_id": 17,
3
"token": "50c7d90e-ead6-46b5-99d6-33d2d3b9a31f", //utilize esse token caso queira posicionar assinaturas neste documento extra
4
"name": "Anexo ao Contrato de Admissão João",
5
"original_file": "https://zapsign.s3.amazonaws.com/aaa/48025712-b429-4216-8a33-d90c575d0b7f/0e2d0a87-a0f6-4a49-a05f-7a439fd7308e.pdf",
6
"signed_file": null
7
},
Copied!

Perguntas frequentes

O documento extra consome crédito de API? Sim. Cada documento extra conta igual a um documento principal. Assim, caso você adicione 14 documentos extras a um documento principal, isso contará como "15 créditos" de API, e não um só.
Eu consigo posicionar assinaturas no documento extra? Sim! Basta encaminhar o token do documento extra no endpoint de posicionar assinaturas.
Adicionei um anexo sem querer. Tem como remover/desfazer o engano? Não. Por enquanto não é possível remover um anexo, depois de adicionado.
Last modified 1mo ago