BoldSign Data Source

BoldSign is an electronic signature and document workflow platform. Follow the instructions below to create a new data flow that ingests data from a BoldSign source in Nexla.

BoldSign

Create a New Data Flow

1. To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Then, select the desired flow type from the list, and click the Create button.

2. Select the BoldSign connector tile from the list of available connectors. Then, select the credential that will be used to connect to the BoldSign instance, and click Next; or, create a new BoldSign credential for use in this flow.

3. In Nexla, BoldSign data sources can be created using pre-built endpoint templates, which expedite source setup for common BoldSign endpoints. Each template is designed specifically for the corresponding BoldSign endpoint, making source configuration easy and efficient.
   • To configure this source using a template, follow the instructions in Configure Using a Template.

   BoldSign sources can also be configured manually, allowing you to ingest data from BoldSign endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
   • To configure this source manually, follow the instructions in Configure Manually.

Configure Using a Template

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common BoldSign endpoints. Each template is designed specifically for the corresponding BoldSign endpoint, making data source setup easy and efficient.

Endpoint Settings

• 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. Click on an endpoint to see more information about it and how to configure your data source for this endpoint.

  Document List

  This endpoint retrieves a paginated list of documents from the BoldSign account, including documents in any status (sent, in-progress, signed, declined, expired, revoked). Use this endpoint to sync the full set of e-signature documents and their current status into a warehouse or reporting system.

  • The Page field is optional and identifies which page of results to retrieve. The default value is 1.
  • The Pagesize field is optional and controls how many records are returned per page. The default value is 5; increase it to reduce the number of round trips needed to retrieve a large document set.

  Document records returned by this endpoint include the document ID. That ID is the input for the Get Document Properties, Download Document, Download Audit Log, and Get Embedded Signing Link endpoints.

  Get Document Properties

  This endpoint retrieves detailed metadata and status for a single document by ID, including signer activity, timestamps, and current document state. Use it to enrich an existing dataset of document IDs with the latest document details.

  • Enter the BoldSign document ID in the Document ID field. This field is required. Document IDs can be obtained from the Document List or List Team Documents endpoints or from upstream Nexla data flows.

  Download Document

  This endpoint downloads the signed or completed document PDF by document ID. Use it to archive executed agreements into a downstream document management system or to attach the executed PDF to records in another system.

  • Enter the BoldSign document ID in the Document ID field. This field is required. Document IDs can be obtained from the Document List endpoint.

  BoldSign only allows the signed PDF to be downloaded after the document has reached a completed state. Filter upstream document records by status before driving this endpoint to avoid unnecessary failed calls.

  Download Audit Log

  This endpoint downloads the audit trail or completion certificate for a document. The audit trail records the full signing history (views, signatures, declines, IP addresses, timestamps) and is typically retained for compliance.

  • Enter the BoldSign document ID in the Document ID field. This field is required.

  Get Embedded Signing Link

  This endpoint generates an embedded signing link that allows a specific signer to sign a document directly inside your application, without leaving for the hosted BoldSign signing page. Use this endpoint to power an in-app signing experience.

  • Enter the BoldSign document ID in the Document ID field. This field is required and identifies the document for which the link is generated.
  • Enter the signer's email address in the Signer Email field. The link will be tied to the signer role that matches this email on the document.
  • Enter the country code for the signer's phone (for example, +1) in the Country Code field if the signing flow requires phone-based multi-factor authentication.
  • Enter the signer's phone number in the Phone Number field if phone-based multi-factor authentication is required.
  • Enter the URL to redirect the signer to after they complete signing in the Redirect URL field. This is typically a confirmation page in your own application.

  Embedded signing links are short-lived and intended for one-time use. Generate a fresh link each time a signer enters the signing flow. For complete details, see the BoldSign embedded signing link documentation.

  List Team Documents

  This endpoint returns a paginated list of documents owned by team members. Use it to sync documents across an entire team into a downstream system without iterating individual users.

  • No endpoint-specific parameters are required. Nexla automatically paginates through all available team documents using the BoldSign page and pageSize query parameters, stopping when no more records are returned.

  List Behalf Users

  This endpoint returns a paginated list of users who can send and sign documents on behalf of the account owner. Use it to sync the set of authorized "send-on-behalf-of" users for governance and access reviews.

  • The Page Number field is optional and identifies which page of results to retrieve. Page numbers start at 1.

  Template List

  This endpoint retrieves a list of reusable templates configured in the BoldSign account. Templates predefine signer roles, fields, and document content for repeated signature requests. Use this endpoint to sync the template catalog into downstream systems or to obtain template IDs for use with the Send Template destination endpoint.

  • The Pagesize field is optional and controls how many records are returned per page. The default value is 10.
  • The Page field is optional and identifies which page of results to retrieve. The default value is 1.

  Get Template Properties

  This endpoint retrieves the full configuration of a single template by ID, including roles, fields, and metadata. Use it to enrich a template catalog with detailed definitions for governance or to drive downstream automation that depends on template structure.

  • Enter the BoldSign template ID in the Template ID field. This field is required. Template IDs can be obtained from the Template List endpoint.

  Brand List

  This endpoint retrieves all brands configured in the BoldSign account. Brands customize the logo, colors, and signer experience for different business units or product lines.

  • No configuration is required for this endpoint beyond selecting it.

  List - SenderIdentity

  This endpoint retrieves a paginated list of sender identities. Sender identities represent verified "from" addresses that can be used when sending documents for signature, allowing the account to send on behalf of multiple verified email addresses.

  • The Page field is optional and identifies which page of results to retrieve. The default value is 1.
  • The Pagesize field is optional and controls how many records are returned per page. The default value is 5.

  List Contacts

  This endpoint returns all contacts in the BoldSign account. Contacts are the saved set of signers and recipients that can be reused across documents.

  • No configuration is required for this endpoint beyond selecting it.

  For complete contact API reference details, see the BoldSign contacts API documentation.

  List Custom Fields

  This endpoint returns all custom fields configured in the BoldSign account. Custom fields extend documents and templates with organization-specific data inputs.

  • No configuration is required for this endpoint beyond selecting it.

  List Teams

  This endpoint retrieves a paginated list of teams configured in the BoldSign account. Teams group users for shared visibility into documents and templates.

  • The Page Number field is optional and identifies which page of results to retrieve.
  • The Page Size field is optional and controls how many records are returned per page.

  This endpoint is paginated, and Nexla automatically advances through pages to retrieve all available teams.

  User List

  This endpoint retrieves a paginated list of users in the BoldSign account, including their roles and status. Use it to sync the BoldSign user base into an identity, HR, or reporting system.

  • The Page field is optional and identifies which page of results to retrieve. The default value is 1.
  • The Pagesize field is optional and controls how many records are returned per page. The default value is 10.

  Get API Credits Count

  This endpoint retrieves the current API credits remaining on the BoldSign plan. Use it to monitor API consumption and to alert when remaining credits fall below a threshold.

  • No configuration is required for this endpoint beyond selecting it.

Endpoint Testing

Once the selected endpoint template has been configured, Nexla can retrieve a sample of the data that will be fetched according to the current settings. This allows users to verify that the source is configured correctly before saving.

• To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

• If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Configure Manually

BoldSign data sources can be manually configured to ingest data from any valid BoldSign API endpoint. Manual configuration provides maximum flexibility for accessing endpoints not covered by pre-built templates or when you need custom API configurations.

With manual configuration, you can also create more complex BoldSign sources, such as sources that use chained API calls to fetch data from multiple endpoints (for example, listing documents and then fetching properties for each) or sources that require custom request parameters.

API Method

1. To manually configure this source, select the Advanced tab at the top of the configuration screen.

2. Select the API method that will be used for calls to the BoldSign API from the Method pulldown menu. The most common methods are:

   • GET: For retrieving data from the API
   • POST: For sending data to the API or triggering actions
   • PUT: For updating existing data
   • PATCH: For partial updates to existing data
   • DELETE: For removing data

API Endpoint URL

3. Enter the URL of the BoldSign API endpoint from which this source will fetch data in the Set API URL field. This should be the complete URL including the protocol (https://) and any required query parameters. BoldSign API endpoints follow the format https://api.boldsign.com/v1/<resource> — for example, https://api.boldsign.com/v1/document/list?page=1&pageSize=10.

Ensure the API endpoint URL is correct and accessible with your current credentials. You can test the endpoint using the Test button after configuring the URL.

Date/Time Macros (API URL)

Optional

Optionally, the API URL can be customized using macros—all macros added to the API URL will be converted into values when Nexla executes the API call. Macros are dynamic placeholders that allow you to create flexible API endpoints that can adapt to different time periods or data requirements. This is useful for BoldSign endpoints that accept date filters to ingest only recently created or modified documents.

Macros are particularly useful for APIs that require date ranges, pagination parameters, or other dynamic values that change between data ingestion runs.

1. To add a macro, type { at the appropriate position in the API URL (within the Set API URL field), and select the desired macro from the dropdown list.

   • {now} – The current datetime
   • {now-1} – The datetime one time unit before the current datetime
   • {now+1} – The datetime one time unit after the current datetime
   • custom – Datetime macros can reference any number of time units before or after the current datetime—for example, enter (now-4) to indicate the datetime four time units before the current datetime

2. Select the format that will be applied to datetime macros from the Date Format for Date/Time Macro pulldown menu. This format will be applied to the base datetime value of the macro—i.e., the value of {now} in {now-1}.

3. Select the datetime unit that will be used to perform mathematical operations in the included macro(s) from the Time Unit for Operations pulldown menu—for example, for the macro {now-1}, when Day is selected, {now-1} will be converted to the datetime one day before the current datetime.

Lookup-Based Macros (API URL)

Optional

Column values from existing lookups can also be included as macros in the API URL. Lookup-based macros allow you to reference data from previously configured data sources or lookups, enabling dynamic API endpoints that can adapt based on existing data. For BoldSign, this is useful for driving record-level endpoints — for example, referencing a list of document IDs to fetch properties for each one.

Lookup-based macros are useful when you need to create API endpoints that reference specific IDs, values, or parameters from other data sources in your Nexla environment.

1. To include a lookup column value macro, select the relevant lookup from the Add Lookups to Supported Macros pulldown menu.

2. Type { at the appropriate position in the API URL, and select the lookup column-based macro from the dropdown list. Lookup-based macros are automatically populated into the macro list when a lookup is selected in the Add Lookups to Supported Macros pulldown menu.

Path to Data

Optional

If only a subset of the data that will be returned by the API endpoint is needed, you can designate the part(s) of the response that should be included in the Nexset(s) produced from this source by specifying the path to the relevant data within the response. This is particularly useful because BoldSign list responses wrap the records in a result array alongside pagination metadata.

For example, when a request call is used to fetch a list of items, the API will typically return an array of records, along with metadata, in the response. By entering the path to the relevant data, you can configure Nexla to treat each element of the returned array as a record.

Path to Data is essential when API responses have nested structures. Without specifying the correct path, Nexla might not be able to properly parse and organize your data into usable records.

• To specify which data should be treated as relevant in responses from this source, enter the path to the relevant data in the Set Path to Data in Response field.

  • For responses in JSON format enter the JSON path that points to the object or array that should be treated as relevant data. JSON paths use dot notation (e.g., $.data.items[*] to access an array of items within a data object).

  • For responses in XML format, enter the XPath that points to the object/array containing relevant data. XPath uses slash notation (e.g., /response/data/item to access item elements within a data element).

  Path to Data Example:

  BoldSign list endpoints return a top-level array named result. For the /document/list endpoint, the path to the response would be entered as $.result[*].

Autogenerate Path Suggestions

Nexla can also autogenerate data path suggestions based on the response from the API endpoint. These suggested paths can be used as-is or modified to exactly suit your needs.

• To use this feature, click the Test button next to the Set API URL field to fetch a sample response from the API endpoint. Suggested data paths generated based on the content & format of the response will be displayed in the Suggestions box below the Set Path to Data in Response field.

• Click on a suggestion to automatically populate the Set Path to Data in Response field with the corresponding path. The populated path can be modified directly within the field if further customization is needed.

  

Metadata

If metadata is included in the response but is located outside of the defined path to relevant data, you can configure Nexla to include this data as common metadata in each record. This is useful when you want to preserve important contextual information that applies to all records but isn't part of the main data array.

For example, BoldSign list responses include pagination details (such as the total record count) alongside the result array. If you have specified the path to the relevant records but want to retain pagination context, you can specify a path to this metadata to include it with each record in the generated Nexset(s).

Metadata paths are particularly useful for preserving API response context like request IDs, timestamps, or summary statistics that apply to all records in the response.

• To specify the location of metadata that should be included with each record, enter the path to the relevant metadata in the Path to Metadata in Response field.

  • For responses in JSON format, enter the JSON path to the object or array that contains the metadata, and for responses in XML format, enter the XPath.

Request Headers

Optional

• If Nexla should include any additional request headers in API calls to this source, enter the headers & corresponding values as comma-separated pairs in the Request Headers field (e.g., header1:value1,header2:value2). Additional headers are often required for content type specifications or custom requirements.

  You do not need to include any headers already present in the credentials. The BoldSign X-API-KEY header is handled automatically by Nexla based on your credential configuration.

Endpoint Testing

After configuring all settings for the selected endpoint, Nexla can retrieve a sample of the data that will be fetched according to the current configuration. This allows users to verify that the source is configured correctly before saving.

• To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

• If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Save & Activate the Source

1. Once all of the relevant steps in the above sections have been completed, click the Create button in the upper right corner of the screen to save and create the new BoldSign 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.