Batch sign via API

If your company frequently needs to sign many documents, this endpoint provides an efficient way to complete those signatures without having to manually access each document. With batch signing, you save time and automate the process of signing multiple documents!

Batch sign via API:

POST https://api.zapsign.com.br/api/v1/sign/

In this section:

• How to get the user_token;

• How to get the signers_token;

Prerequisites:

• You can only sign via API with users within your account. This means that signers must be registered as users in your account, configured in the Settings > Organization > Users section. It is not possible to sign for third parties or external clients who are not users of your account.

• You can only sign documents that have the signer’s email empty or matching the user’s email who will sign the documents. If the email is different, signing will not be possible.

• The user must have the following information saved in the Settings > My Profile > Personal Info section: first name, last name, phone number, signature, and initials.

• Signing via API does not consume credits (it is free). However, you need to have an active API Plan to use this endpoint, including the batch signing add-on.

Supported Authentication:

Standard Authentication:

• Batch signing only works with standard authentication: "on-screen signature".

Advanced Authentications (optional – if selected when creating the document):

• "Selfie"

  • When this option is selected at document creation, the "selfie_photo" field must be included in the request body.

• "ID document photo"

  • When this option is selected at document creation, the fields "document_photo_url" and "document_verse_photo_url" must be included.

• If the document has any other advanced authentication method not listed above, it will not be possible to sign those documents.

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).
selfie_photo	string	It must be a publicly accessible URL containing the selfie image, accepted in JPG, JPEG or PNG formats.
document_photo_url	string	It must be a publicly accessible URL containing the front image of the document, accepted in JPG, JPEG or PNG formats.
document_verse_photo_url	string	It must be a publicly accessible URL containing the back image of the document, accepted in JPG, JPEG or PNG formats.

200

'Document(s) successfully signed. Reminder: this endpoint is asynchronous, so please wait for the final PDFs to be ready via webhooks or check back in a few minutes.'

Request

Sign in batch | ZapSign WorkspacePostman

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.

400 Errors

If you attempt to sign a document that has an authentication method not allowed for batch signing, you will receive a 400 error with a description of the authentication method that is not permitted and the document token.

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.