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
200
OK
application/json
post
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
        }
      ]
    }
  }
}

Was this helpful?