How to Retrieve eSignature Document Details

When a sender shares a document with a signer, either the sender or the signer might want to access specific information about the document, such as the value of the form fields, signer name, signer email, etc. BoldSign offers an API that allows users to retrieve information about a document.

Here are code examples in various programming languages demonstrating how to retrieve document information using the BoldSign API:

Code snippet

curl -X 'GET' \
  'https://api.boldsign.com/v1/document/properties?documentId={Your document Id}' \
  -H 'accept: application/json' \
  -H 'X-API-KEY: {Your API Key}'

var apiClient = new ApiClient("https://api.boldsign.com", "{Your API Key}");
var documentClient = new DocumentClient(apiClient);
var documentInformation = documentClient.GetProperties("{Your document Id}");
Console.WriteLine(documentInformation);

import boldsign

configuration = boldsign.Configuration(host = "https://api.boldsign.com", api_key = "YOUR_API_KEY")

with boldsign.ApiClient(configuration) as api_client:

    document_api = boldsign.DocumentApi(api_client)

    document_properties = document_api.get_properties(document_id = "YOUR_DOCUMENT_ID")

<?php require_once "vendor/autoload.php";

use BoldSign\Configuration;
use BoldSign\Api\DocumentApi;

$config = new Configuration();
$config->setHost("https://api.boldsign.com");
$config->setApiKey('YOUR_API_KEY');

$document_api = new DocumentApi($config);

$document_properties = $document_api->getProperties($document_id = 'YOUR_DOCUMENT_ID');

ApiClient client = Configuration.getDefaultApiClient();
client.setBasePath("https://api.boldsign.com");
client.setApiKey("YOUR_API_KEY");

DocumentApi documentApi = new DocumentApi(client);
DocumentProperties documentProperties = documentApi.getProperties("YOUR_DOCUMENT_ID");

import { DocumentApi } from "boldsign"; 

const documentApi = new DocumentApi("https://api.boldsign.com");
documentApi.setApiKey("YOUR_API_KEY");

const documentProperties = documentApi.getProperties("YOUR_DOCUMENT_ID");

In the provided examples, make sure to replace documentId with the actual ID of the document for which you want to retrieve information. After executing the above code snippet, you will receive the desired document information using the API response.