POST api/document/upload

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Name	Type	Additional information
Id	integer	None.
BusinessId	integer	None.
Guid	string	None.
Type	DocumentType	None.
Size	integer	None.
Description	string	None.
Created	date	None.
Modified	date	None.
Location	DocumentLocation	None.
Extension	DocumentExtensionType	None.
FileName	string	None.
IsMicrosoftOfficeDocument	boolean	None.
Dossier	boolean	None.
DossierCategoryKey	string	None.
Certificate	boolean	None.
CertificateCategoryKey	string	None.
HasDigitalSignatureFields	boolean	None.
DigitalSigningStatus	DocumentSigningStatus	None.
Data	Collection of byte	None.
Links	DocumentLinks	None.
Temporary	boolean	None.
AutoCreated	boolean	None.
PublishAllowed	boolean	None.
Extranet	boolean	None.
SharedWithOffices	Collection of BusinessSummary	None.
SharedWithCustomGroups	Collection of BusinessSummary	None.
SharedWithGroups	Collection of BusinessSummary	None.
InsuranceDocumentLinkType	InsuranceDocumentLinkType	None.
NumberOfPages	integer	None.
GdprSensitive	boolean	None.
GdprLinkType	DocumentGdprLinkType	None.
LinkedEstateActorType	EstateActorType	None.
DocumentDigitalSignature		None.

Response Formats

application/json, text/json

Sample:

{
  "id": 1,
  "businessId": 1,
  "guid": "sample string 2",
  "type": "DOCUMENT",
  "size": 3,
  "description": "sample string 4",
  "created": "2025-11-18T16:18:41.7201438+01:00",
  "modified": "2025-11-18T16:18:41.7201438+01:00",
  "location": {
    "path": "sample string 1",
    "name": "sample string 2",
    "url": "sample string 3",
    "originalName": "sample string 4",
    "fullPath": "sample string 1\\sample string 2",
    "fileStoreId": 1,
    "fileStoreRef": "sample string 5"
  },
  "extension": "AMR",
  "fileName": "sample string 4",
  "isMicrosoftOfficeDocument": false,
  "dossier": true,
  "dossierCategoryKey": "sample string 8",
  "certificate": true,
  "certificateCategoryKey": "sample string 10",
  "hasDigitalSignatureFields": true,
  "digitalSigningStatus": "NoAction",
  "data": "QEA=",
  "links": {
    "contactGroupIds": [
      1,
      2
    ],
    "businessIds": [
      1,
      2
    ],
    "estateIds": [
      {
        "estateId": 1,
        "estateDocumentLinkType": "OTHER"
      },
      {
        "estateId": 1,
        "estateDocumentLinkType": "OTHER"
      }
    ],
    "loginDocumentLinks": [
      {
        "loginId": 1,
        "loginDocumentType": "ADVANCE_ON_COMMISSION"
      },
      {
        "loginId": 1,
        "loginDocumentType": "ADVANCE_ON_COMMISSION"
      }
    ],
    "insuranceCustomerDocumentLinks": [
      {
        "insuranceCustomerId": 1,
        "insuranceAccountId": 1,
        "insuranceDocumentLinkType": "EMBELISHMENT"
      },
      {
        "insuranceCustomerId": 1,
        "insuranceAccountId": 1,
        "insuranceDocumentLinkType": "EMBELISHMENT"
      }
    ],
    "insuranceIds": [
      {
        "insuranceId": 1,
        "insuranceDocumentLinkType": "EMBELISHMENT"
      },
      {
        "insuranceId": 1,
        "insuranceDocumentLinkType": "EMBELISHMENT"
      }
    ],
    "cadastrallInformationDocumentLink": {
      "cadastrallInformationId": 1,
      "linkType": "INFO"
    },
    "leadPaymentIds": [
      1,
      2
    ]
  },
  "temporary": true,
  "autoCreated": true,
  "publishAllowed": true,
  "extranet": true,
  "sharedWithOffices": [
    {
      "shortAddress": {
        "id": 1,
        "street": "sample string 1",
        "houseNumber": 1,
        "houseNumberExtension": "sample string 2",
        "mailBox": "sample string 3",
        "zipCode": "sample string 4",
        "city": "sample string 5",
        "country": "AD",
        "residence": "sample string 6"
      },
      "phoneNumber": "sample string 1",
      "email": "sample string 2",
      "name": "sample string 6",
      "subName": "sample string 7",
      "id": 1
    },
    {
      "shortAddress": {
        "id": 1,
        "street": "sample string 1",
        "houseNumber": 1,
        "houseNumberExtension": "sample string 2",
        "mailBox": "sample string 3",
        "zipCode": "sample string 4",
        "city": "sample string 5",
        "country": "AD",
        "residence": "sample string 6"
      },
      "phoneNumber": "sample string 1",
      "email": "sample string 2",
      "name": "sample string 6",
      "subName": "sample string 7",
      "id": 1
    }
  ],
  "sharedWithCustomGroups": [
    {
      "shortAddress": {
        "id": 1,
        "street": "sample string 1",
        "houseNumber": 1,
        "houseNumberExtension": "sample string 2",
        "mailBox": "sample string 3",
        "zipCode": "sample string 4",
        "city": "sample string 5",
        "country": "AD",
        "residence": "sample string 6"
      },
      "phoneNumber": "sample string 1",
      "email": "sample string 2",
      "name": "sample string 6",
      "subName": "sample string 7",
      "id": 1
    },
    {
      "shortAddress": {
        "id": 1,
        "street": "sample string 1",
        "houseNumber": 1,
        "houseNumberExtension": "sample string 2",
        "mailBox": "sample string 3",
        "zipCode": "sample string 4",
        "city": "sample string 5",
        "country": "AD",
        "residence": "sample string 6"
      },
      "phoneNumber": "sample string 1",
      "email": "sample string 2",
      "name": "sample string 6",
      "subName": "sample string 7",
      "id": 1
    }
  ],
  "sharedWithGroups": [
    {
      "shortAddress": {
        "id": 1,
        "street": "sample string 1",
        "houseNumber": 1,
        "houseNumberExtension": "sample string 2",
        "mailBox": "sample string 3",
        "zipCode": "sample string 4",
        "city": "sample string 5",
        "country": "AD",
        "residence": "sample string 6"
      },
      "phoneNumber": "sample string 1",
      "email": "sample string 2",
      "name": "sample string 6",
      "subName": "sample string 7",
      "id": 1
    },
    {
      "shortAddress": {
        "id": 1,
        "street": "sample string 1",
        "houseNumber": 1,
        "houseNumberExtension": "sample string 2",
        "mailBox": "sample string 3",
        "zipCode": "sample string 4",
        "city": "sample string 5",
        "country": "AD",
        "residence": "sample string 6"
      },
      "phoneNumber": "sample string 1",
      "email": "sample string 2",
      "name": "sample string 6",
      "subName": "sample string 7",
      "id": 1
    }
  ],
  "insuranceDocumentLinkType": "EMBELISHMENT",
  "numberOfPages": 1,
  "gdprSensitive": true,
  "gdprLinkType": "OTHER",
  "linkedEstateActorType": "UNDEFINED",
  "documentDigitalSignature": {
    "id": 1,
    "status": "NoAction",
    "signingTypes": [],
    "selectedSigningTypes": [
      "sample string 1",
      "sample string 2"
    ],
    "sessionID": 1,
    "contactsDigitalSignature": [],
    "containsContacts": false,
    "documentId": 1,
    "documentName": "sample string 4",
    "canDeleteSession": true,
    "canRevokeSession": false,
    "canSendDocumentSigningSessionInvitation": false,
    "isFullyDigitallySigned": false,
    "hasFaultyStatus": false,
    "lastModified": "2025-11-18T16:18:41.7201438+01:00"
  }
}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.