Hash codes

OpenAPI V2

Validate hash codes for a single file or a reporting package.

post

Validate the hash codes for a single file or per reporting package provided including reporting pakcage JSON hash file.

Authorizations

Header parameters

x-api-versionstringrequired

ApplicationNameanyoptional

Name of the application to integrates with API’s to Semansys.Next.

PartnerNameanyoptional

Contract owner (organization) name that have embedded the API’s.

PartnerIDanyoptional

Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s.

CustomerNameanyoptional

Customer (organization) name (ie. accounting firm, intermediary, ....).

CustomerIDanyoptional

Business Identification Number (BIN) of the customer.

ClientNameanyoptional

Client (organization) name of the customer of the accounting firm, intermediary...

ClientIDanyoptional

Business Identification Number (BIN) of the client.

Body

idOrBase64Contentstring · byterequired

The file content represented as Base64 string

Example: UEsDBBQ...

fileNamestring · min: 1required

The name of the file.

Example: My report.xbr

fileExtensionstring · min: 1required

The extension of the file.

Example: .xbr

providedHashstring | nullableoptional

Either provide an Overall hash code or a Json file

jsonIdOrBase64Contentstring · byte | nullableoptional

Either provide an Overall hash code or a Json file

Example: UEsDBBQ...

Responses

application/json

objectoptional

application/json

post

HTTPcURLJavaScriptPython

POST /validation/hash-codes HTTP/1.1
Host: 
Authorization: Bearer JWT
x-api-version: text
Content-Type: application/json
Accept: */*
Content-Length: 143

{
  "idOrBase64Content": "UEsDBBQ...",
  "fileName": "My report.xbr",
  "fileExtension": ".xbr",
  "providedHash": "text",
  "jsonIdOrBase64Content": "UEsDBBQ..."
}

{
  "hashResult": {
    "reportingPackageHash": "nKDBo115PBhw3U3Y=",
    "isReportingPackageHashValid": "Invalid",
    "fileList": [
      {
        "fileName": "My report.xbrl",
        "fileHash": "11xrvYBwFw5htgf=",
        "isFileHashValid": "Invalid",
        "fileSize": "3.212890625",
        "isFolder": true
      }
    ],
    "folderStructure": {
      "name": "My folder",
      "subFolders": [
        {
          "name": "My folder",
          "subFolders": [
            "[Circular Reference]"
          ],
          "files": [
            {
              "fileName": "My report.xbrl",
              "fileHash": "11xrvYBwFw5htgf=",
              "isFileHashValid": "Invalid",
              "fileSize": "3.212890625",
              "isFolder": true
            }
          ]
        }
      ],
      "files": [
        {
          "fileName": "My report.xbrl",
          "fileHash": "11xrvYBwFw5htgf=",
          "isFileHashValid": "Invalid",
          "fileSize": "3.212890625",
          "isFolder": true
        }
      ]
    }
  }
}