> ## Documentation Index
> Fetch the complete documentation index at: https://docs.iinkedsign.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Document

<ResponseField name="documentId" type="string">
  Unique identifier for the document.
</ResponseField>

<ResponseField name="packageId" type="string">
  Identifier of the package this document belongs to.
</ResponseField>

<ResponseField name="fileId" type="string">
  Unique identifier for the file associated with the document.
</ResponseField>

<ResponseField name="autoTemplateId" type="string" post={["nullable"]}>
  Auto-template identifier (if created from an auto-template).
</ResponseField>

<ResponseField name="autoTemplateDocumentId" type="string" post={["nullable"]}>
  Auto-template document identifier (if applicable).
</ResponseField>

<ResponseField name="externalId" type="string" post={["nullable"]}>
  External identifier for the document. (optional)
</ResponseField>

<ResponseField name="index" type="number">
  Order/index of the document within the package.
</ResponseField>

<ResponseField name="name" type="string">
  Document display name.
</ResponseField>

<ResponseField name="fileName" type="string">
  Original filename uploaded.
</ResponseField>

<ResponseField name="fileType" type="string">
  File extension or type identifier.
</ResponseField>

<ResponseField name="fileSize" type="number">
  Size of the file in bytes.
</ResponseField>

<ResponseField name="numberPages" type="number">
  Number of pages in the document.
</ResponseField>

<ResponseField name="timeUploaded" type="string">
  Upload time (ISO 8601 date-time).
</ResponseField>

<ResponseField name="timeLastModified" type="string">
  Last modified time (ISO 8601 date-time).
</ResponseField>

<ResponseField name="revisionsSigned" type="number">
  Number of signed revisions for this document.
</ResponseField>

<ResponseField name="revisionsCount" type="number">
  Total number of revisions for this document.
</ResponseField>

<ResponseField name="description" type="string" post={["nullable"]}>
  Description of the document. (optional)
</ResponseField>

<ResponseField name="cac" type="boolean">
  Set to `true` if a CAC (Compliance Audit Certificate) has been appended to the document.
</ResponseField>

<ResponseField name="cacPages" type="number">
  Number of CAC pages if `cac` is `true`.
</ResponseField>

<ResponseField name="state" type="string">
  Current state of the document.

  <Expandable title="values">
    <Tip>
      Most document states are used internally. All documents included in a returned package will always be in the open state.
    </Tip>

    | Values | Description                                          |
    | :----- | :--------------------------------------------------- |
    | open   | The document is open and can be interacted with.     |
    | failed | The document failed to process and cannot be signed. |
  </Expandable>
</ResponseField>

<ResponseField name="revisions" type="object[]">
  Revision history for the document. Typically includes one revision per signer.

  <Expandable title="properties">
    <ResponseField name="documentId" type="string">
      ID of the document this revision belongs to.
    </ResponseField>

    <ResponseField name="revisionId" type="string">
      Unique identifier for the revision.
    </ResponseField>

    <ResponseField name="revisionNumber" type="number">
      Revision number (incrementing integer).
    </ResponseField>

    <ResponseField name="revisionBeforeId" type="string" post={["nullable"]}>
      Identifier of the previous revision this revision replaced. (optional)
    </ResponseField>

    <ResponseField name="timeLastOpened" type="string" post={["nullable"]}>
      Last opened time for the revision (ISO 8601).
    </ResponseField>

    <ResponseField name="signerId" type="string">
      Signer who is associated with this revision.
    </ResponseField>

    <ResponseField name="isSigned" type="boolean">
      Set to `true` if this revision has been signed.
    </ResponseField>

    <ResponseField name="timeSigned" type="string" post={["nullable"]}>
      Time the revision was signed (ISO 8601).
    </ResponseField>

    <ResponseField name="address" type="string" post={["nullable"]}>
      Address metadata captured on sign. (optional)
    </ResponseField>

    <ResponseField name="latitude" type="string" post={["nullable"]}>
      Latitude coordinate captured on sign. (optional)
    </ResponseField>

    <ResponseField name="longitude" type="string" post={["nullable"]}>
      Longitude coordinate captured on sign. (optional)
    </ResponseField>

    <ResponseField name="state" type="string">
      State of the revision (for example: signed, pending).
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="signers" type="object[]">
  Signers associated with this document.

  <Expandable title="properties">
    <ResponseField name="signerId" type="string">
      Identifier for the signer associated with the document.
    </ResponseField>

    <ResponseField name="signerKey" type="string">
      Internal signer key used to map fields/tags.
    </ResponseField>

    <ResponseField name="name" type="string">
      Full name for the signer on this document.
    </ResponseField>

    <ResponseField name="initials" type="string">
      Signer initials.
    </ResponseField>

    <ResponseField name="email" type="string">
      Email for the signer on this document.
    </ResponseField>

    <ResponseField name="mobileNumber" type="string" post={["nullable"]}>
      Mobile number for the signer on this document. (optional)
    </ResponseField>

    <ResponseField name="hasSigned" type="boolean">
      Set to `true` if the signer has signed this document.
    </ResponseField>

    <ResponseField name="isNext" type="boolean">
      Set to `true` if this signer is next in the signing order for this document.
    </ResponseField>

    <ResponseField name="templateRole" type="string" post={["nullable"]}>
      Template role name if the signer was created from a template role. (optional)
    </ResponseField>
  </Expandable>
</ResponseField>
