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.

Adicionar documento extra

POST https://api.zapsign.com.br/api/v1/docs/{{doc_principal_token}}/upload-extra-doc/

Esse endpoint permite que você anexe um documento extra ao documento principal. É possível anexar até 14 documentos (um por vez, isto é, uma requisição para cada anexo), totalizando 15 documentos que o signatário pode assinar de uma vez só.

Headers

Name
Type
Description

Authorization*

string

Api token a frente do texto "Bearer".

Ex: Bearer c7f35c84-7893-4087-b4fb-d1f06c23

Request Body

Name
Type
Description

name

string

Título do documento extra. String de até 255 caracteres

url_pdf

string

Defina o PDF a ser assinado, a partir de uma URL pública com o arquivo. Aceitamos por enquanto apenas um arquivo no formato PDF, de até 10Mb.

base64_pdf

string

Alternativa ao url_pdf: Defina o PDF a ser assinado, a partir de um base64. Você deve converter o arquivo para uma string em base64 e nos enviar neste parâmetro.

Ex:

{

... "base64_pdf":"JVBERi0xLjcNCiWhs8XXDQoxIDA...",

}

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

Não há outros parâmetros a serem enviados na requisição, pois todos eles serão herdados do documento principal.

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.

Exemplo de requisição

LogoAdd extra doc | ZapSign WorkspacePostman

Exemplo de retorno

Atenção: os links retornados em original_file e signed_file são temporários e duram 60 minutos. Caso seu sistema necessite salvar estes links é recomendado que sejam baixados em uma CDN própria ou que o endpoint de Detalhar documento seja consultado sempre para garantir que seu usuário sempre receberá um link válido.

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

Perguntas frequentes

O que é um anexo/documento extra?

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:

Assim, quando o signatário vai assinar o documento, ele se depara com a lista de todos eles, para assinar de uma vez só:

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".

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.

PreviousCriar documento via ModeloNextAdicionar anexo (documento extra) via Modelo

Last updated