UTR list

OpenAPI V2

Validate the XBRL report custom units used against the UTR list.

post

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 · min: 1required

file id (UUID) or instance content as base64 string

Example: PD94bWwgdmVyc2lvbj...

fileNamestring | nullableoptional

esmaYearstring | nullableoptional

EsmaYear is optional parameter that has default value 2024. If you want to validate for 2023 you can send 2023 in the field.

Responses

application/json

objectoptional

application/json

post

HTTPcURLJavaScriptPython

POST /validation/instance/utr HTTP/1.1
Host: 
Authorization: Bearer JWT
x-api-version: text
Content-Type: application/json
Accept: */*
Content-Length: 81

{
  "idOrBase64Content": "PD94bWwgdmVyc2lvbj...",
  "fileName": "text",
  "esmaYear": "text"
}

{
  "location": "/status/292134BE13008671",
  "filteredLocation": "/status/292134BE13008671",
  "jobId": "292134BE13008671"
}