Full
OpenAPI V2
Validate the XBRL report to various validation types (various XBRL specifications and conformance suites).
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: 1RequiredExample:
file id (UUID) or instance content as base64 string
PD94bWwgdmVyc2lvbj...
fileNamestring | nullableOptional
validationTypesstring[] | nullableOptionalExample:
["xbrlCore","xbrlDimensions","inlineXbrl","xbrlCalculation","formulaAssertions","uniform","duplicates"]
Responses
202
Accepted
application/json
400
Bad Request
application/json
401
Unauthorized
post
POST /validation/instance/full HTTP/1.1
Host:
Authorization: Bearer JWT
x-api-version: text
Content-Type: application/json
Accept: */*
Content-Length: 187
{
"idOrBase64Content": "PD94bWwgdmVyc2lvbj...",
"fileName": "string",
"validationTypes": [
"xbrlCore",
"xbrlDimensions",
"inlineXbrl",
"xbrlCalculation",
"formulaAssertions",
"uniform",
"duplicates"
]
}
{
"location": "/status/292134BE13008671",
"filteredLocation": "/status/292134BE13008671",
"jobId": "292134BE13008671"
}
Was this helpful?