Batch sign via API
Batch sign via API
POST https://api.zapsign.com.br/api/v1/sign/
If someone from your company always has to sign many documents at ZapSign, one option is to perform this signature programmatically via API. Prerequisites: 1. You can only sign via API with users inside your account, added in Settings. Thus, you cannot programmatically sign for third parties or external customers who are not users of your account; 2. Signing via API does not consume credits (it's free), but you must have an active API Plan to be able to use this endpoint, including sandbox/test documents.
3. Batch signing only works for documents that contain "on-screen signature" as the only authentication method. We are working on making it possible to batch sign documents with other authentications too!
Headers
| Name | Type | Description |
|---|---|---|
Authorization | string | apiToken ahead of the "Bearer" text. Ex: Bearer c7f35c84-7893-4087-b4fb-d1f06c23 |
Request Body
| Name | Type | Description |
|---|---|---|
user_token | string | User token (who will sign). |
signer_tokens[] | array | Signer tokens that will be signed (signer's token on each document to be signed). |
Request
Response
Where do I find the user_token?
Log into the user who will sign the documents and enter their profile:
At the bottom of the page, enable signing via API and copy the token.
How to get signer_tokens?
Every signer created at ZapSign has a token. Just copy this ZapSign-generated token after a document is created or after you add a signer. (Please note: it is not the document's token, but the signer's token!)
Note: if you only want to sign one document at a time, just insert an array with only one signer token. E.g.: signer_tokens: ["123-abc-456-def"]
404 errors
If you try to make a request with user_token or signer_tokens that don't exist, you will receive a 404 (not found) response. If this happens, make sure you are actually using the signer's token instead of the document's token, and that you're not reversing with the user_token, etc.
Asynchronous Endpoint
This endpoint is asynchronous, thus, you will request for documents to be signed and you will receive an almost immediate response from ZapSign. As the documents are ready, you will receive the webhooks in your application one at a time. Avoid signing more than 100 documents at once to avoid delays. Make more than one request if appropriate.
Last updated
