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