DocDescriptor
The DocDescriptor object provides definition for the requested document. That is, the object describes a given document.
| Parameter | Type | Description |
|---|---|---|
| DocID | string | A unique identifier associated with a document. This is generated by the Expere engine. |
| DocType | DocumentType | Object defining the format type for a document type (based on an enumerated value). |
| DocDisplayName | string | The document display name associated with the document. This is authored as part of REQ authoring (Document > Properties). |
| DocRootEntityName | string | The root organization associated with the document. |
| DocCustomDataItems | DocCustomDataItem | Array containing an unbound collection of DocCustomDataItem objects. |
| DocumentClass | string | The class designation associated with the document. |
| DocumentTypeDescription | string | A description associated with the document. |
| NegotiableInstrumentFlag | ExpereBoolean | A boolean defining if the document is a negotiated instrument (document). |
| RecordableFlag | ExpereBoolean | A boolean defining if the document is a recorded document. A TRUE value indicates the document is recorded; a FALSE value indicates it is non-recordable. |
| FormNumber | string | The form number identifier for the document. For example, a VMP form number. |
| LogoSupport | boolean | A true or false value is used to determine whether the document supports logos. |
| DocumentList | boolean | Object used to create a list of all documents included in a given package; values are "true" and "false." Within DocumentList in the response, individual DocumentID elements contain the documents to be included in the document list. |
| ESignatureDocument | boolean | A true or false value is used to determine whether to incorporate signature fields and also indicates if the document is esignable. |
| SmartDoc | string | A string of alphanumeric characters used to indicate the SMART Doc document version. The value should be "1.02." |
| PartialDocumentList | boolean | Object used to create a list of all documents included in a given package; values are "true" and "false." Within PartialDocumentLIst in the response, individual DocumentID elements contain the documents to be included in the partial document list. |
| Vault | boolean | Indicates if the document can be vaulted. |
| FinancialAsset | boolean | Indicates if the document is a financial asset. |