Adicionar documento extra via Plantilla

Adicionar documento extra via plantilla

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

Este endpoint te permite agregar documentos extra a un sobre, creandolo a partir de una plantilla dinamica. Puedes añadir hasta 14 documentos adicionales (uno a la vez, es decir, una solicitud por cada archivo adjunto). Esto significa que, sumando el documento original, tu firmante podrá firmar hasta 15 documentos al mismo tiempo.

Al igual que con el documento principal, deberás enviar todos los datos de reemplazo en formato JSON, y recibirás la respuesta también en formato JSON.

Antes de iniciar debes crear la Plantilla en la plataforma web de ZapSign en la sección de Plantillas. Ver tutorial para crear una plantilla dinámica

Encabezado

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

Request Body

Nombre	Tipo	Descripción
template_id*	string	El identificador/token de la plantilla dinámica. Ejemplo: https://app.zapsign.co/conta/modelos/{TEMPLATE_ID} Para acceder a tu lista de plantillas, haz clic aquí.
data[]['de']	string	La variable a reemplazar. Ej: "{{Nombre completo}}"
data[]['para']	string	El valor con el que reemplazar la variable. Ej: "John Doe"

200: OK Extra document successfully added.

{
    "open_id": 17,
    // use this token in case you want to place signatures in this attachmentSSS
    "token": "50c7d90e-ead6-46b5-99d6-33d2d3b9a31f", 
    "name": "Anexo al Contrato",
    "original_file": "https://zapsign.s3.amazonaws.com/aaa/48025712-b429-4216-8a33-d90c575d0b7f/0e2d0a87-a0f6-4a49-a05f-7a439fd7308e.pdf",
    "signed_file": null
},

400: Bad Request Required fields are not present in the payload

400: Bad Request Parent doc has already been signed, or is in itself an extra document

402: Payment Required Current company doesn't have an API plan

403: Forbidden Template has been deleted, is inactive or belongs to another company

404: Not Found Specified document or template have not been found

Obs: dont mistake the extra document with the batch sign via API, because this one is made to sign multiple documents at the same time not to create attachments. They have different use cases.

Request

Add extra doc from Template | ZapSign WorkspacePostman

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.