Adicionar documento (sobre)

Adicionar documento a un sobre

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

Este endpoint te permite adicionar documentos a un sobre para que el firmante sólo deba firmar una vez X documentos. Es posible adicionar hasta 14 documentos en un sobre, y por cada documento se debe hacer una solicitud diferente a este endpoint.

Encabezado

Nombre	Tipo	Descripción
Authorization*	string	API token prefijo con la palabra "Bearer". Ex: Bearer c7f35c84-7893-4087-b4fb-d1f06c23

Request Body

Name	Type	Description
name	string	Título del documento máximo 255 caracteres.
url_pdf	string	Define el archivo PDF a firmar. Debe ser una URL pública y el tamaño del documento máximo 10Mb.
base64_pdf	string	Alternativa a url_pdf: Documento convertido a cadena de base64. Ex: { ... "base64_pdf":"JVBERi0xLjcNCiWhs8XXDQoxIDA...", }
signature_placement	string	Permite posicionar la firma en el documento usando un texto ancla (sin necesidad de coordenadas x, y). Configure signature_placement: "<<{identificador_de_firma}>>" y la firma será posicionada donde encuentre ese texto. Si el texto aparece más de una vez, la firma será posicionada en todas las ubicaciones. Nota: el uso de << >> es altamente recomendado para evitar conflictos con el texto, pero no es obligatorio. Ej: "<>". Default: ""
rubrica_placement	string	Permite posicionar la rúbrica en el documento usando un texto ancla (sin necesidad de coordenadas x, y). Configure rubrica_placement: "<<{identificador_de_rubrica}>>" y la rúbrica será posicionada donde encuentre ese texto. Si el texto aparece más de una vez, la rúbrica será posicionada en todas las ubicaciones. Nota: el uso de << >> es altamente recomendado para evitar conflictos con el texto, pero no es obligatorio. Ej: "<>". Default: ""

200 Extra document successfully added.

{
    "open_id": 17,
    "token": "50c7d90e-ead6-46b5-99d6-33d2d3b9a31f", 
    "name": "Anexo al contrato de trabajo",
    "original_file": "https://zapsign.s3.amazonaws.com/aaa/48025712-b429-4216-8a33-d90c575d0b7f/0e2d0a87-a0f6-4a49-a05f-7a439fd7308e.pdf",
    "signed_file": null
},

No es necesario enviar ningún otro parámetro, porque toma las configuraciones del documento y firmantes del documento principal.

Request

https://www.postman.com/zapsign/workspace/zapsign-workspace/request/27495556-b41b0068-b7e4-47aa-a828-e65084fcdb4b?ctx=documentationwww.postman.com

Response

Advertencia: los enlaces original_file y signed_file son temporales y caducan en 60 minutos. Si tu sistema necesita guardar esos enlaces, se recomienda almacenarlos en tu propio CDN o llamar al endpoint de Detalle del documento cada vez que tu usuario necesite una URL válida que caduque en más de 60 minutos.

{
    "open_id": 17,
    // use this token in case you want to place signatures in this attachment
    "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
},

Preguntas frecuentes

¿Qué es un documento extra en un sobre?

Si has creado documentos en la plataforma web, sabrás que es posible enviar varios documentos en un sobre al firmante. Esto permite que el firmante reciba un único link de firma por correo, WhatsApp o cualquier otro medio y firme todos los documentos al mismo tiempo.

Example of the web application with 3 PDFs in one envelope.

En el proceso de firma el firmante verá todos los documentos a firmar y realizará una única firma.

¿Puedo posicionar firmas en un documento extra?

¡Sí! Puedes posicionar firmas e iniciales en un documento extra. Simplemente envía el token del documento en el endpoint de Posicionar firmas, y ¡listo!

He agregado un archivo adjunto por error. ¿Puedo eliminarlo?

Lamentablemente, actualmente no es posible eliminar documentos extra una vez que han sido añadidos. Sin embargo, puedes eliminar todo el documento y volver a crearlo para solucionar este inconveniente.