Batch sign via API
Last updated
Was this helpful?
Last updated
Was this helpful?
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 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 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.
Batch signing only works with authentication methods "on-screen signature," selfie, and identity document photo. If the document has another authentication method, signing those documents will not be possible.
With this feature, you can save time and make the signing process more efficient for your team! 🚀
POST https://api.zapsign.com.br/api/v1/sign/
Authorization*
string
apiToken ahead of the "Bearer" text.
Ex: Bearer c7f35c84-7893-4087-b4fb-d1f06c23
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.
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.
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"]
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.
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.
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.
