Document details and status

get/v1/document/properties

The document's entire details, such as its current status, description, sender and signer details, added form fields, document history, etc., can be fetched by specifying the document ID.

On successful get, the entire document's details will be returned. Particular document details can be accessed by the users involved in the document, the team admin, and the account admin. If any other user accesses the document, the unauthorized response will be returned.

Code snippet

curl -X 'GET' \ 'https://api.boldsign.com/v1/document/properties?documentId=8f59295d-xxxx-xxxx-xxxx-e7dc88cfff2c' \
     -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 documentProperties = documentClient.GetProperties("8f59295d-xxxx-xxxx-xxxx-e7dc88cfff2c");

import requests

url = "https://api.boldsign.com/v1/document/properties?documentId=8f59295d-xxxx-xxxx-xxxx-e7dc88cfff2c"

payload={}
headers = {
  'accept': 'application/json',
  'X-API-KEY': '{your-api-key}'
}

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

const axios = require('axios');
const response = await axios.get('https://api.boldsign.com/v1/document/properties', {
    params: {
        'documentId': '8f59295d-xxxx-xxxx-xxxx-e7dc88cfff2c'
    },
    headers: {
        'accept': 'application/json',
        'X-API-KEY': '{your API key}'
    }
});

Query parameters

documentIdstringRequired

The ID of the document, from which the details should be fetched.

Example response

200 Success

{
  "documentId": "8f59295d-xxxx-xxxx-xxxx-e7dc88cfff2c",
  "brandId": "6f4020a7-xxxx-xxxx-xxxx-ef071e143867",
  "messageTitle": "Agreement",
  "documentDescription": "",
  "status": "Completed",
  "files": [
    {
      "documentName": "Agreement.png",
      "order": 0,
      "pageCount": 1
    }
  ],
  "senderDetail": {
    "name": "Richard",
    "privateMessage": null,
    "emailAddress": "richard@cubeflakes.com",
    "isViewed": false
  },
  "signerDetails": [
    {
      "signerName": "Alex Gayle",
      "signerRole": "",
      "signerEmail": "alexgayle@cubeflakes.com",
      "status": "Completed",
      "enableAccessCode": false,
      "isAuthenticationFailed": null,
      "enableEmailOTP": false,
      "authenticationType": "IdVerification",
      "isDeliveryFailed": false,
      "isViewed": false,
      "order": 1,
      "signerType": "Signer",
      "hostEmail": "",
      "hostName": "",
      "isReassigned": false,
      "privateMessage": "",
      "allowFieldConfiguration": false,
      "idVerification": {
        "type": "EveryAccess",
        "maximumRetryCount": 3,
        "status": "Completed",
        "nameMatcher": "Strict",
        "requireLiveCapture": true,
        "requireMatchingSelfie": true,
        "holdForPrefill": false,
        "prefillCompleted": false
      },
      "formFields": [
        {
          "id": "signature_NyLQ2",
          "type": "signature",
          "value": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAMwAAAB...",
          "font": "Helvetica",
          "isRequired": false,
          "isReadOnly": false,
          "lineHeight": 14,
          "fontSize": 12,
          "fontColor": "#000000",
          "isUnderline": false,
          "isItalic": false,
          "isBold": false,
          "groupName": "",
          "placeholder": "",
          "validationtype": "None",
          "validationCustomRegex": "",
          "validationCustomRegexMessage": "",
          "dateFormat": "",
          "imageInfo": null,
          "attachmentInfo": null,
          "fileInfo": null,
          "editableDateFieldSettings": null,
          "conditionalLogic": [],
          "hyperlinkText": "",
          "dropdownOptions": [],
          "bounds": {
            "x": 257.74194,
            "y": 109.870964,
            "width": 124,
            "height": 32
          },
          "pageNumber": 1,
          "dataSyncTag": "",
          "textAlign": "Left",
          "textDirection": "LTR",
          "characterSpacing": 0
        }
      ],
      "language": 0,
      "locale": "EN",
    }
  ],
  "behalfOf": null,
  "ccDetails": [],
  "reminderSettings": {
    "enableAutoReminder": false,
    "reminderDays": 0,
    "reminderCount": 0
  },
  "reassign": [],
  "documentHistory": [
    {
      "id": "833cdec4-xxxx-xxxx-xxxx-14a8ce1558a0",
      "name": "Alex Gayle",
      "email": "alexgayle@cubeflakes.com",
      "toName": "",
      "toEmail": "",
      "ipaddress": "49.37.215.213",
      "action": "Signed",
      "timestamp": 1663611441
    },
    {
      "id": "c6e21ecb-xxxx-xxxx-xxxx-17ce71d5794e",
      "name": "Alex Gayle",
      "email": "alexgayle@cubeflakes.com",
      "toName": "",
      "toEmail": "",
      "ipaddress": "49.37.215.213",
      "action": "Completed",
      "timestamp": 1663611441
    }
  ],
  "activityBy": "richard@cubeflakes.com",
  "activityDate": 1663611440,
  "activityAction": "Viewed",
  "createdDate": 1663611440,
  "expiryDays": 60,
  "expiryDate": null,
  "enableSigningOrder": false,
  "isDeleted": false,
  "revokeMessage": "",
  "declineMessage": "",
  "applicationId": "",
  "labels": [],
  "disableEmails": false,
  "disableExpiryAlert": true,
  "hideDocumentId": false,
  "enablePrintAndSign": false,
  "enableReassign": true
}