# Document details and status

{% get /%}
{% path text="/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

{% codetab %}

cURL

```shell
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}'
```

C#

```csharp
var apiClient = new ApiClient("https://api.boldsign.com", "Your_API_Key");

var documentClient = new DocumentClient(apiClient);
var documentProperties = documentClient.GetProperties("YOUR_DOCUMENT_ID");
```

Python

```python
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

```php
<?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');
```

Java

```java
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");
```

NodeJS

```js
import { DocumentApi } from "boldsign";

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

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

{% /codetab %}

## Query parameters

{% nestedtable %}

- {% arguments name="documentId" /%}{% batch datatype="string" /%}{% required /%}
- The ID of the document, from which the details should be fetched.

{% /nestedtable %}

## Example response

***200 Success***

```json
{
  "documentId": "8f59295d-xxxx-xxxx-xxxx-e7dc88cfff2c",
  "brandId": "6f4020a7-xxxx-xxxx-xxxx-ef071e143867",
  "messageTitle": "Agreement",
  "documentDescription": "",
  "status": "Completed",
  "files": [
    {
      "id": "2f0df291-xxxx-xxxx-xxxx-97719d93c8b7",
      "documentName": "Agreement.png",
      "order": 0,
      "pageCount": 1,
      "templateName": "",
      "templateId": ""
    }
  ],
  "senderDetail": {
    "name": "Richard",
    "privateMessage": null,
    "emailAddress": "richard@cubeflakes.com",
    "isViewed": false
  },
  "signerDetails": [
    {
      "id": "1bd3cb81-xxx-xxx-xxx-856a113d610d",
      "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",
      "signType": "Single",
      "groupId": "",
      "hostEmail": "",
      "hostName": "",
      "isReassigned": false,
      "privateMessage": "",
      "allowFieldConfiguration": false,
      "idVerification": {
        "type": "EveryAccess",
        "maximumRetryCount": 3,
        "status": "Completed",
        "nameMatcher": "Strict",
        "requireLiveCapture": true,
        "requireMatchingSelfie": true,
        "holdForPrefill": false,
        "prefillCompleted": false,
        "allowedDocumentTypes": [
          "Passport",
          "IDCard",
          "DriverLicense"
        ],
        "allowedCountries": [
          "IN",
          "US",
          "CA",
          "AU"
        ]
      },
      "formFields": [
        {
          "id": "signature_NyLQ2",
          "formFieldId": "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",
      "recipientNotificationSettings": {
        "signatureRequest": true,
        "declined": true,
        "revoked": true,
        "signed": true,
        "completed": true,
        "expired": true,
        "reassigned": true,
        "deleted": true,
        "reminders": true,
        "editRecipient": true,
        "editDocument": true
      },
      "authenticationRetryCount": null
    }
  ],
  "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,
  "metaData": {
    "DocumentType": "NDA",
    "DocumentCategory": "Legal"
  },
  "recipientNotificationSettings": {
    "signatureRequest": true,
    "declined": true,
    "revoked": true,
    "signed": true,
    "completed": true,
    "expired": true,
    "reassigned": true,
    "deleted": true,
    "reminders": true,
    "editRecipient": true,
    "editDocument": true,
    "viewed": false
  },
  "scheduledSendTime": 1743294659,
  "groupSignerSettings": {
    "enabled": true,
    "allowedDirectories": [
      "Group1"
    ]
  }
}
```