UTR list

OpenAPI V2

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

post

Authorizations

Bearer

AuthorizationstringRequired

Please enter token

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

application/json

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

202

Accepted

application/json

locationstring · nullableOptional

Job status location

Example: /status/292134BE13008671

filteredLocationstring · nullableOptional

Job status for filtered messages location

Example: /status/292134BE13008671

jobIdstring · nullableOptional

Job identifier

Example: 292134BE13008671

400

Bad Request

application/json

401

Unauthorized

post

/validation/instance/utr

HTTPcURLJavaScriptPython

POST /validation/instance/utr HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
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"
}