ZapSign API
English
English
  • General Information
  • Getting Started
  • ZapSign Environments
  • Ready-to-use requests!
  • Authentication
    • Static token
    • JWT Authentication
      • Get access token
      • Refresh your access token
  • Types of Tokens
  • API versioning
  • Rate Limit Policies
  • Incident alerts
  • How Payment Works
  • Status Code
  • Account
    • Plan Information
    • List account users
    • Create account users
    • Delete account user
  • Documents
    • Create document via Upload
    • OneClick (ClickWrap)
      • Create document (OneClick)
    • Create document via Template
    • Add attachment (extra document)
    • Add attachment (extra document) via Template
    • Detail document
    • List documents
    • Delete document
    • Document Audit Trail
    • Optional: Place signatures
    • Reject Documents
  • Signers
    • Detail signer
    • Update signer
    • Add signer
    • Delete signer
    • Batch sign via API
    • Reject Documents by User
  • Templates
    • Create template (DOCX)
      • Configure Template Form
    • List templates
    • Get template
    • Update template
    • Delete template
  • Partnerships
    • Update Payment Status
    • Create Account
  • TIMESTAMP
    • Add timestamp
  • Background Check
  • Introduction
  • Understanding the Result
  • Creating a Background Check
    • Person Check
    • Company check
  • Retrieve a Check
  • Check details
  • Webhooks
    • How webhooks works
    • Testing webhooks on ZapSign
    • Create Webhook
    • Webhooks logs
    • Events
      • Document
        • Doc created
        • Doc deleted
        • Created signer
      • Signer
        • Signature request send
        • Document viewed
        • Reading confirmation
        • Doc signed
        • Doc refused
        • Email bounce
        • Failed Validation
      • Background check
        • Background check completed
    • Reprocessing Documents and Webhooks
    • Delete Webhook
  • Widget
    • How widget works
Powered by GitBook
On this page
  • Add attachment via Template
  • Request
  • Response
  • Frequently asked questions

Was this helpful?

  1. Documents

Add attachment (extra document) via Template

PreviousAdd attachment (extra document)NextDetail document

Last updated 5 months ago

Was this helpful?

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

data[]['de']

string

Variable to replace.

Ex: "{{FULL NAME}}"

data[]['para']

string

Value to replace the variable for. Ex: "John Doe"

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

Request

Response

{
    "open_id": 17,
    // use this token in case you want to place signatures in this attachment
    "token": "50c7d90e-ead6-46b5-99d6-33d2d3b9a31f", 
    "name": "Contract",
    "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:

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.

To access yout templates list. just click here:

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

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 endpoint every time your user needs a valid URL that will expires in more 60 minutes.

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

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

Dynamic Template
the batch sign via API
Detail document
endpoint for placing signatures
delete de document
re-create it
https://app.zapsign.co/conta/modelos/
LogoAdd extra doc from Template | ZapSign WorkspacePostman
Example of the web application with 3 PDFs in one envelope.