RemoteDocumentView

classificationStatusstring

Status of the classification process.

Example: COMPLETED

documentClass object

documentClassCodestring

Class code of the document.

Example: DPE

documentClassIdentifierstring

Unique identifier of the class.

Example: aaaa-bbbb-cccc-dddd

documentClassNames object[]

Names of the class

Array [

localestring

namestring

]

documentReferences object[]

Array [

documentationIdentifierstring

If the reference is in a documentation, it is the identifier of the documentation.

Example: aaaa-bbbb-cccc-dddd

entityIdentifierstring

Identifier of the targeted reference.

Example: aaaa-bbbb-cccc-dddd

folder object

identifierstring

Unique identifier of a folder.

Example: aaaa-bbbb-cccc-dddd

names object[]

Names of the folder in different languages.

Array [

localestring

namestring

]

referencedEntityTypestring

As a document can be in different location called "references", this field indicates the type of the reference like ASSET, ORGANIZATION, CONTRACT

Example: ASSET

]

fileResource object

contentTypestring

Content type of the file.

Example: application/pdf

identifierstring

Identifier of stored file. This identifier is the AWS S3 identifier

Example: aaaa-bbbb-cccc-dddd

importDatestring

Date at which the file was imported in the system. It is in ISO 8601 format.

Example: YYYY-MM-DDTHH:MM:SSZ

namestring

Name of the file. It is the same as the name of the document

Example: My file.pdf

hashstring

Hash generated from the document content with SHA-256 algorithm.

Example: e2994d1d2a0c9ef00fc77870216e3b078a8d8befd7023e742b16cc10325b56f7

identifierstring

Unique identifier of a document.

Example: aaaa-bbbb-cccc-dddd

isFiledboolean

Boolean that indicates if the document has been filed, meaning it has at least one reference that is a folder.

Example: true

isFiledByAIboolean

Boolean that indicates if the document has been filed by an AI or manually.

Example: true

metadata object

Metadata are information that have been extracted from the document and manually inserted.

property name*string

namestring

Name of the document.

Example: My document.pdf

predictedDocumentClass object

confidentIndexnumber<double>

Confidence rate of the prediction.

Example: 0.97

predictedDocumentClassCodestring

Class code of the class that has been predicted by our IA.

Example: DPE

predictedDocumentClassIdentifierstring

Identifier of the class that has been predicted by our IA.

Example: aaaa-bbbb-cccc-dddd

predictedFolder object

identifierstring

Identifier of the folder of the document that has been predicted by our IA.

Example: aaaa-bbbb-cccc-dddd

names object[]

Names of the folder in different languages.

Array [

localestring

namestring

]

rentedUnits object[]

Information about rented unit(s) associated to the document.

Array [

namestring

Name of the rented unit.

Example: John Doe

uidstring

Unique identifier of a rented unit.

Example: aaaa-bbbb-cccc-dddd

]

suggestedMetadata object

Metadata are information that have been extracted from the document by our IA like the note of a DPE document.

property name*string

tags object[]

Tags are related to the documentation. They are use to give more specification about documents.

Array [

colorstring

Color associated to the tag

Example: purple

namestring

Unique name of a tag for a given documentation.

Example: tag 2000

]

tenants object[]

Information about tenant(s) concerned by the document.

Array [

namestring

Name of the tenant.

Example: John Doe

uidstring

Unique identifier of a tenant.

Example: aaaa-bbbb-cccc-dddd

]

urlAccessstring

Url that give a read only access of the document.

Example: https://platform.stonal.io/organization/STONAL/documents/aaaa-bbbb-cccc-dddd/consult

RemoteDocumentView

{
  "classificationStatus": "COMPLETED",
  "documentClass": {
    "documentClassCode": "DPE",
    "documentClassIdentifier": "aaaa-bbbb-cccc-dddd",
    "documentClassNames": [
      {
        "language": "fr",
        "name": "Dossier de diagnostic de performance énergétique"
      }
    ]
  },
  "documentReferences": [
    {
      "documentationIdentifier": "aaaa-bbbb-cccc-dddd",
      "entityIdentifier": "aaaa-bbbb-cccc-dddd",
      "folder": {
        "identifier": "aaaa-bbbb-cccc-dddd",
        "names": "[{language: 'fr', name: 'Nom'}, {language: 'en', name: 'Name'}]"
      },
      "referencedEntityType": "ASSET"
    }
  ],
  "fileResource": {
    "contentType": "application/pdf",
    "identifier": "aaaa-bbbb-cccc-dddd",
    "importDate": "YYYY-MM-DDTHH:MM:SSZ",
    "name": "My file.pdf"
  },
  "hash": "e2994d1d2a0c9ef00fc77870216e3b078a8d8befd7023e742b16cc10325b56f7",
  "identifier": "aaaa-bbbb-cccc-dddd",
  "isFiled": true,
  "isFiledByAI": true,
  "metadata": "{‘key1’: ‘value1’, ‘key2’: ‘value2’}",
  "name": "My document.pdf",
  "predictedDocumentClass": {
    "confidentIndex": 0.97,
    "predictedDocumentClassCode": "DPE",
    "predictedDocumentClassIdentifier": "aaaa-bbbb-cccc-dddd"
  },
  "predictedFolder": {
    "identifier": "aaaa-bbbb-cccc-dddd",
    "names": [
      {
        "language": "en",
        "name": "My folder"
      }
    ]
  },
  "rentedUnits": "[{‘aaaa-bbbb-cccc-dddd’:‘RENTED_UNIT A’}, {‘aaaa-bbbb-cccc-dddd’:‘RENTED_UNIT B’}]",
  "suggestedMetadata": "{‘key1’: ‘value1’, ‘key2’: ‘value2’}",
  "tags": "[{'name': 'value', 'color': 'purple'}]",
  "tenants": "[{'COMPANY_UID':'company_name'}]",
  "urlAccess": "https://platform.stonal.io/organization/STONAL/documents/aaaa-bbbb-cccc-dddd/consult"
}