API key

The API key authentication is a basic authentication mechanism. It is easy and can be used as an alternative to OAuth for connecting to and authenticating BoldSign's API services. However, make sure that API is part of your plan for generating the API Key.

You can generate up to 4 API keys at once. The generated API keys can be either in the Live or Sandbox environment but no more than 2 in a single environment.

By default, all the scopes will be included when you generate an API key. Currently, this is not customizable.

Generate API key

  1. Navigate to the API menu item in the app's left navigation pane and select API Key.

    API-Key-Step 1

  2. Click the Generate API Key button.

  3. You will be prompted with the Generate API Key dialog.

    API-Key-Step 3

  4. Proceed by clicking the Generate Token button.

  5. Then, copy the API key needed to configure in the HTTP request header from your application.

    API-Key-Step 5


To make an HTTP request with API Key, the request header must include the X-API-KEY. Use the generated API key in the following format.

curl -X GET 'https://api.boldsign.com/v1/document/list' -H 'X-API-KEY: {your API key}'
var apiClient = new ApiClient("https://api.boldsign.com", "API-KEY");
var templateClient = new TemplateClient(apiClient);
var templates = templateClient.ListTemplates(1, 10);
import requests

url = "https://api.boldsign.com/v1/document/list"

headers = {
  'X-API-KEY': '{your API key}'

response = requests.request("GET", url, headers=headers, data=payload)

const axios = require('axios');

const response = await axios.get('https://api.boldsign.com/v1/document/list', {
    headers: {
        'X-API-KEY': '<api-key>'