Add attachment (extra document) via Template

Add attachment via Template

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

This endpoint allows you to add attachments to your original document via Dynamic Template. Its possible to add up to 14 extra docs (one at a time, therefore, one request for each attachment), counting the original doc your signer will be able to sign 15 documents at once. You must send all the replacements data in JSON format and will get the response in JSON format as well.

Headers

Name	Type	Description
Authorization*	string	apiToken ahead of the "Bearer" text. Ex: Bearer c7f35c84-7893-4087-b4fb-d1f06c23

Request Body

Name	Type	Description
template_id*	string	Dynamic template's Identifier/token Ex: https://app.zapsign.co/conta/modelos/{TEMPLATE_ID} To access yout templates list. just click here: https://app.zapsign.co/conta/modelos/
data[]['de']	string	Variable to replace. Ex: "{{FULL NAME}}"
data[]['para']	string	Value to replace the variable for. Ex: "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 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
},

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

Caution: the original_file and signed_file links are temporary and expires in 60 minutes. In case your system needs to save those links it is recommended that you save them in your own CDN or that you call the Detail document endpoint every time your user needs a valid URL that will expires in more 60 minutes.

{
    "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
},

Frequently asked questions

Whats an attachment/extra document?

In case you use our web platform, you will notice that is possible to upload multiple PDFs at once to be signed by the same signers:

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

That way, when the signer is going to sign the document, she will be see all of them, to sign at once:

The original document will be the number 1 and the attachments will appear to the signer as the documents number 2,3, etc. Doing a GET request on the original document, the attachments will be on the "extra_docs" paramenter.

Can i place signatures on an attachment? Yes! Just send yout attachment token on the endpoint for placing signatures

I've added attachment by mistake. Can i delete it? No. For now, it's impossible to remove attachments after added. You can delete de document and re-create it.