Skip to main content

ZapSign

ZapSign is a digital signature and document management platform that enables secure electronic signatures and workflow automation. Its REST API lets you manage documents, signers, templates, and webhooks programmatically. Nexla connects to the ZapSign API to ingest document, signer, and template data as a source, and to create or update ZapSign records as a destination.

ZapSign icon

Power end-to-end data operations for your ZapSign API with Nexla. Our bi-directional ZapSign connector is purpose-built for ZapSign, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to ZapSign or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your ZapSign workflows fast, secure, and fully governed.

Features

Type: API

SourceDestination

  • Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
  • Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
  • API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
  • Request optimization with intelligent batching, retry, and caching to minimize API calls and costs

Prerequisites

Before creating a ZapSign credential, you need an active ZapSign account and an API token. ZapSign authenticates every API request with a Bearer token that is sent in the Authorization header.

To obtain your ZapSign API token, follow these steps:

  1. Sign in to your ZapSign account.

  2. Open Settings and navigate to the Integrations section.

  3. Locate the ZapSign API entry and copy the access token shown there.

  4. Store the token securely. It grants access to your ZapSign account, so keep it confidential and do not share it outside your organization.

The token is sent as a Bearer token in the Authorization header on every request (for example, Authorization: Bearer <your-token>). ZapSign also supports dynamic tokens in addition to the static account token. The default API base URL is https://api.zapsign.com.br. For details on tokens, authentication, and available endpoints, see the ZapSign Developer Documentation.

Authenticate

Credentials required

FieldRequiredSecretDescription
Base URLYesNoThe base URL for the ZapSign API.
API KeyYesYesBearer token for ZapSign API authentication. Obtain from your ZapSign account dashboard.

Create a credential in Nexla

  1. After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

  2. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

  3. Enter the ZapSign API base URL in the Base URL field. The default value is https://api.zapsign.com.br.

  4. Enter your ZapSign API token in the API Key field. Nexla sends this value as a Bearer token in the Authorization header on every request. This token is sensitive and must be kept confidential.

    If your API token is compromised, revoke it in your ZapSign account under Settings > Integrations > ZapSign API and generate a new one. The token provides access to your ZapSign account data and should be treated as sensitive information.

    For detailed information about authentication and available endpoints, see the ZapSign Developer Documentation.

  5. Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation.

Use as a data source

To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the ZapSign connector tile, then select the credential that will be used to connect to ZapSign, and click Next; or, create a new ZapSign credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common ZapSign endpoints. Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below.

[Rest API] List Templates

Returns a list of all available document templates in the ZapSign account.

  • This endpoint is paginated. Nexla automatically follows the pagination links to fetch subsequent pages of data.

[Rest API] List Documents

Returns a list of all documents that have been created in the ZapSign account.

  • This endpoint is paginated. Nexla automatically follows the pagination links to fetch subsequent pages of data.

[Rest API] List Signers

Returns a list of all signers registered in the ZapSign account.

[Rest API] Get Document

Returns full details of a specific document, including signers and file URLs.

  • Provide the Document Token of the document to retrieve.

[Rest API] Get Document Audit Trail

Returns the event log (audit trail) for a specific document.

  • Provide the Document Token of the document whose audit trail to retrieve.

[Rest API] Get Signer

Returns details of a specific signer by their token.

  • Provide the Signer Token of the signer to retrieve.

[Rest API] Get Template

Returns details of a specific document template by token.

  • Provide the Template Token of the template to retrieve.

[Rest API] List Account Users

Returns a paginated list of all users in the ZapSign account.

  • This endpoint is paginated. Nexla automatically follows the pagination links to fetch subsequent pages of data.

[Rest API] Get Plan Info

Returns the current plan name, credit balance, status, and period end date.

Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.

Manual configuration

ZapSign data sources can also be manually configured to ingest data from any valid ZapSign API endpoint, including endpoints not covered by the pre-built templates, chained API calls, or custom request parameters. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, date/time and lookup macros, path to data, metadata, and request headers.

Once all of the relevant settings have been configured, click the Create button in the upper right corner of the screen to save and create the new ZapSign data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.

Use as a destination

Click the + icon on the Nexset that will be sent to the ZapSign destination, and select the Send to Destination option from the menu. Select the ZapSign connector from the list of available destination connectors, then select the credential that will be used to connect to ZapSign, and click Next; or, create a new ZapSign credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common ZapSign endpoints. Select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

[Rest API] Create Document

Create a new document for signing in ZapSign. Each record from your Nexset is sent as a JSON request body to create a new document.

[Rest API] Cancel Document

Refuse or cancel a document that is currently in progress.

[Rest API] Add Signer

Add a new signer to an existing document.

  • Provide the Document Token of the document to add a signer to.

[Rest API] Update Signer

Update details of a signer on a document, such as name, email, or authentication mode.

  • Provide the Signer Token of the signer to update.

[Rest API] Delete Signer

Remove a signer from a document. This action is irreversible and is only possible if the signer has not yet signed.

  • Provide the Signer Token of the signer to remove.

[Rest API] Create Webhook

Register a webhook URL to receive document event notifications.

[Rest API] Update Document

Update an existing document in ZapSign.

  • Provide the Document Token of the document to update.

[Rest API] Delete Document

Delete an existing document from ZapSign.

  • Provide the Document Token of the document to delete.

Manual configuration

ZapSign destinations can also be manually configured to send data to any valid ZapSign API endpoint. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, data format, endpoint URL, request headers, attribute exclusions, record batching, and response webhooks.

ZapSign APIs expect JSON format for write operations. For update operations, include the token of the object to be updated at the end of the URL.

Save & activate

Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To send the data to the configured ZapSign endpoint, open the destination resource menu, and select Activate.

The Nexset data will not be sent to the ZapSign endpoint until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.