# Welcome

## Semansys API documentation

Welcome to the Semansys API documentation. This comprehensive guide is designed to provide you with detailed information about the API's functionalities and operations. Here you will find everything needed to integrate and utilize our API effectively.

<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-cover data-type="files"></th><th data-hidden></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Getting Started</strong></td><td>Follow the steps to get started with the Semansys API platform.</td><td><a href="/files/8cLx49OSF34ywF6rcSxL">/files/8cLx49OSF34ywF6rcSxL</a></td><td></td><td><a href="/pages/mCJdfWCDXqq765b5Qosc">/pages/mCJdfWCDXqq765b5Qosc</a></td></tr><tr><td><strong>Use Cases</strong></td><td>Descriptions of several use cases that illustrate how the Semansys platform can be integrated.</td><td><a href="/files/3JfUIMSdX9t46qknGy2D">/files/3JfUIMSdX9t46qknGy2D</a></td><td></td><td></td></tr><tr><td><strong>API reference</strong></td><td>The complete API reference guide with the ability to test the APIs.</td><td><a href="/files/JNSHNPAapmQYwtinmzux">/files/JNSHNPAapmQYwtinmzux</a></td><td></td><td><a href="/pages/KNRR3pPiJjmfvuuIjBqd">/pages/KNRR3pPiJjmfvuuIjBqd</a></td></tr></tbody></table>


# Quickstart

Welcome to the Semansys API documentation. Our comprehensive API documentation guides you through the various endpoints, requests, responses, and error codes associated with the Semansys platform.

In this section, you will find detailed explanations about how to integrate with our APIs, including authentication, and best practices to optimize your interaction with our services. Whether you're a developer seeking to incorporate financial data within your applications or a tech enthusiast exploring our offerings, this documentation provides all the necessary information to make your experience seamless and efficient.

We encourage you to explore each endpoint thoroughly, review the examples provided, and utilize the code snippets to enhance your implementation process.

All the details and use cases information can be found in the left menu section or accessed below.

{% content-ref url="/pages/cEHgDv7NGBquDGHeLyQ4" %}
[Taxonomy](/usecases/editor)
{% endcontent-ref %}

{% content-ref url="/pages/e9ZWX0DNQ22wJTCZjyW7" %}
[InputImport](/usecases/openapi)
{% endcontent-ref %}

{% content-ref url="/pages/VsjpFJIUrELNUxi2gJjX" %}
[Validation](/usecases/validation)
{% endcontent-ref %}

{% content-ref url="/pages/oa0XskrCEgbVlYaOnehE" %}
[Delivery](/usecases/interactive-blocks)
{% endcontent-ref %}

{% content-ref url="/pages/DSQqnsAqJPnIRyPgQJ1S" %}
[Rendering](/usecases/integrations)
{% endcontent-ref %}

{% content-ref url="/pages/ZXxfwYY21Yz9PCv9X7ja" %}
[Analyse](/usecases/markdown)
{% endcontent-ref %}

{% content-ref url="/pages/QwHFLVleY7QejI9V4gc3" %}
[Customer Corner](/usecases/images-and-media)
{% endcontent-ref %}


# General

Quickstart

## Guide to getting started with Semansys API platform

### Introduction

The Semansys API platform provides powerful tools and services to enhance your business applications with advanced data processing capabilities. This guide walks you through the process of setting up and integrating the Semansys API platform into your development workflow, from initial registration to building your first application.

### Getting Started

<figure><img src="/files/FzcS5jc6SbgxCIKXZsVL" alt=""><figcaption></figcaption></figure>

<table><thead><tr><th width="59" valign="top">No.</th><th valign="top">Step</th><th valign="top">Description</th></tr></thead><tbody><tr><td valign="top">1.</td><td valign="top">Sign up for an account</td><td valign="top"><ul><li>To begin your journey with Semansys APIs, you'll need to register for an account on the platform:</li><li>Navigate to the Semansys platform website</li><li>Locate the support button in the top right corner of the page</li><li>Click on the support button and select the option to request API credentials</li><li>Complete the registration form with your details, including your name, email address, company information, and intended use case</li><li>Submit your request for API credentials</li><li>The Semansys team will review your application and provide you with the necessary access credentials.</li></ul></td></tr><tr><td valign="top">2.</td><td valign="top">Obtain and secure your API credentials</td><td valign="top"><p>After your registration is approved, you'll receive your API credentials:</p><ul><li>Check your email for confirmation from the Semansys team containing your credentials</li><li><p>Your credentials package will include:</p><ul><li>Client ID: Your unique identifier on the platform</li><li>Client Secret: Your authentication key (treat this like a password)</li></ul></li><li>Store these credentials securely, following best practices for sensitive information</li><li>Consider using environment variables or secure credential management systems rather than hardcoding these values in your application.</li></ul></td></tr><tr><td valign="top">3.</td><td valign="top">Explore the documentation</td><td valign="top"><p>Before diving into development, take time to thoroughly understand the available resources:</p><ul><li>Access the comprehensive API documentation through your account dashboard</li><li><p>Familiarize yourself with:</p><ul><li>Available endpoints and their specific functionalities</li><li>Request and response formats for each endpoint</li><li>Authentication methods and requirements</li><li>Error codes and troubleshooting guides.</li></ul></li><li>Download any available documentation for your preferred programming language</li><li>Review sample code and implementation examples to understand common usage patterns.</li></ul></td></tr><tr><td valign="top">4.</td><td valign="top">Set up your development environment</td><td valign="top"><p>Prepare your development environment to work efficiently with the Semansys APIs:</p><ul><li><p>Install and configure the necessary development tools:</p><ul><li>REST client (such as Postman, Insomnia, or cURL) for testing API endpoints</li><li>IDE or code editor with appropriate plugins for API development</li><li>Version control system to track your integration code.</li></ul></li><li><p>Install required libraries and dependencies for your programming language:</p><ul><li>Authentication libraries</li><li>HTTP client libraries</li><li>JSON/XML parsing utilities.</li></ul></li><li>Configure your environment variables to securely store your API credentials</li><li>Set up logging systems to track API requests and responses during development.</li></ul></td></tr><tr><td valign="top">5.</td><td valign="top">Make test API calls</td><td valign="top"><p>Before full integration, verify your setup with test API calls:</p><ul><li>Start with simple endpoints that require minimal parameters</li><li>Use sample requests provided in the documentation as templates</li><li>Test the authentication flow to ensure your credentials are working correctly</li><li>Examine the responses carefully to understand the data structure</li><li>Experiment with different parameters to see how they affect the results</li><li>Monitor any rate limiting or throttling to understand usage constraints</li><li>Document any issues or unexpected behaviors for future reference or support inquiries.</li></ul></td></tr><tr><td valign="top">6.</td><td valign="top">Build and integrate your application</td><td valign="top"><p>With a solid understanding and testing foundation, begin integrating the APIs into your application:</p><ul><li><p>Design your integration architecture:</p><ul><li>Determine how the Semansys APIs fits into your overall application flow</li><li>Decide whether to use synchronous or asynchronous API calls</li><li>Plan for caching strategies to optimize performance and reduce API calls</li></ul></li><li>Implement authentication handlers to manage tokens and authorization</li><li>Create service layers or wrapper classes to encapsulate API functionality</li><li><p>Develop robust error handling:</p><ul><li>Implement retry logic for transient failures</li><li>Create fallback mechanisms for critical operations</li><li>Design user-friendly error messages</li></ul></li><li>Build data transformation layers to convert between API formats and your application models</li><li>Implement logging and monitoring to track API usage and performance</li><li><p>Develop comprehensive tests for your integration:</p><ul><li>Unit tests for individual components</li><li>Integration tests for end-to-end workflows</li><li>Mock tests to simulate API responses for edge cases.</li></ul></li></ul></td></tr><tr><td valign="top">7.</td><td valign="top">Optimize performance and reliability</td><td valign="top"><p>Enhance your integration for production-level quality:</p><ul><li>Implement caching strategies to reduce unnecessary API calls</li><li>Set up connection pooling for efficient resource utilization</li><li>Develop circuit breakers to handle API outages gracefully</li><li>Configure timeouts appropriately for different types of requests</li><li>Design for scalability by considering batch operations where appropriate</li><li>Monitor and analyze API usage patterns to identify optimization opportunities.</li></ul></td></tr><tr><td valign="top">8.</td><td valign="top">Deploy and monitor</td><td valign="top"><p>Prepare your application for production use:</p><ul><li>Set up different environments (development, staging, production) with appropriate API credentials</li><li><p>Configure monitoring and alerting for API-related metrics:</p><ul><li>Response times</li><li>Error rates</li></ul></li><li>Implement logging that captures important API interactions without exposing sensitive data</li><li>Create dashboards to visualize API performance and usage</li><li>Set up automated alerts for potential issues.</li></ul></td></tr><tr><td valign="top">9.</td><td valign="top">Utilize support resources</td><td valign="top"><p>Take advantage of Semansys support services when needed:</p><ul><li><p>Familiarize yourself with the available support channels:</p><ul><li>Documentation and knowledge base</li><li>Community forums or discussion groups</li><li>Email support</li><li>Dedicated account representative.</li></ul></li><li><p>When contacting support, provide detailed information about your issue:</p><ul><li>Timestamps of problematic requests</li><li>Request and response details (with sensitive information redacted)</li><li>Steps to reproduce the issue</li><li>Environment details.</li></ul></li><li>Stay informed about platform updates through newsletters or release notes</li><li>Participate in webinars or training sessions.</li></ul></td></tr></tbody></table>

By following this comprehensive guide, you'll be well-positioned to successfully integrate and leverage the Semansys API platform in your applications. Remember that effective API integration is an iterative process—start simple, test thoroughly, and gradually expand your implementation as you become more familiar with the platform's capabilities.

The Semansys API platform offers powerful tools to enhance your application's functionality, and with proper implementation, you can create robust, efficient integrations that deliver significant value to your users and your business.


# Environments

Quickstart

The Semansys API platform has two distinct environments:

| Environment    | Usage                                  | URL |
| -------------- | -------------------------------------- | --- |
| **Acceptance** | Development phase with test data.      | ... |
| **Production** | Exclusively for approved applications. | ... |

#### Status Information

To view the availability of these environments, visit our [status page](https://status.semansys.com). Use the status button in the top right corner to go to the [status page](https://status.semansys.com).


# Authentication and authorization

Quickstart

## How to retrieve a bearer token using OAuth password grant flow

### Overview

The OAuth 2.0 password grant flow allows applications to obtain an access token by directly collecting the user's credentials. This guide explains how to implement this flow to retrieve a bearer token using client credentials and user authentication.

### Prerequisites

Before you begin, ensure you have the following credentials:

<table><thead><tr><th width="75.6666259765625">No.</th><th width="147.333251953125">Parameter</th><th>Description</th></tr></thead><tbody><tr><td>1.</td><td><strong>Client ID</strong></td><td>Your application's unique identifier (received from the Semansys support desk).</td></tr><tr><td>2.</td><td><strong>Client secret</strong></td><td>A secret known only to your application and the authorization server (received from the Semansys support desk).</td></tr><tr><td>3.</td><td><strong>Username</strong></td><td>The resource owner's username (the e-mail address used retrieving the API credentials).</td></tr><tr><td>4.</td><td><strong>Password</strong></td><td>The resource owner's password (received from the Semansys support desk).</td></tr></tbody></table>

### Diagram

<figure><img src="/files/ZML3FpuMaz0v5u1Ja64K" alt=""><figcaption></figcaption></figure>

### Implementation steps

#### 1. Prepare the token request

Create a POST request to the token endpoint with the following parameters:

<table><thead><tr><th width="179">Parameter</th><th width="198">Value</th><th>Description</th></tr></thead><tbody><tr><td>grant_type</td><td><code>password</code></td><td>Specifies the OAuth flow type.</td></tr><tr><td>client_id</td><td><em>your_client_id</em></td><td>Your application's unique identifier.</td></tr><tr><td>client_secret</td><td><em>your_client_secret</em></td><td>Your application's secret.</td></tr><tr><td>username</td><td><em>user_username</em></td><td>The resource owner's username.</td></tr><tr><td>password</td><td><em>user_password</em></td><td>The resource owner's password.</td></tr></tbody></table>

#### 2. Send the Request

**Using cURL**

```bash
curl -X POST https://oidc-pre.semansys.com/connect/token \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "grant_type=password" \
  -d "client_id=YOUR_CLIENT_ID" \
  -d "client_secret=YOUR_CLIENT_SECRET" \
  -d "username=USER_USERNAME" \
  -d "password=USER_PASSWORD"
```

**Using JavaScript/Node.js**

```javascript
const axios = require('axios');
const qs = require('querystring');

const data = {
  grant_type: 'password',
  client_id: 'YOUR_CLIENT_ID',
  client_secret: 'YOUR_CLIENT_SECRET',
  username: 'USER_USERNAME',
  password: 'USER_PASSWORD'
};

axios.post('https://oidc-pre.semansys.com/connect/token', 
  qs.stringify(data), 
  {
    headers: {
      'Content-Type': 'application/x-www-form-urlencoded'
    }
  })
  .then(response => {
    console.log('Access Token:', response.data.access_token);
  })
  .catch(error => {
    console.error('Error:', error.response ? error.response.data : error.message);
  });
```

**Using Python**

```python
import requests

url = "https://oidc-pre.semansys.com/connect/token"
payload = {
    "grant_type": "password",
    "client_id": "YOUR_CLIENT_ID",
    "client_secret": "YOUR_CLIENT_SECRET",
    "username": "USER_USERNAME",
    "password": "USER_PASSWORD"
}

response = requests.post(url, data=payload)
response_data = response.json()

print("Access Token:", response_data.get("access_token"))
```

#### 3. Parse the Response

Upon successful authentication, the server will respond with a JSON object containing:

```json
{
  "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "token_type": "bearer",
  "expires_in": 3600,
  "refresh_token": "8xLOxBtZp8",
  "scope": "read write"
}
```

Key response fields:

<table><thead><tr><th width="188.6666259765625">Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>access_token</strong></td><td>The bearer token to use for authentication.</td></tr><tr><td><strong>token_type</strong></td><td>The type of token (always "bearer" in this case).</td></tr><tr><td><strong>expires_in</strong></td><td>Token validity period in seconds.</td></tr><tr><td><strong>refresh_token</strong></td><td>Token used to obtain a new access token when the current one expires.</td></tr><tr><td><strong>scope</strong></td><td>Permissions granted to the access token.</td></tr></tbody></table>

#### 4. Use the bearer token

To use the bearer token for API requests, include it in the Authorization header:

```
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
```

Example request with the bearer token:

```bash
curl -X GET https://api.semansys.com/... \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
```

### Troubleshooting

Common error responses:

<table><thead><tr><th width="167.66668701171875">Error code</th><th width="173.66668701171875">Error text</th><th>Description</th></tr></thead><tbody><tr><td><strong>400</strong></td><td><strong>Bad Request</strong></td><td>Invalid request parameters.</td></tr><tr><td><strong>401</strong></td><td><strong>Unauthorized</strong></td><td>Invalid client credentials.</td></tr><tr><td><strong>403</strong></td><td><strong>Forbidden</strong></td><td>User authentication failed.</td></tr></tbody></table>

If you receive an error, check:

* All required parameters are included and correctly formatted
* Client id and client secret are valid
* User credentials are correct.


# OpenAPI documentation

Quickstart

## OpenAPI specification details

The Semansys API plaform endpoints are described using OpenAPI 3.x, a widely recognized standard for defining REST APIs. This industry-standard specification format provides a comprehensive, machine-readable description of the API's capabilities, resources, and interaction patterns.

### Benefits of OpenAPI 3.x

<table><thead><tr><th width="248.2960205078125" valign="top">Benefit</th><th valign="top">Description</th></tr></thead><tbody><tr><td valign="top"><strong>Interactive documentation</strong></td><td valign="top">The OpenAPI specification enables the generation of interactive documentation, allowing developers to explore and test API endpoints directly through the browser.</td></tr><tr><td valign="top"><strong>Code generation</strong></td><td valign="top">Developers can leverage the specification to automatically generate client libraries and server stubs in various programming languages, significantly reducing implementation time.</td></tr><tr><td valign="top"><strong>Validation</strong></td><td valign="top">API requests and responses can be automatically validated against the specification, ensuring data integrity and reducing debugging time.</td></tr><tr><td valign="top"><strong>Discoverability</strong></td><td valign="top">The specification clearly outlines all available resources, operations, parameters, and data models, making it easier to understand the full capabilities of the API.</td></tr><tr><td valign="top"><strong>Standardization</strong></td><td valign="top">Following the OpenAPI 3.x standard ensures that the API adheres to industry best practices for REST API design and implementation.</td></tr></tbody></table>

### Accessing the OpenAPI Specification

The complete OpenAPI specification for the Semansys API platform is available in both JSON and YAML formats. Developers can:

* View the specification through the interactive documentation portal
* Download the specification files for local use
* Import the specification into API development tools like Postman, Insomnia, or SwaggerHub.

### Key Components in Our OpenAPI Specification

The Semansys API specification includes detailed information about:

* Authentication mechanisms and security requirements
* Available endpoints and their respective HTTP methods
* Request parameters, headers, and body schemas
* Response formats, status codes, and error handling
* Data models and their relationships
* Examples demonstrating correct usage patterns.

This comprehensive approach to API documentation ensures that developers have all the information needed to successfully integrate with the Semansys platform with minimal friction.


# API change policy

Quickstart

The Semansys API platform and its associated policies will naturally evolve over time to accommodate technological advancements, security requirements, and improved functionality. These changes are governed by the following guidelines:

### Change policy guidelines

1. **Potential unannounced changes**: Semansys Technologies BV reserves the right to implement changes to the APIs and related policies without prior notification when necessary.
2. **Advance notification efforts**: For significant changes, especially those that may impact existing integrations (breaking changes), Semansys Technologies BV will make reasonable efforts to inform users in advance.
3. **Limitation of liability**: Semansys Technologies BV shall not be held liable to you or any third parties for modifications to the APIs or policies, or for any adverse effects that may result from such modifications.
4. **Commitment to stability**: Semansys Technologies BV strives to minimize breaking changes whenever possible, prioritizing backward compatibility and stability for our users' implementations.

Users of the Semansys API platform should periodically review the documentation and any communications from Semansys Technologies BV to stay informed about platform updates and policy changes.


# Notification periods

In regard to changes Semansys Technologies BV will strive to adhere to the following notification periods per type of change. Due to our versioning strategy at resource level this API has the possibility to run multiple versions of the same resource at one time. This allows for a window in which both the old and new version are available. Allowing for a gradual move to the new version.

| Type of change       | Notification period                                                                                           | Support period (old version)          |
| -------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------- |
| Non breaking change. | Two weeks.                                                                                                    | No new version.                       |
| Breaking change.     | Two weeks.                                                                                                    | 6 months.                             |
| Critical.            | Due to the nature of these changes we might not be able to follow the normal procedure for change management. | Depends on the severity of the issue. |

### &#xD;API change definitions

#### Non-Breaking Changes

A **non-breaking change** is defined as any modification to the APIs that maintains backward compatibility and does not cause failures in applications that consume those APIs.

Examples of non-breaking changes include:

* Adding new optional fields to existing resources
* Introducing new endpoints
* Adding new operations (GET/PUT/POST/PATCH/DELETE)
* Adding new optional parameters to existing endpoints
* Introducing new versions of a resource

#### Breaking Changes

A **breaking change** is defined as any modification to an API that could potentially cause failures in applications that consume that API.

Examples of breaking changes include:

* Modifying existing JSON elements (changing names, datatypes, patterns, min/max length requirements, etc.)
* Removing JSON elements, endpoints, operations, or parameters
* Adding new required JSON elements to existing structures
* Adding new required parameters to existing endpoints
* Passing the obsoleteDate of a version for a resource


# Legal notices

Quickstart

Your use and access to the API are expressly conditioned on your compliance with the policies and restrictions related to the API. If Semansys Technologies believes that you have violated or attempted to violate any term, condition, or the spirit of these policies or agreements, your right to access and use the API may be temporarily or permanently revoked.


# Taxonomy


# Taxonomy Use Cases


# Entrypoints

{% stepper %}
{% step %}
**Actor(s)**:

User.
{% endstep %}

{% step %}
**Preconditions**:

User has a valid token to access the API.
{% endstep %}

{% step %}
**Alternative Flow** (Incorrect login attempt):

User provides the incorrect token in the authorization header and executes the API call.

The API returns 401 Unauthorized Error.

User contacts support to trouble shoot this error.
{% endstep %}

{% step %}
**Postconditions**:

Successful response in shown from the API.
{% endstep %}
{% endstepper %}

Retrieve the list of taxonomy entrypoints available on the SemansysNext platform.

[Entry points V1](/web-api-v1/api-reference/taxonomy/entrypoints#taxonomy-entrypoints)

[Entry points V2](/web-api-v2/api-reference/taxonomy/entrypoints#taxonomy-entrypoints)

<figure><img src="/files/UEuk6pBJflqQUJkQEeUu" alt=""><figcaption></figcaption></figure>

Retrieve based on the taxonomy ID the entrypoint details and meta data related to it.

[Entry point by Id V1](/web-api-v1/api-reference/taxonomy/entrypoints#taxonomy-entrypoints-id)

[Entry point by Id V2](/web-api-v2/api-reference/taxonomy/entrypoints#taxonomy-entrypoints-id)

<figure><img src="/files/qpGegzenEz7fnvKOMeO0" alt=""><figcaption></figcaption></figure>

**Exceptions:**

401 unauthorized

404 Bad Request

200 Success


# Schema set

{% stepper %}
{% step %}
**Actor(s)**:

User.
{% endstep %}

{% step %}
**Preconditions**:

User has a valid token to access the API.
{% endstep %}

{% step %}
**Alternative Flow** (Incorrect login attempt):

User provides the incorrect token in the authorization header and executes the API call.

The API returns 401 Unauthorized Error.

User contacts support to trouble shoot this error.
{% endstep %}

{% step %}
**Postconditions**:

Successful response in shown from the API.
{% endstep %}
{% endstepper %}

Postcondition details for Schema set

* [API Call details v1:](/web-api-v1/api-reference/taxonomy/entrypoints/schema-set#taxonomy-entrypoints-id-schema-set)
* [API Call details v2:](/web-api-v2/api-reference/taxonomy/entrypoints/schema-set#taxonomy-entrypoints-id-schema-set)

**Exceptions:**

401 unauthorized

404 Bad Request

200 Success

<figure><img src="/files/Ren3MLjfAJGPzkq5fqvF" alt=""><figcaption></figcaption></figure>


# Parameters

{% stepper %}
{% step %}
**Actor(s)**:

User.
{% endstep %}

{% step %}
**Preconditions**:

User has a valid token to access the API.
{% endstep %}

{% step %}
**Alternative Flow** (Incorrect login attempt):

User provides the incorrect token in the authorization header and executes the API call.

The API returns 401 Unauthorized Error.

User contacts support to trouble shoot this error.
{% endstep %}

{% step %}
**Postconditions**:

Successful response in shown from the API.
{% endstep %}
{% endstepper %}

Postcondition details for Parameteres:

Retrieve taxonomy parameters by entrypoint URL (SBR-NL):

[Web Api V1](/web-api-v1/api-reference/taxonomy/entrypoints/parameters#taxonomy-entrypoints-parameters)

[Web Api V2](/web-api-v2/api-reference/taxonomy/entrypoints/parameters#taxonomy-entrypoints-parameters)

<figure><img src="/files/CG5Pd81RxbT4UWSBrUFV" alt=""><figcaption></figcaption></figure>

Retrieve taxonomy parameters by entrypoint ID (SBR-NL).

[Web Api V1](/web-api-v1/api-reference/taxonomy/entrypoints/parameters#taxonomy-entrypoints-parameters)

[Web Api V2](/web-api-v2/api-reference/taxonomy/entrypoints/parameters#taxonomy-entrypoints-id-parameters)

<figure><img src="/files/5uBPwDxDlVk4bLySrTRo" alt=""><figcaption></figcaption></figure>

**Exceptions:**

401 unauthorized

404 Bad Request

200 Success

<figure><img src="/files/VIAss121yX6L1vZmDLjk" alt=""><figcaption></figcaption></figure>


# Table of content

{% stepper %}
{% step %}
**Actor(s)**:

User.
{% endstep %}

{% step %}
**Preconditions**:

User has a valid token to access the API.
{% endstep %}

{% step %}
**Alternative Flow** (Incorrect login attempt):

User provides the incorrect token in the authorization header and executes the API call.

The API returns 401 Unauthorized Error.

User contacts support to trouble shoot this error.
{% endstep %}

{% step %}
**Postconditions**:

Successful response in shown from the API.
{% endstep %}
{% endstepper %}

Retrieve taxonomy table of content (TOC) by entrypoint URL.

[Web Api V1](/web-api-v1/api-reference/taxonomy/entrypoints/table-of-content#taxonomy-entrypoints-table-of-content)

[Web Api V2](/web-api-v2/api-reference/taxonomy/entrypoints/table-of-content#taxonomy-entrypoints-table-of-content)

<figure><img src="/files/K3Y2y1x870qtyinevcdp" alt=""><figcaption></figcaption></figure>

Retrieve taxonomy table of content (TOC) by entrypoint ID.

[Web Api V1](/web-api-v1/api-reference/taxonomy/entrypoints/table-of-content#taxonomy-entrypoints-id-table-of-content)

[Web Api V2](/web-api-v2/api-reference/taxonomy/entrypoints/table-of-content#taxonomy-entrypoints-id-table-of-content)

<figure><img src="/files/Zcy4gPYofIT7eBPdHJec" alt=""><figcaption></figcaption></figure>

**Exceptions:**

401 unauthorized

404 Bad Request

200 Success


# Tables

{% stepper %}
{% step %}
**Actor(s)**:

User.
{% endstep %}

{% step %}
**Preconditions**:

User has a valid token to access the API.
{% endstep %}

{% step %}
**Alternative Flow** (Incorrect login attempt):

User provides the incorrect token in the authorization header and executes the API call.

The API returns 401 Unauthorized Error.

User contacts support to trouble shoot this error.
{% endstep %}

{% step %}
**Postconditions**:

Successful response in shown from the API.
{% endstep %}
{% endstepper %}

Retrieve all taxonomy tables by entrypoint ID.

[Web Api V1](/web-api-v2/api-reference/taxonomy/entrypoints/tables#taxonomy-entrypoints-id-tables)

[Web Api V2](/web-api-v2/api-reference/taxonomy/entrypoints/tables#taxonomy-entrypoints-id-tables)

<figure><img src="/files/S0tNUL8ggNNcHhku1URS" alt=""><figcaption></figcaption></figure>

**Exceptions:**

401 unauthorized

404 Bad Request

200 Success


# Status

{% stepper %}
{% step %}
**Actor(s)**:

User.
{% endstep %}

{% step %}
**Preconditions**:

User has a valid token to access the API.
{% endstep %}

{% step %}
**Alternative Flow** (Incorrect login attempt):

User provides the incorrect token in the authorization header and executes the API call.

The API returns 401 Unauthorized Error.

User contacts support to trouble shoot this error.
{% endstep %}

{% step %}
**Postconditions**:

Successful response in shown from the API.
{% endstep %}
{% endstepper %}

Retrieve all taxonomy tables by entrypoint ID.

[Web Api V1](/web-api-v1/api-reference/taxonomy/entrypoints/tables/status#taxonomy-entrypoints-tables-status-id)

[Web Api V2](/web-api-v2/api-reference/taxonomy/entrypoints/tables/status#taxonomy-entrypoints-tables-status-id)

<figure><img src="/files/vZLgZJ2WdqehJOKBNR7W" alt=""><figcaption></figcaption></figure>

**Exceptions:**

401 unauthorized

404 Bad Request

200 Success


# Presentation

{% stepper %}
{% step %}
**Actor(s)**:

User.
{% endstep %}

{% step %}
**Preconditions**:

User has a valid token to access the API.
{% endstep %}

{% step %}
**Alternative Flow** (Incorrect login attempt):

User provides the incorrect token in the authorization header and executes the API call.

The API returns 401 Unauthorized Error.

User contacts support to trouble shoot this error.
{% endstep %}

{% step %}
**Postconditions**:

Successful response in shown from the API.
{% endstep %}
{% endstepper %}

Retrieve taxonomy presentation structure based on the entrypoint ID.

[Web Api V1](/web-api-v1/api-reference/taxonomy/entrypoints/presentation#taxonomy-entrypoints-id-presentation)

[Web Api V2](/web-api-v2/api-reference/taxonomy/entrypoints/presentation#taxonomy-entrypoints-id-presentation)

<figure><img src="/files/XIzUxrR0OB8bygQFDrTQ" alt=""><figcaption></figcaption></figure>

**Exceptions:**

401 unauthorized

404 Bad Request

200 Success


# Base set response

{% stepper %}
{% step %}
**Actor(s)**:

User.
{% endstep %}

{% step %}
**Preconditions**:

User has a valid token to access the API.
{% endstep %}

{% step %}
**Alternative Flow** (Incorrect login attempt):

User provides the incorrect token in the authorization header and executes the API call.

The API returns 401 Unauthorized Error.

User contacts support to trouble shoot this error.
{% endstep %}

{% step %}
**Postconditions**:

Successful response in shown from the API.
{% endstep %}
{% endstepper %}

Retrieve taxonomy base set presentation structure by the base-set ID.

[Web Api V1](/web-api-v1/api-reference/taxonomy/entrypoints/presentation/base-set-response#taxonomy-entrypoints-presentation-base-set-response)

[Web Api V2](/web-api-v2/api-reference/taxonomy/entrypoints/presentation/base-set-response#taxonomy-entrypoints-presentation-base-set-response)

<figure><img src="/files/FZ4VWORFLMtAqPUQaTxw" alt=""><figcaption></figcaption></figure>

**Exceptions:**

401 unauthorized

404 Bad Request

200 Success


# Base set concept

{% stepper %}
{% step %}
**Actor(s)**:

User.
{% endstep %}

{% step %}
**Preconditions**:

User has a valid token to access the API.
{% endstep %}

{% step %}
**Alternative Flow** (Incorrect login attempt):

User provides the incorrect token in the authorization header and executes the API call.

The API returns 401 Unauthorized Error.

User contacts support to trouble shoot this error.
{% endstep %}

{% step %}
**Postconditions**:

Successful response in shown from the API.
{% endstep %}
{% endstepper %}

Retrieve taxonomy concept node presentation structure by the base-set ID.

[Web Api V1](/web-api-v1/api-reference/taxonomy/entrypoints/presentation/base-set-concept#taxonomy-entrypoints-presentation-base-set-concept)

[Web Api V2](/web-api-v2/api-reference/taxonomy/entrypoints/presentation/base-set-concept#taxonomy-entrypoints-presentation-base-set-concept)

<figure><img src="/files/auUxt8o3J1jhfPXymcZB" alt=""><figcaption></figcaption></figure>

**Exceptions:**

401 unauthorized

404 Bad Request

200 Success


# Calculation

{% stepper %}
{% step %}
**Actor(s)**:

User.
{% endstep %}

{% step %}
**Preconditions**:

User has a valid token to access the API.
{% endstep %}

{% step %}
**Alternative Flow** (Incorrect login attempt):

User provides the incorrect token in the authorization header and executes the API call.

The API returns 401 Unauthorized Error.

User contacts support to trouble shoot this error.
{% endstep %}

{% step %}
**Postconditions**:

Successful response in shown from the API.
{% endstep %}
{% endstepper %}

<figure><img src="/files/mRQ6m6gR9C0ymj8GYgDL" alt=""><figcaption></figcaption></figure>

Retrieve taxonomy calculation structure based on the entrypoint ID.

[Web Api V1](/web-api-v1/api-reference/taxonomy/entrypoints/calculation#taxonomy-entrypoints-id-calculation)

[Web Api V2](/web-api-v2/api-reference/taxonomy/entrypoints/calculation#taxonomy-entrypoints-id-calculation)

**Exceptions:**

401 unauthorized

404 Bad Request

200 Success


# Definition

{% stepper %}
{% step %}
**Actor(s)**:

User.
{% endstep %}

{% step %}
**Preconditions**:

User has a valid token to access the API.
{% endstep %}

{% step %}
**Alternative Flow** (Incorrect login attempt):

User provides the incorrect token in the authorization header and executes the API call.

The API returns 401 Unauthorized Error.

User contacts support to trouble shoot this error.
{% endstep %}

{% step %}
**Postconditions**:

Successful response in shown from the API.
{% endstep %}
{% endstepper %}

Retrieve taxonomy definition structure based on the entrypoint ID.

<figure><img src="/files/bElTxHIbJSDFzZtZ4SDH" alt=""><figcaption></figcaption></figure>

[Web Api V1](/web-api-v1/api-reference/taxonomy/entrypoints/definition#taxonomy-entrypoints-id-definition)

[Web Api V2](/web-api-v2/api-reference/taxonomy/entrypoints/definition#taxonomy-entrypoints-id-definition)

**Exceptions:**

401 unauthorized

404 Bad Request

200 Success


# Csv

{% stepper %}
{% step %}
**Actor(s)**:

User.
{% endstep %}

{% step %}
**Preconditions**:

User has a valid token to access the API.
{% endstep %}

{% step %}
**Alternative Flow** (Incorrect login attempt):

User provides the incorrect token in the authorization header and executes the API call.

The API returns 401 Unauthorized Error.

User contacts support to trouble shoot this error.
{% endstep %}

{% step %}
**Postconditions**:

Successful response in shown from the API.
{% endstep %}
{% endstepper %}

<figure><img src="/files/dKqGgkpY80yXA7peOv42" alt=""><figcaption></figcaption></figure>

Retrieve taxonomy information by taxonomy ID in CSV format.

[Web Api V1](/web-api-v1/api-reference/taxonomy/entrypoints/csv#taxonomy-entrypoints-id-csv)

[Web Api V2](/web-api-v2/api-reference/taxonomy/entrypoints/csv#taxonomy-entrypoints-id-csv)

**Exceptions:**

401 unauthorized

404 Bad Request

200 Success


# Csv zip

{% stepper %}
{% step %}
**Actor(s)**:

User.
{% endstep %}

{% step %}
**Preconditions**:

User has a valid token to access the API.
{% endstep %}

{% step %}
**Alternative Flow** (Incorrect login attempt):

User provides the incorrect token in the authorization header and executes the API call.

The API returns 401 Unauthorized Error.

User contacts support to trouble shoot this error.
{% endstep %}

{% step %}
**Postconditions**:

Successful response in shown from the API.
{% endstep %}
{% endstepper %}

Retrieve taxonomy content in xBRL-CSV (.csv + .JSON) as an archive package.

[Web Api V1](/web-api-v1/api-reference/taxonomy/entrypoints/csv-zip#taxonomy-entrypoints-id-csv-zip)

[Web Api V2](/web-api-v2/api-reference/taxonomy/entrypoints/csv-zip#taxonomy-entrypoints-id-csv-zip)

<figure><img src="/files/GWVhVftKHs00pP8rsDHn" alt=""><figcaption></figcaption></figure>

**Exceptions:**

401 unauthorized

404 Bad Request

200 Success


# Csv placeholder zip

{% stepper %}
{% step %}
**Actor(s)**:

User.
{% endstep %}

{% step %}
**Preconditions**:

User has a valid token to access the API.
{% endstep %}

{% step %}
**Alternative Flow** (Incorrect login attempt):

User provides the incorrect token in the authorization header and executes the API call.

The API returns 401 Unauthorized Error.

User contacts support to trouble shoot this error.
{% endstep %}

{% step %}
**Postconditions**:

Successful response in shown from the API.
{% endstep %}
{% endstepper %}

Retrieve taxonomy content in xBRL-CSV (.csv + .JSON) for HTML placeholder mapping as an archive package.

[Web Api V1](/web-api-v1/api-reference/taxonomy/entrypoints/csv-placeholder-zip#taxonomy-entrypoints-id-csv-placeholder-zip)

[Web Api V2](/web-api-v2/api-reference/taxonomy/entrypoints/csv-placeholder-zip#taxonomy-entrypoints-id-csv-placeholder-zip)

<figure><img src="/files/pp4pOHbH20VVWOac54HB" alt=""><figcaption></figcaption></figure>

**Exceptions:**

401 unauthorized

404 Bad Request

200 Success


# Report extension

{% stepper %}
{% step %}
**Actor(s)**:

User.
{% endstep %}

{% step %}
**Preconditions**:

User has a valid token to access the API.
{% endstep %}

{% step %}
**Alternative Flow** (Incorrect login attempt):

User provides the incorrect token in the authorization header and executes the API call.

The API returns 401 Unauthorized Error.

User contacts support to trouble shoot this error.
{% endstep %}

{% step %}
**Postconditions**:

Successful response in shown from the API.
{% endstep %}
{% endstepper %}

Generate report extension package based on taxonomy metadata and taxonomy extension elements (extension linkroles, extension concepts, extension arcs, extension labels and extension references), instance data (language, entity identifier, entity scheme, unit, period, decimals and data rows) and package metadata (name, identifier, description, version, report package language, publisher, publisher uri, publisher country, report package name, report base64 content, report name, entrypoint, base64 zip files, base64 report package json). For each of the functionality where in our API is produced result file we produce hash of the file that identifies the contents of the file. User can validate the hash value in hash validation functionality and to know if any changes are applied. By default the file hash is disabled, but it can be controlled from the dropdown below.&#x20;

[Web Api V1](/web-api-v1/api-reference/taxonomy/report-extension#taxonomy-report-extension)

[Web Api V2](/web-api-v2/api-reference/taxonomy/report-extension#taxonomy-report-extension)

<figure><img src="/files/YQ1ljka0UbcGR1MAItsY" alt=""><figcaption></figcaption></figure>

**Exceptions:**

401 unauthorized

404 Bad Request

200 Success


# Taxonomy extension

{% stepper %}
{% step %}
**Actor(s)**:

User.
{% endstep %}

{% step %}
**Preconditions**:

User has a valid token to access the API.
{% endstep %}

{% step %}
**Alternative Flow** (Incorrect login attempt):

User provides the incorrect token in the authorization header and executes the API call.

The API returns 401 Unauthorized Error.

User contacts support to trouble shoot this error.
{% endstep %}

{% step %}
**Postconditions**:

Successful response in shown from the API.
{% endstep %}
{% endstepper %}

Generate taxonomy extension based on taxonomy metadata information and taxonomy extension elements (extension linkroles, extension concepts, extension arcs, extension labels and extension references).

[Web Api V1](/web-api-v1/api-reference/taxonomy/taxonomy-extension#taxonomy-taxonomy-extension)

[Web Api V2](/web-api-v2/api-reference/taxonomy/taxonomy-extension#taxonomy-taxonomy-extension)

<figure><img src="/files/JYJgrBa6UqEJBGO1nDsV" alt=""><figcaption></figcaption></figure>

**Exceptions:**

401 unauthorized

404 Bad Request

200 Success


# Link roles

{% stepper %}
{% step %}
**Actor(s)**:

User.
{% endstep %}

{% step %}
**Preconditions**:

User has a valid token to access the API.
{% endstep %}

{% step %}
**Alternative Flow** (Incorrect login attempt):

User provides the incorrect token in the authorization header and executes the API call.

The API returns 401 Unauthorized Error.

User contacts support to trouble shoot this error.
{% endstep %}

{% step %}
**Postconditions**:

Successful response in shown from the API.
{% endstep %}
{% endstepper %}

Retieve list of link roles based on the entrypoint ID provided.

[Web Api V1](/web-api-v1/api-reference/taxonomy/link-roles#taxonomy-id-link-roles)

[Web Api V2](/web-api-v2/api-reference/taxonomy/link-roles#taxonomy-id-link-roles)

<figure><img src="/files/p8bj3OT0nBh5u9g9sf01" alt=""><figcaption></figcaption></figure>

**Exceptions:**

401 unauthorized

404 Bad Request

200 Success


# Concepts

{% stepper %}
{% step %}
**Actor(s)**:

User.
{% endstep %}

{% step %}
**Preconditions**:

User has a valid token to access the API.
{% endstep %}

{% step %}
**Alternative Flow** (Incorrect login attempt):

User provides the incorrect token in the authorization header and executes the API call.

The API returns 401 Unauthorized Error.

User contacts support to trouble shoot this error.
{% endstep %}

{% step %}
**Postconditions**:

Successful response in shown from the API.
{% endstep %}
{% endstepper %}

Retrieve list of concepts based on the entrypoint ID provided.

[Web Api V1](/web-api-v1/api-reference/taxonomy/extension/concepts#taxonomy-extension-id-concepts)

[Web Api V2](/web-api-v2/api-reference/taxonomy/concepts#taxonomy-id-concepts)

<figure><img src="/files/j5ZcsM4Jh6pmHEXmoDkI" alt=""><figcaption></figcaption></figure>

**Exceptions:**

401 unauthorized

404 Bad Request

200 Success


# Package

{% stepper %}
{% step %}
**Actor(s)**:

User.
{% endstep %}

{% step %}
**Preconditions**:

User has a valid token to access the API.
{% endstep %}

{% step %}
**Alternative Flow** (Incorrect login attempt):

User provides the incorrect token in the authorization header and executes the API call.

The API returns 401 Unauthorized Error.

User contacts support to trouble shoot this error.
{% endstep %}

{% step %}
**Postconditions**:

Successful response in shown from the API.
{% endstep %}
{% endstepper %}

Add a new taxonomy to the SemanysNext platform by taxonomy package.

[Web Api V1](/web-api-v1/api-reference/report-package#report-package)

[Web Api V2](/web-api-v2/api-reference/taxonomy/package#taxonomy-package)

<figure><img src="/files/coOb5bHDvGfNKFunyzo5" alt=""><figcaption></figcaption></figure>

**Exceptions:**

401 unauthorized

404 Bad Request

200 Success


# Extension


# Concepts

{% stepper %}
{% step %}
**Actor(s)**:

User.
{% endstep %}

{% step %}
**Preconditions**:

User has a valid token to access the API.
{% endstep %}

{% step %}
**Alternative Flow** (Incorrect login attempt):

User provides the incorrect token in the authorization header and executes the API call.

The API returns 401 Unauthorized Error.

User contacts support to trouble shoot this error.
{% endstep %}

{% step %}
**Postconditions**:

Successful response in shown from the API.
{% endstep %}
{% endstepper %}

Get concepts defined in the extension taxonomy

[Web Api V1](/web-api-v1/api-reference/taxonomy/concepts#taxonomy-id-concepts)

[Web Api V2](/web-api-v2/api-reference/taxonomy/concepts#taxonomy-id-concepts)

<figure><img src="/files/d6M0ZxBeVCiO1IDwugtk" alt=""><figcaption></figcaption></figure>

**Exceptions:**

401 unauthorized

404 Bad Request

200 Success


# Linkroles

{% stepper %}
{% step %}
**Actor(s)**:

User.
{% endstep %}

{% step %}
**Preconditions**:

User has a valid token to access the API.
{% endstep %}

{% step %}
**Alternative Flow** (Incorrect login attempt):

User provides the incorrect token in the authorization header and executes the API call.

The API returns 401 Unauthorized Error.

User contacts support to trouble shoot this error.
{% endstep %}

{% step %}
**Postconditions**:

Successful response in shown from the API.
{% endstep %}
{% endstepper %}

Get Linkroles defied in the extension taxonomy

Web Api V1

Web Api V2

<figure><img src="/files/h8B6Tfl3TPooHUhNCIxw" alt=""><figcaption></figcaption></figure>

**Exceptions:**

401 unauthorized

404 Bad Request

200 Success


# Pivot

{% stepper %}
{% step %}
**Actor(s)**:

User.
{% endstep %}

{% step %}
**Preconditions**:

User has a valid token to access the API.
{% endstep %}

{% step %}
**Alternative Flow** (Incorrect login attempt):

User provides the incorrect token in the authorization header and executes the API call.

The API returns 401 Unauthorized Error.

User contacts support to trouble shoot this error.
{% endstep %}

{% step %}
**Postconditions**:

Successful response in shown from the API.
{% endstep %}
{% endstepper %}

Get Pivot view data for extension taxonomy

[Web Api V1](/web-api-v1/api-reference/taxonomy/extension/pivot#taxonomy-extension-id-pivot)

Web Api V2

<figure><img src="/files/yXe0kM5chXmqs91mjHJ3" alt=""><figcaption></figcaption></figure>

**Exceptions:**

401 unauthorized

404 Bad Request

200 Success


# Entrypoint

{% stepper %}
{% step %}
**Actor(s)**:

User.
{% endstep %}

{% step %}
**Preconditions**:

User has a valid token to access the API.
{% endstep %}

{% step %}
**Alternative Flow** (Incorrect login attempt):

User provides the incorrect token in the authorization header and executes the API call.

The API returns 401 Unauthorized Error.

User contacts support to trouble shoot this error.
{% endstep %}

{% step %}
**Postconditions**:

Successful response in shown from the API.
{% endstep %}
{% endstepper %}

Add a new taxonomy to the SemanysNext platform by URL.

[Web Api V1](/web-api-v1/api-reference/taxonomy/entrypoint#taxonomy-entrypoint)

[Web Api V2](/web-api-v2/api-reference/taxonomy/entrypoint#taxonomy-entrypoint)

<figure><img src="/files/LjbxtLZMOkgsaUPbtl0J" alt=""><figcaption></figcaption></figure>

**Exceptions:**

401 unauthorized

404 Bad Request

200 Success


# InputImport


# Input Import Use Cases


# Hash creation

{% stepper %}
{% step %}
**Actor(s)**:

User.
{% endstep %}

{% step %}
**Preconditions**:

User has a valid token to access the API.
{% endstep %}

{% step %}
**Alternative Flow** (Incorrect login attempt):

User provides the incorrect token in the authorization header and executes the API call.

The API returns 401 Unauthorized Error.

User contacts support to trouble shoot this error.
{% endstep %}

{% step %}
**Postconditions**:

Successful response in shown from the API.
{% endstep %}
{% endstepper %}

Generate hash code for a reporting package and outputs it in JSON format for all file enclosed in the package.

[Web Api V1](/web-api-v1/api-reference/input-import/hash-creation#input-import-hash-creation)

[Web Api V2](/web-api-v2/api-reference/input-import/hash-creation#input-import-hash-creation)

<figure><img src="/files/fAhUmSoqIPqhrEQXOZn2" alt=""><figcaption></figcaption></figure>

**Exceptions:**

401 unauthorized

404 Bad Request

200 Success


# Single file

{% stepper %}
{% step %}
**Actor(s)**:

User.
{% endstep %}

{% step %}
**Preconditions**:

User has a valid token to access the API.
{% endstep %}

{% step %}
**Alternative Flow** (Incorrect login attempt):

User provides the incorrect token in the authorization header and executes the API call.

The API returns 401 Unauthorized Error.

User contacts support to trouble shoot this error.
{% endstep %}

{% step %}
**Postconditions**:

Successful response in shown from the API.
{% endstep %}
{% endstepper %}

Generate hash code for a (single) file.

[Web Api V1](/web-api-v1/api-reference/input-import/hash-creation/single-file#input-import-hash-creation-single-file)

[Web Api V2](/web-api-v2/api-reference/input-import/hash-creation/single-file#input-import-hash-creation-single-file)

<figure><img src="/files/OjAzP0OQA75cl5pL24DF" alt=""><figcaption></figcaption></figure>

**Exceptions:**

401 unauthorized

404 Bad Request

200 Success


# Instance


# Generation

{% stepper %}
{% step %}
**Actor(s)**:

User.
{% endstep %}

{% step %}
**Preconditions**:

User has a valid token to access the API.
{% endstep %}

{% step %}
**Alternative Flow** (Incorrect login attempt):

User provides the incorrect token in the authorization header and executes the API call.

The API returns 401 Unauthorized Error.

User contacts support to trouble shoot this error.
{% endstep %}

{% step %}
**Postconditions**:

Successful response in shown from the API.
{% endstep %}
{% endstepper %}

Generate an XBRL report (.xbrl) from JSON-structured data file containing the reporting data. For each of the functionality where in our API is produced result file we produce hash of the file that identifies the contents of the file. User can validate the hash value in hash validation functionality and to know if any changes are applied. By default the file hash is disabled, but it can be controlled from the dropdown below.

[Web Api V1](/web-api-v1/api-reference/input-import/instance/generation#input-import-instance-generation)

[Web Api V2](/web-api-v2/api-reference/input-import/instance/generation#input-import-instance-generation)

<figure><img src="/files/VutLfksbNg47bccst4d8" alt=""><figcaption></figcaption></figure>

**Exceptions:**

401 unauthorized

404 Bad Request

200 Success


# Csv import

{% stepper %}
{% step %}
**Actor(s)**:

User.
{% endstep %}

{% step %}
**Preconditions**:

User has a valid token to access the API.
{% endstep %}

{% step %}
**Alternative Flow** (Incorrect login attempt):

User provides the incorrect token in the authorization header and executes the API call.

The API returns 401 Unauthorized Error.

User contacts support to trouble shoot this error.
{% endstep %}

{% step %}
**Postconditions**:

Successful response in shown from the API.
{% endstep %}
{% endstepper %}

Generate an XBRL report (.xbrl) from xBRL-CSV-structured data file containing the reporting data. For each of the functionality where in our API is produced result file we produce hash of the file that identifies the contents of the file. User can validate the hash value in hash validation functionality and to know if any changes are applied. By default the file hash is disabled, but it can be controlled from the dropdown below.

[Web Api V1](/web-api-v1/api-reference/input-import/instance/csv-import#input-import-instance-csv-import)

[Web Api V2](/web-api-v2/api-reference/input-import/instance/csv-import#input-import-instance-csv-import)

<figure><img src="/files/ecM5xOCqkgsZkshH9sEE" alt=""><figcaption></figcaption></figure>

**Exceptions:**

401 unauthorized

404 Bad Request

200 Success


# Data

{% stepper %}
{% step %}
**Actor(s)**:

User.
{% endstep %}

{% step %}
**Preconditions**:

User has a valid token to access the API.
{% endstep %}

{% step %}
**Alternative Flow** (Incorrect login attempt):

User provides the incorrect token in the authorization header and executes the API call.

The API returns 401 Unauthorized Error.

User contacts support to trouble shoot this error.
{% endstep %}

{% step %}
**Postconditions**:

Successful response in shown from the API.
{% endstep %}
{% endstepper %}

Generate an JSON output file based on the value available in an digital report in XBRL format.

[Web Api V1](/web-api-v1/api-reference/input-import/instance/data#input-import-instance-data)

[Web Api V2](/web-api-v2/api-reference/input-import/instance/data#input-import-instance-data)

<figure><img src="/files/yTVqFl06jMBoGqYO2uxI" alt=""><figcaption></figcaption></figure>

**Exceptions:**

401 unauthorized

404 Bad Request

200 Success


# Reported facts ai

{% stepper %}
{% step %}
**Actor(s)**:

User.
{% endstep %}

{% step %}
**Preconditions**:

User has a valid token to access the API.
{% endstep %}

{% step %}
**Alternative Flow** (Incorrect login attempt):

User provides the incorrect token in the authorization header and executes the API call.

The API returns 401 Unauthorized Error.

User contacts support to trouble shoot this error.
{% endstep %}

{% step %}
**Postconditions**:

Successful response in shown from the API.
{% endstep %}
{% endstepper %}

Generate mapping, based on AI analytics, of the unstructured import source and a taxonomy.

[Web Api V1](/web-api-v1/api-reference/input-import/instance/reported-facts-ai#input-import-instance-reported-facts-ai)

[Web Api V2](/web-api-v2/api-reference/input-import/instance/reported-facts-ai#input-import-instance-reported-facts-ai)

<figure><img src="/files/9MhAisGqAZ0Z5l3jo4uX" alt=""><figcaption></figcaption></figure>

**Exceptions:**

401 unauthorized

404 Bad Request

200 Success


# Generation ai

{% stepper %}
{% step %}
**Actor(s)**:

User.
{% endstep %}

{% step %}
**Preconditions**:

User has a valid token to access the API.
{% endstep %}

{% step %}
**Alternative Flow** (Incorrect login attempt):

User provides the incorrect token in the authorization header and executes the API call.

The API returns 401 Unauthorized Error.

User contacts support to trouble shoot this error.
{% endstep %}

{% step %}
**Postconditions**:

Successful response in shown from the API.
{% endstep %}
{% endstepper %}

Generate an XBRL report (.xbrl) from xBRL-CSV-structured data file containing the reporting data. For each of the functionality where in our API is produced result file we produce hash of the file that identifies the contents of the file. User can validate the hash value in hash validation functionality and to know if any changes are applied. By default the file hash is disabled, but it can be controlled from the dropdown below.

[Web Api V1](/web-api-v1/api-reference/input-import/instance/generation#input-import-instance-generation)

[Web Api V2](/web-api-v2/api-reference/input-import/instance/generation#input-import-instance-generation)

<figure><img src="/files/OmtXpj5wadtJgTIY79uV" alt=""><figcaption></figcaption></figure>

**Exceptions:**

401 unauthorized

404 Bad Request

200 Success


# Validation


# Validation Use Cases


# Status

{% stepper %}
{% step %}
**Actor(s)**:

User.
{% endstep %}

{% step %}
**Preconditions**:

User has a valid token to access the API.
{% endstep %}

{% step %}
**Alternative Flow** (Incorrect login attempt):

User provides the incorrect token in the authorization header and executes the API call.

The API returns 401 Unauthorized Error.

User contacts support to trouble shoot this error.
{% endstep %}

{% step %}
**Postconditions**:

Successful response in shown from the API.
{% endstep %}
{% endstepper %}

Retrieve job status or job result based on the ID.

[Web Api V1](/web-api-v1/api-reference/validation/status#validation-status-id)

[Web Api V2](/web-api-v2/api-reference/validation/status#validation-status-id)

<figure><img src="/files/wPbLBOHPQIZ6EIY2Azk8" alt=""><figcaption></figcaption></figure>

**Exceptions:**

401 unauthorized

404 Bad Request

200 Success


# Filtered status

{% stepper %}
{% step %}
**Actor(s)**:

User.
{% endstep %}

{% step %}
**Preconditions**:

User has a valid token to access the API.
{% endstep %}

{% step %}
**Alternative Flow** (Incorrect login attempt):

User provides the incorrect token in the authorization header and executes the API call.

The API returns 401 Unauthorized Error.

User contacts support to trouble shoot this error.
{% endstep %}

{% step %}
**Postconditions**:

Successful response in shown from the API.
{% endstep %}
{% endstepper %}

Retrieve job status or job result that includes filtered validation messages.

[Web Api V1](/web-api-v1/api-reference/validation/filtered-status#validation-filtered-status-id)

[Web Api V2](/web-api-v2/api-reference/validation/filtered-status#validation-filtered-status-id)

<figure><img src="/files/3JFKr6iqTxUWorpIKF6r" alt=""><figcaption></figcaption></figure>

**Exceptions:**

401 unauthorized

404 Bad Request

200 Success


# Hash codes

{% stepper %}
{% step %}
**Actor(s)**:

User.
{% endstep %}

{% step %}
**Preconditions**:

User has a valid token to access the API.
{% endstep %}

{% step %}
**Alternative Flow** (Incorrect login attempt):

User provides the incorrect token in the authorization header and executes the API call.

The API returns 401 Unauthorized Error.

User contacts support to trouble shoot this error.
{% endstep %}

{% step %}
**Postconditions**:

Successful response in shown from the API.
{% endstep %}
{% endstepper %}

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

[Web Api V1](/web-api-v1/api-reference/validation/hash-codes#validation-hash-codes)

[Web Api V2](/web-api-v2/api-reference/validation/hash-codes#validation-hash-codes)

<figure><img src="/files/0TYjHj7p4W0WPV0topdO" alt=""><figcaption></figcaption></figure>

**Exceptions:**

401 unauthorized

404 Bad Request

200 Success


# Instance


# Xbrl core

{% stepper %}
{% step %}
**Actor(s)**:

User.
{% endstep %}

{% step %}
**Preconditions**:

User has a valid token to access the API.
{% endstep %}

{% step %}
**Alternative Flow** (Incorrect login attempt):

User provides the incorrect token in the authorization header and executes the API call.

The API returns 401 Unauthorized Error.

User contacts support to trouble shoot this error.
{% endstep %}

{% step %}
**Postconditions**:

Successful response in shown from the API.
{% endstep %}
{% endstepper %}

Validate the XBRL report against XBRL 2.1 specification (Core).

[Web Api V1](/web-api-v1/api-reference/validation/instance/xbrl-core#validation-instance-xbrl-core)

[Web Api V2](/web-api-v2/api-reference/validation/instance/xbrl-core#validation-instance-xbrl-core)

<figure><img src="/files/2P4Covh7VBxgh6SXgZ4O" alt=""><figcaption></figcaption></figure>

**Exceptions:**

401 unauthorized

404 Bad Request

200 Success


# Xbrl dimensions

{% stepper %}
{% step %}
**Actor(s)**:

User.
{% endstep %}

{% step %}
**Preconditions**:

User has a valid token to access the API.
{% endstep %}

{% step %}
**Alternative Flow** (Incorrect login attempt):

User provides the incorrect token in the authorization header and executes the API call.

The API returns 401 Unauthorized Error.

User contacts support to trouble shoot this error.
{% endstep %}

{% step %}
**Postconditions**:

Successful response in shown from the API.
{% endstep %}
{% endstepper %}

Validate the XBRL report against XBRL Dimensional specification.

[Web Api V1](/web-api-v1/api-reference/validation/instance/xbrl-dimensions#validation-instance-xbrl-dimensions)

[Web Api V2](/web-api-v2/api-reference/validation/instance/xbrl-dimensions#validation-instance-xbrl-dimensions)

<figure><img src="/files/bkS8W1aYdt6u1baiaLjJ" alt=""><figcaption></figcaption></figure>

**Exceptions:**

401 unauthorized

404 Bad Request

200 Success


# Inline xbrl

{% stepper %}
{% step %}
**Actor(s)**:

User.
{% endstep %}

{% step %}
**Preconditions**:

User has a valid token to access the API.
{% endstep %}

{% step %}
**Alternative Flow** (Incorrect login attempt):

User provides the incorrect token in the authorization header and executes the API call.

The API returns 401 Unauthorized Error.

User contacts support to trouble shoot this error.
{% endstep %}

{% step %}
**Postconditions**:

Successful response in shown from the API.
{% endstep %}
{% endstepper %}

Validate the Inline XBRL report against the XBRL Inline specification.

[Web Api V1](/web-api-v1/api-reference/validation/instance/inline-xbrl#validation-instance-inline-xbrl)

[Web Api V2](/web-api-v2/api-reference/validation/instance/inline-xbrl#validation-instance-inline-xbrl)

<figure><img src="/files/L4Oag8kKE2OOmcarm5I8" alt=""><figcaption></figcaption></figure>

**Exceptions:**

401 unauthorized

404 Bad Request

200 Success


# Xbrl calculation

{% stepper %}
{% step %}
**Actor(s)**:

User.
{% endstep %}

{% step %}
**Preconditions**:

User has a valid token to access the API.
{% endstep %}

{% step %}
**Alternative Flow** (Incorrect login attempt):

User provides the incorrect token in the authorization header and executes the API call.

The API returns 401 Unauthorized Error.

User contacts support to trouble shoot this error.
{% endstep %}

{% step %}
**Postconditions**:

Successful response in shown from the API.
{% endstep %}
{% endstepper %}

Validate the XBRL report against taxonomy defined Calculation linkbase.

[Web Api V1](/web-api-v1/api-reference/validation/instance/xbrl-calculation#validation-instance-xbrl-calculation)

[Web Api V2](/web-api-v2/api-reference/validation/instance/xbrl-calculation#validation-instance-xbrl-calculation)

<figure><img src="/files/zofhLFQcUvyGbLE2XHnX" alt=""><figcaption></figcaption></figure>

**Exceptions:**

401 unauthorized

404 Bad Request

200 Success


# Formula assertions

{% stepper %}
{% step %}
**Actor(s)**:

User.
{% endstep %}

{% step %}
**Preconditions**:

User has a valid token to access the API.
{% endstep %}

{% step %}
**Alternative Flow** (Incorrect login attempt):

User provides the incorrect token in the authorization header and executes the API call.

The API returns 401 Unauthorized Error.

User contacts support to trouble shoot this error.
{% endstep %}

{% step %}
**Postconditions**:

Successful response in shown from the API.
{% endstep %}
{% endstepper %}

Validate the XBRL report against taxonomy defined Formula Assertions (business rules).

[Web Api V1](/web-api-v1/api-reference/validation/instance/formula-assertions#validation-instance-formula-assertions)

[Web Api V2](/web-api-v2/api-reference/validation/instance/formula-assertions#validation-instance-formula-assertions)

<figure><img src="/files/c6p4jtHCACfcxbBNiiE9" alt=""><figcaption></figcaption></figure>

**Exceptions:**

401 unauthorized

404 Bad Request

200 Success


# Uniform

{% stepper %}
{% step %}
**Actor(s)**:

User.
{% endstep %}

{% step %}
**Preconditions**:

User has a valid token to access the API.
{% endstep %}

{% step %}
**Alternative Flow** (Incorrect login attempt):

User provides the incorrect token in the authorization header and executes the API call.

The API returns 401 Unauthorized Error.

User contacts support to trouble shoot this error.
{% endstep %}

{% step %}
**Postconditions**:

Successful response in shown from the API.
{% endstep %}
{% endstepper %}

Validate the XBRL report against uniformation rules.

[Web Api V1](/web-api-v1/api-reference/validation/instance/uniform#validation-instance-uniform)

[Web Api V2](/web-api-v2/api-reference/validation/instance/uniform#validation-instance-uniform)

<figure><img src="/files/CV7DWDtTmL5v3F2WIpvH" alt=""><figcaption></figcaption></figure>

**Exceptions:**

401 unauthorized

404 Bad Request

200 Success


# Duplicates

{% stepper %}
{% step %}
**Actor(s)**:

User.
{% endstep %}

{% step %}
**Preconditions**:

User has a valid token to access the API.
{% endstep %}

{% step %}
**Alternative Flow** (Incorrect login attempt):

User provides the incorrect token in the authorization header and executes the API call.

The API returns 401 Unauthorized Error.

User contacts support to trouble shoot this error.
{% endstep %}

{% step %}
**Postconditions**:

Successful response in shown from the API.
{% endstep %}
{% endstepper %}

Validate the XBRL report on available duplicates (contexts, unit and facts).

[Web Api V1](/web-api-v1/api-reference/validation/instance/duplicates#validation-instance-duplicates)

[Web Api V2](/web-api-v2/api-reference/validation/instance/duplicates#validation-instance-duplicates)

<figure><img src="/files/H1xn7ob8sDZLRMeIeSu3" alt=""><figcaption></figcaption></figure>

**Exceptions:**

401 unauthorized

404 Bad Request

200 Success


# Utr

{% stepper %}
{% step %}
**Actor(s)**:

User.
{% endstep %}

{% step %}
**Preconditions**:

User has a valid token to access the API.
{% endstep %}

{% step %}
**Alternative Flow** (Incorrect login attempt):

User provides the incorrect token in the authorization header and executes the API call.

The API returns 401 Unauthorized Error.

User contacts support to trouble shoot this error.
{% endstep %}

{% step %}
**Postconditions**:

Successful response in shown from the API.
{% endstep %}
{% endstepper %}

[Web Api V1](/web-api-v1/api-reference/validation/instance/utr#validation-instance-utr)

[Web Api V2](/web-api-v2/api-reference/validation/instance/utr#validation-instance-utr)

<figure><img src="/files/wWYNRrCGyWrMJMeBX0Cu" alt=""><figcaption></figcaption></figure>

**Exceptions:**

401 unauthorized

404 Bad Request

200 Success


# Full

{% stepper %}
{% step %}
**Actor(s)**:

User.
{% endstep %}

{% step %}
**Preconditions**:

User has a valid token to access the API.
{% endstep %}

{% step %}
**Alternative Flow** (Incorrect login attempt):

User provides the incorrect token in the authorization header and executes the API call.

The API returns 401 Unauthorized Error.

User contacts support to trouble shoot this error.
{% endstep %}

{% step %}
**Postconditions**:

Successful response in shown from the API.
{% endstep %}
{% endstepper %}

Validate the XBRL report to various validation types (various XBRL specifications and conformance suites).

[Web Api V1](/web-api-v1/api-reference/validation/instance/full#validation-instance-full)

[Web Api V2](/web-api-v2/api-reference/validation/instance/full#validation-instance-full)

<figure><img src="/files/RSOzVPRr7gPaE52PULG1" alt=""><figcaption></figcaption></figure>

**Exceptions:**

401 unauthorized

404 Bad Request

200 Success


# Filing rules

{% stepper %}
{% step %}
**Actor(s)**:

User.
{% endstep %}

{% step %}
**Preconditions**:

User has a valid token to access the API.
{% endstep %}

{% step %}
**Alternative Flow** (Incorrect login attempt):

User provides the incorrect token in the authorization header and executes the API call.

The API returns 401 Unauthorized Error.

User contacts support to trouble shoot this error.
{% endstep %}

{% step %}
**Postconditions**:

Successful response in shown from the API.
{% endstep %}
{% endstepper %}

<figure><img src="/files/9uGeJKE9ZsoSks2b9kT2" alt=""><figcaption></figcaption></figure>

Validate the XBRL report to filing rules (SBR-NL).

[Web Api V1](/web-api-v1/api-reference/validation/instance/filing-rules#validation-instance-filing-rules)

[Web Api V2](/web-api-v2/api-reference/validation/instance/filing-rules#validation-instance-filing-rules)

**Exceptions:**

401 unauthorized

404 Bad Request

200 Success


# Non present facts

{% stepper %}
{% step %}
**Actor(s)**:

User.
{% endstep %}

{% step %}
**Preconditions**:

User has a valid token to access the API.
{% endstep %}

{% step %}
**Alternative Flow** (Incorrect login attempt):

User provides the incorrect token in the authorization header and executes the API call.

The API returns 401 Unauthorized Error.

User contacts support to trouble shoot this error.
{% endstep %}

{% step %}
**Postconditions**:

Successful response in shown from the API.
{% endstep %}
{% endstepper %}

[Web Api V1](/web-api-v1/api-reference/validation/instance/non-present-facts#validation-instance-non-present-facts)

[Web Api V2](/web-api-v2/api-reference/validation/instance/non-present-facts#validation-instance-non-present-facts)

<figure><img src="/files/I472W8rCL4S4k9RpRiEJ" alt=""><figcaption></figcaption></figure>

**Exceptions:**

401 unauthorized

404 Bad Request

200 Success


# Report package

{% stepper %}
{% step %}
**Actor(s)**:

User.
{% endstep %}

{% step %}
**Preconditions**:

User has a valid token to access the API.
{% endstep %}

{% step %}
**Alternative Flow** (Incorrect login attempt):

User provides the incorrect token in the authorization header and executes the API call.

The API returns 401 Unauthorized Error.

User contacts support to trouble shoot this error.
{% endstep %}

{% step %}
**Postconditions**:

Successful response in shown from the API.
{% endstep %}
{% endstepper %}

Validate reporting package onformance suite

Web Api V1

Web Api V2

<figure><img src="/files/J7pVJmi2degrofLuqKsC" alt=""><figcaption></figcaption></figure>

**Exceptions:**

401 unauthorized

404 Bad Request

200 Success


# Esma esef

{% stepper %}
{% step %}
**Actor(s)**:

User.
{% endstep %}

{% step %}
**Preconditions**:

User has a valid token to access the API.
{% endstep %}

{% step %}
**Alternative Flow** (Incorrect login attempt):

User provides the incorrect token in the authorization header and executes the API call.

The API returns 401 Unauthorized Error.

User contacts support to trouble shoot this error.
{% endstep %}

{% step %}
**Postconditions**:

Successful response in shown from the API.
{% endstep %}
{% endstepper %}

Validate the Report Package (XBRL inline report and extension taxonomy) against the ESMA/ESEF conformance suite.

[Web Api V1](/web-api-v1/api-reference/validation/report-package/esma-esef#validation-report-package-esma-esef)

[Web Api V2](/web-api-v2/api-reference/validation/report-package/esma-esef#validation-report-package-esma-esef)

<figure><img src="/files/rdWkmvyD2R8xXNWDMOu1" alt=""><figcaption></figcaption></figure>

**Exceptions:**

401 unauthorized

404 Bad Request

200 Success


# Sbr nl 2 0

{% stepper %}
{% step %}
**Actor(s)**:

User.
{% endstep %}

{% step %}
**Preconditions**:

User has a valid token to access the API.
{% endstep %}

{% step %}
**Alternative Flow** (Incorrect login attempt):

User provides the incorrect token in the authorization header and executes the API call.

The API returns 401 Unauthorized Error.

User contacts support to trouble shoot this error.
{% endstep %}

{% step %}
**Postconditions**:

Successful response in shown from the API.
{% endstep %}
{% endstepper %}

Validate the Report Package (XBRL report or XBRL inline report and extension taxonomy) against the SBR 2.0 validation rules.

Web Api V1

Web APi V2

<figure><img src="/files/OUy7QdFVo387tzt8ftMp" alt=""><figcaption></figcaption></figure>

**Exceptions:**

401 unauthorized

404 Bad Request

200 Success


# Delivery


# Delivery Use Cases


# Digipoort

{% stepper %}
{% step %}
**Actor(s)**:

User.
{% endstep %}

{% step %}
**Preconditions**:

User has a valid token to access the API.
{% endstep %}

{% step %}
**Alternative Flow** (Incorrect login attempt):

User provides the incorrect token in the authorization header and executes the API call.

The API returns 401 Unauthorized Error.

User contacts support to trouble shoot this error.
{% endstep %}

{% step %}
**Postconditions**:

Successful response in shown from the API.
{% endstep %}
{% endstepper %}

Deliver the XBRL report (.xbrl/.ixbrl) to the gateway known as Digipoort (NL) for delivery to the regulatory authority.

[Web Api V1](/web-api-v1/api-reference/delivery/digipoort#delivery-digipoort)

[Web Api V2](/web-api-v2/api-reference/delivery/digipoort#delivery-digipoort)

<figure><img src="/files/YAaQxoTkOQnFAvw0Y3SU" alt=""><figcaption></figcaption></figure>

**Exceptions:**

401 unauthorized

404 Bad Request

200 Success


# Sbr nexus

{% stepper %}
{% step %}
**Actor(s)**:

User.
{% endstep %}

{% step %}
**Preconditions**:

User has a valid token to access the API.
{% endstep %}

{% step %}
**Alternative Flow** (Incorrect login attempt):

User provides the incorrect token in the authorization header and executes the API call.

The API returns 401 Unauthorized Error.

User contacts support to trouble shoot this error.
{% endstep %}

{% step %}
**Postconditions**:

Successful response in shown from the API.
{% endstep %}
{% endstepper %}

Deliver the XBRL report (.xbrl/.ixbrl) to the gateway known as SBR Nexus (NL) for delivery to the regulatory authority.

[Web Api V1](/web-api-v1/api-reference/delivery/sbr-nexus#delivery-sbr-nexus)

[Web Api V2](/web-api-v2/api-reference/delivery/sbr-nexus#delivery-sbr-nexus)

<figure><img src="/files/dDY3DAMyCmQDLaOIue8a" alt=""><figcaption></figcaption></figure>

**Exceptions:**

401 unauthorized

404 Bad Request

200 Success


# Status


# Digipoort

{% stepper %}
{% step %}
**Actor(s)**:

User.
{% endstep %}

{% step %}
**Preconditions**:

User has a valid token to access the API.
{% endstep %}

{% step %}
**Alternative Flow** (Incorrect login attempt):

User provides the incorrect token in the authorization header and executes the API call.

The API returns 401 Unauthorized Error.

User contacts support to trouble shoot this error.
{% endstep %}

{% step %}
**Postconditions**:

Successful response in shown from the API.
{% endstep %}
{% endstepper %}

Retrieve the latest status overview of an delivered XBRL report at Digipoort.

[Web Api V1](/web-api-v1/api-reference/status/digipoort#status-digipoort)

[Web Api V2](/web-api-v2/api-reference/status/digipoort#status-digipoort)

<figure><img src="/files/tJmbazNA0q6EXmFsksPH" alt=""><figcaption></figcaption></figure>

**Exceptions:**

401 unauthorized

404 Bad Request

200 Success


# Sbr nexus

{% stepper %}
{% step %}
**Actor(s)**:

User.
{% endstep %}

{% step %}
**Preconditions**:

User has a valid token to access the API.
{% endstep %}

{% step %}
**Alternative Flow** (Incorrect login attempt):

User provides the incorrect token in the authorization header and executes the API call.

The API returns 401 Unauthorized Error.

User contacts support to trouble shoot this error.
{% endstep %}

{% step %}
**Postconditions**:

Successful response in shown from the API.
{% endstep %}
{% endstepper %}

Retrieve the latest status overview of an delivered XBRL report at SBR Nexus.

[Web Api V1](/web-api-v1/api-reference/status/sbr-nexus#status-sbr-nexus)

[Web Api V2](/web-api-v2/api-reference/status/sbr-nexus#status-sbr-nexus)

<figure><img src="/files/GXoJx2YMNjmM85YG0Gag" alt=""><figcaption></figcaption></figure>

**Exceptions:**

401 unauthorized

404 Bad Request

200 Success


# Report package

{% stepper %}
{% step %}
**Actor(s)**:

User.
{% endstep %}

{% step %}
**Preconditions**:

User has a valid token to access the API.
{% endstep %}

{% step %}
**Alternative Flow** (Incorrect login attempt):

User provides the incorrect token in the authorization header and executes the API call.

The API returns 401 Unauthorized Error.

User contacts support to trouble shoot this error.
{% endstep %}

{% step %}
**Postconditions**:

Successful response in shown from the API.
{% endstep %}
{% endstepper %}

Create taxonomy report package. For each of the functionality where in our API is produced result file we produce hash of the file that identifies the contents of the file. User can validate the hash value in hash validation functionality and to know if any changes are applied. By default the file hash is disabled, but it can be controlled from the dropdown below.

[Web Api V1](/web-api-v1/api-reference/report-package#report-package)

[Web Api V2](/web-api-v2/api-reference/report-package#report-package)

<figure><img src="/files/sjUSaEYotsUkKyyPpu4Y" alt=""><figcaption></figcaption></figure>

**Exceptions:**

401 unauthorized

404 Bad Request

200 Success


# Rendering


# Rendering Use Cases


# Instance


# Render

{% stepper %}
{% step %}
**Actor(s)**:

User.
{% endstep %}

{% step %}
**Preconditions**:

User has a valid token to access the API.
{% endstep %}

{% step %}
**Alternative Flow** (Incorrect login attempt):

User provides the incorrect token in the authorization header and executes the API call.

The API returns 401 Unauthorized Error.

User contacts support to trouble shoot this error.
{% endstep %}

{% step %}
**Postconditions**:

Successful response in shown from the API.
{% endstep %}
{% endstepper %}

Render the XBRL report (.xbrl) into a readable report according the taxonomy definitions (datapoint model, presentation or table structure). For each of the functionality where in our API is produced result file we produce hash of the file that identifies the contents of the file. User can validate the hash value in hash validation functionality and to know if any changes are applied. By default the file hash is disabled, but it can be controlled from the dropdown below.

[Web Api V1](/web-api-v1/api-reference/rendering/instance/render#rendering-instance-render)

[Web Api V2](/web-api-v2/api-reference/rendering/instance/render#rendering-instance-render)

<figure><img src="/files/n2kVbxW3ke7PCJxRWG3V" alt=""><figcaption></figcaption></figure>

**Exceptions:**

401 unauthorized

404 Bad Request

200 Success


# Xhtml

{% stepper %}
{% step %}
**Actor(s)**:

User.
{% endstep %}

{% step %}
**Preconditions**:

User has a valid token to access the API.
{% endstep %}

{% step %}
**Alternative Flow** (Incorrect login attempt):

User provides the incorrect token in the authorization header and executes the API call.

The API returns 401 Unauthorized Error.

User contacts support to trouble shoot this error.
{% endstep %}

{% step %}
**Postconditions**:

Successful response in shown from the API.
{% endstep %}
{% endstepper %}

Render the XBRL report (.xbrl) into a readable report formatted as inline XBRL. For each of the functionality where in our API is produced result file we produce hash of the file that identifies the contents of the file. User can validate the hash value in hash validation functionality and to know if any changes are applied. By default the file hash is disabled, but it can be controlled from the dropdown below.

[Web Api V1](/web-api-v1/api-reference/rendering/instance/xhtml#rendering-instance-xhtml)

[Web Api V2](/web-api-v2/api-reference/rendering/instance/xhtml#rendering-instance-xhtml)

<figure><img src="/files/LSCrbfy3uy0xDHUXK576" alt=""><figcaption></figcaption></figure>

**Exceptions:**

401 unauthorized

404 Bad Request

200 Success


# Html to inline package

{% stepper %}
{% step %}
**Actor(s)**:

User.
{% endstep %}

{% step %}
**Preconditions**:

User has a valid token to access the API.
{% endstep %}

{% step %}
**Alternative Flow** (Incorrect login attempt):

User provides the incorrect token in the authorization header and executes the API call.

The API returns 401 Unauthorized Error.

User contacts support to trouble shoot this error.
{% endstep %}

{% step %}
**Postconditions**:

Successful response in shown from the API.
{% endstep %}
{% endstepper %}

Render HTML report to inline XBRL format maintaining the format (look and feel) of the HTML report). Content is provided in an archive (.zip). For each of the functionality where in our API is produced result file we produce hash of the file that identifies the contents of the file. User can validate the hash value in hash validation functionality and to know if any changes are applied. By default the file hash is disabled, but it can be controlled from the dropdown below.

[Web Api V1](/web-api-v1/api-reference/rendering/instance/html-to-inline-package#rendering-instance-html-to-inline-package)

[Web Api V2](/web-api-v2/api-reference/rendering/instance/html-to-inline-package#rendering-instance-html-to-inline-package)

<figure><img src="/files/sZLdidum6PmJOrMHkWLG" alt=""><figcaption></figcaption></figure>

**Exceptions:**

401 unauthorized

404 Bad Request

200 Success


# Consistent

{% stepper %}
{% step %}
**Actor(s)**:

User.
{% endstep %}

{% step %}
**Preconditions**:

User has a valid token to access the API.
{% endstep %}

{% step %}
**Alternative Flow** (Incorrect login attempt):

User provides the incorrect token in the authorization header and executes the API call.

The API returns 401 Unauthorized Error.

User contacts support to trouble shoot this error.
{% endstep %}

{% step %}
**Postconditions**:

Successful response in shown from the API.
{% endstep %}
{% endstepper %}

Render the XBRL report (.xbrl) into a readable consistent presentation report in accordance to the 'CP' specification rule set. For each of the functionality where in our API is produced result file we produce hash of the file that identifies the contents of the file. User can validate the hash value in hash validation functionality and to know if any changes are applied. By default the file hash is disabled, but it can be controlled from the dropdown below.

[Web Api V1](/web-api-v1/api-reference/rendering/instance/consistent#rendering-instance-consistent)

[Web Api V2](/web-api-v2/api-reference/rendering/instance/consistent#rendering-instance-consistent)

<figure><img src="/files/YcsqbUe2BdpcPd2ha5jJ" alt=""><figcaption></figcaption></figure>

**Exceptions:**

401 unauthorized

404 Bad Request

200 Success


# Consistent plus

{% stepper %}
{% step %}
**Actor(s)**:

User.
{% endstep %}

{% step %}
**Preconditions**:

User has a valid token to access the API.
{% endstep %}

{% step %}
**Alternative Flow** (Incorrect login attempt):

User provides the incorrect token in the authorization header and executes the API call.

The API returns 401 Unauthorized Error.

User contacts support to trouble shoot this error.
{% endstep %}

{% step %}
**Postconditions**:

Successful response in shown from the API.
{% endstep %}
{% endstepper %}

Render the XBRL Report (.xbrl) into a consistent presentation report that includes assertion validation (business rules) results. For each of the functionality where in our API is produced result file we produce hash of the file that identifies the contents of the file. User can validate the hash value in hash validation functionality and to know if any changes are applied. By default the file hash is disabled, but it can be controlled from the dropdown below.

[Web Api V1](/web-api-v1/api-reference/rendering/instance/consistent-plus#rendering-instance-consistent-plus)

[Web Api V2](/web-api-v2/api-reference/rendering/instance/consistent-plus#rendering-instance-consistent-plus)

<figure><img src="/files/kAUCAeiCl02VUKKHEwTz" alt=""><figcaption></figcaption></figure>

**Exceptions:**

401 unauthorized

404 Bad Request

200 Success


# Convert inline to xbrl

{% stepper %}
{% step %}
**Actor(s)**:

User.
{% endstep %}

{% step %}
**Preconditions**:

User has a valid token to access the API.
{% endstep %}

{% step %}
**Alternative Flow** (Incorrect login attempt):

User provides the incorrect token in the authorization header and executes the API call.

The API returns 401 Unauthorized Error.

User contacts support to trouble shoot this error.
{% endstep %}

{% step %}
**Postconditions**:

Successful response in shown from the API.
{% endstep %}
{% endstepper %}

Render the inline XBRL report into a 'plain vanilla' XBRL report (.xbrl). For each of the functionality where in our API is produced result file we produce hash of the file that identifies the contents of the file. User can validate the hash value in hash validation functionality and to know if any changes are applied. By default the file hash is disabled, but it can be controlled from the dropdown below.

[Web Api V1](/web-api-v1/api-reference/rendering/instance/convert-inline-to-xbrl#rendering-instance-convert-inline-to-xbrl)

[Web Api V2](/web-api-v2/api-reference/rendering/instance/convert-inline-to-xbrl#rendering-instance-convert-inline-to-xbrl)

<figure><img src="/files/aYSvqWJ6iMuBNF6G0eIQ" alt=""><figcaption></figcaption></figure>

**Exceptions:**

401 unauthorized

404 Bad Request

200 Success


# Tax report sbr nl

{% stepper %}
{% step %}
**Actor(s)**:

User.
{% endstep %}

{% step %}
**Preconditions**:

User has a valid token to access the API.
{% endstep %}

{% step %}
**Alternative Flow** (Incorrect login attempt):

User provides the incorrect token in the authorization header and executes the API call.

The API returns 401 Unauthorized Error.

User contacts support to trouble shoot this error.
{% endstep %}

{% step %}
**Postconditions**:

Successful response in shown from the API.
{% endstep %}
{% endstepper %}

Render the XBRL report (.xbrl) into a readable report (.PDF) for tax reports (OB/OB-Sub/ICP)(NL). For each of the functionality where in our API is produced result file we produce hash of the file that identifies the contents of the file. User can validate the hash value in hash validation functionality and to know if any changes are applied. By default the file hash is disabled, but it can be controlled from the dropdown below.

[Web Api V1](/web-api-v1/api-reference/rendering/instance/tax-report-sbr-nl#rendering-instance-tax-report-sbr-nl)

[Web Api V2](/web-api-v2/api-reference/rendering/instance/tax-report-sbr-nl#rendering-instance-tax-report-sbr-nl)

<figure><img src="/files/YVvc87Hipa2ImY6W2XqY" alt=""><figcaption></figcaption></figure>

**Exceptions:**

401 unauthorized

404 Bad Request

200 Success


# Uniform

{% stepper %}
{% step %}
**Actor(s)**:

User.
{% endstep %}

{% step %}
**Preconditions**:

User has a valid token to access the API.
{% endstep %}

{% step %}
**Alternative Flow** (Incorrect login attempt):

User provides the incorrect token in the authorization header and executes the API call.

The API returns 401 Unauthorized Error.

User contacts support to trouble shoot this error.
{% endstep %}

{% step %}
**Postconditions**:

Successful response in shown from the API.
{% endstep %}
{% endstepper %}

Render the XBRL report (.xbrl) and apply uniformation changes (best practices) to the XBRL report in the process and create a new version of the XBRL report (.xbrl). For each of the functionality where in our API is produced result file we produce hash of the file that identifies the contents of the file. User can validate the hash value in hash validation functionality and to know if any changes are applied. By default the file hash is disabled, but it can be controlled from the dropdown below.

[Web Api V1](/web-api-v1/api-reference/rendering/instance/uniform#rendering-instance-uniform)

[Web Api V2](/web-api-v2/api-reference/rendering/instance/uniform#rendering-instance-uniform)

<figure><img src="/files/2EXnaJ3fdEG2uycao3Jb" alt=""><figcaption></figcaption></figure>

**Exceptions:**

401 unauthorized

404 Bad Request

200 Success


# Merge

{% stepper %}
{% step %}
**Actor(s)**:

User.
{% endstep %}

{% step %}
**Preconditions**:

User has a valid token to access the API.
{% endstep %}

{% step %}
**Alternative Flow** (Incorrect login attempt):

User provides the incorrect token in the authorization header and executes the API call.

The API returns 401 Unauthorized Error.

User contacts support to trouble shoot this error.
{% endstep %}

{% step %}
**Postconditions**:

Successful response in shown from the API.
{% endstep %}
{% endstepper %}

Render two XBRL reports and merge them into one new XBRL report (.xbrl) and a log with not merged content is available. For each of the functionality where in our API is produced result file we produce hash of the file that identifies the contents of the file. User can validate the hash value in hash validation functionality and to know if any changes are applied. By default the file hash is disabled, but it can be controlled from the dropdown below.

[Web Api V1](/web-api-v1/api-reference/rendering/instance/merge#rendering-instance-merge)

[Web Api V2](/web-api-v2/api-reference/rendering/instance/merge#rendering-instance-merge)

<figure><img src="/files/LWSfEG5koyweiLaeuYT7" alt=""><figcaption></figcaption></figure>

**Exceptions:**

401 unauthorized

404 Bad Request

200 Success


# Allowed render options

{% stepper %}
{% step %}
**Actor(s)**:

User.
{% endstep %}

{% step %}
**Preconditions**:

User has a valid token to access the API.
{% endstep %}

{% step %}
**Alternative Flow** (Incorrect login attempt):

User provides the incorrect token in the authorization header and executes the API call.

The API returns 401 Unauthorized Error.

User contacts support to trouble shoot this error.
{% endstep %}

{% step %}
**Postconditions**:

Successful response in shown from the API.
{% endstep %}
{% endstepper %}

Provides a list of render options that are available for the report provided.

[Web Api V1](/web-api-v1/api-reference/rendering/instance/allowed-render-options#rendering-instance-allowed-render-options-fileid)

[Web Api V2](/web-api-v2/api-reference/rendering/instance/allowed-render-options#rendering-instance-allowed-render-options-fileid)

<figure><img src="/files/qxZODmRaLj1U4qWFousm" alt=""><figcaption></figcaption></figure>

**Exceptions:**

401 unauthorized

404 Bad Request

200 Success


# Analyse


# Analyze Use Cases


# Instance


# Balance sheet

{% stepper %}
{% step %}
**Actor(s)**:

User.
{% endstep %}

{% step %}
**Preconditions**:

User has a valid token to access the API.
{% endstep %}

{% step %}
**Alternative Flow** (Incorrect login attempt):

User provides the incorrect token in the authorization header and executes the API call.

The API returns 401 Unauthorized Error.

User contacts support to trouble shoot this error.
{% endstep %}

{% step %}
**Postconditions**:

Successful response in shown from the API.
{% endstep %}
{% endstepper %}

Processes an XBRL report (.xbrl) and analyzes its balance sheet and enables various views (tables and graphs) of the data.

[Web Api V1](/web-api-v1/api-reference/instance/balance-sheet#instance-balance-sheet)

[Web Api V2](/web-api-v2/api-reference/instance/balance-sheet#instance-balance-sheet)

<figure><img src="/files/5RayD8HhLeVcLRtO8TTf" alt=""><figcaption></figcaption></figure>

**Exceptions:**

401 unauthorized

404 Bad Request

200 Success


# Pivot

{% stepper %}
{% step %}
**Actor(s)**:

User.
{% endstep %}

{% step %}
**Preconditions**:

User has a valid token to access the API.
{% endstep %}

{% step %}
**Alternative Flow** (Incorrect login attempt):

User provides the incorrect token in the authorization header and executes the API call.

The API returns 401 Unauthorized Error.

User contacts support to trouble shoot this error.
{% endstep %}

{% step %}
**Postconditions**:

Successful response in shown from the API.
{% endstep %}
{% endstepper %}

Processes an XBRL report (.xbrl) and retrieve all facts in a pivot structure for further processing and data handling.

[Web Api V1](/web-api-v1/api-reference/instance/pivot#instance-pivot)

[Web Api V2](/web-api-v2/api-reference/instance/pivot#instance-pivot)

<figure><img src="/files/mjajpVK7PmWDSff9ZDUH" alt=""><figcaption></figcaption></figure>

**Exceptions:**

401 unauthorized

404 Bad Request

200 Success


# Compare

{% stepper %}
{% step %}
**Actor(s)**:

User.
{% endstep %}

{% step %}
**Preconditions**:

User has a valid token to access the API.
{% endstep %}

{% step %}
**Alternative Flow** (Incorrect login attempt):

User provides the incorrect token in the authorization header and executes the API call.

The API returns 401 Unauthorized Error.

User contacts support to trouble shoot this error.
{% endstep %}

{% step %}
**Postconditions**:

Successful response in shown from the API.
{% endstep %}
{% endstepper %}

Compare two instances and show the difference between them.

Web Api V1

Web Api V2

<figure><img src="/files/VT1B8JR8oVnlctAOqu6P" alt=""><figcaption></figcaption></figure>

**Exceptions:**

401 unauthorized

404 Bad Request

200 Success


# Inline compare

{% stepper %}
{% step %}
**Actor(s)**:

User.
{% endstep %}

{% step %}
**Preconditions**:

User has a valid token to access the API.
{% endstep %}

{% step %}
**Alternative Flow** (Incorrect login attempt):

User provides the incorrect token in the authorization header and executes the API call.

The API returns 401 Unauthorized Error.

User contacts support to trouble shoot this error.
{% endstep %}

{% step %}
**Postconditions**:

Successful response in shown from the API.
{% endstep %}
{% endstepper %}

Compare two inline files and show the difference between them.Compare two inline files and show the difference between them.

[Web Api V1](/web-api-v1/api-reference/instance/inline-compare#instance-inline-compare)

[Web Api V2](/web-api-v2/api-reference/instance/inline-compare#instance-inline-compare)

<figure><img src="/files/DEOnYJWiYOd8L0PUPCtP" alt=""><figcaption></figcaption></figure>

**Exceptions:**

401 unauthorized

404 Bad Request

200 Success


# Askyourpdf


# Upload

{% stepper %}
{% step %}
**Actor(s)**:

User.
{% endstep %}

{% step %}
**Preconditions**:

User has a valid token to access the API.
{% endstep %}

{% step %}
**Alternative Flow** (Incorrect login attempt):

User provides the incorrect token in the authorization header and executes the API call.

The API returns 401 Unauthorized Error.

User contacts support to trouble shoot this error.
{% endstep %}

{% step %}
**Postconditions**:

Successful response in shown from the API.
{% endstep %}
{% endstepper %}

Uploads the digital report to chat with.

[Web APi V1](/web-api-v1/api-reference/reportchat/upload#reportchat-upload)

[Web Api V2](/web-api-v2/api-reference/askyourpdf/upload#askyourpdf-upload)

<figure><img src="/files/cQRbcnLmNi4fWKkS8lp8" alt=""><figcaption></figcaption></figure>

**Exceptions:**

401 unauthorized

404 Bad Request

200 Success


# Chat

{% stepper %}
{% step %}
**Actor(s)**:

User.
{% endstep %}

{% step %}
**Preconditions**:

User has a valid token to access the API.
{% endstep %}

{% step %}
**Alternative Flow** (Incorrect login attempt):

User provides the incorrect token in the authorization header and executes the API call.

The API returns 401 Unauthorized Error.

User contacts support to trouble shoot this error.
{% endstep %}

{% step %}
**Postconditions**:

Successful response in shown from the API.
{% endstep %}
{% endstepper %}

Chat with your digital report.

Web Api V1

Web Api V2

<figure><img src="/files/wK5hDJvHz480IgOyB5ND" alt=""><figcaption></figcaption></figure>

**Exceptions:**

401 unauthorized

404 Bad Request

200 Success


# Delete

{% stepper %}
{% step %}
**Actor(s)**:

User.
{% endstep %}

{% step %}
**Preconditions**:

User has a valid token to access the API.
{% endstep %}

{% step %}
**Alternative Flow** (Incorrect login attempt):

User provides the incorrect token in the authorization header and executes the API call.

The API returns 401 Unauthorized Error.

User contacts support to trouble shoot this error.
{% endstep %}

{% step %}
**Postconditions**:

Successful response in shown from the API.
{% endstep %}
{% endstepper %}

Deletes the document to chat with.

Web Api V1

Web Api V2

<figure><img src="/files/70JwVyKaKcm6wGESDvEE" alt=""><figcaption></figcaption></figure>

**Exceptions:**

401 unauthorized

404 Bad Request

200 Success


# Customer Corner


# Customer Corner Use Cases


# Users

{% stepper %}
{% step %}
**Actor(s)**:

User.
{% endstep %}

{% step %}
**Preconditions**:

User has a valid token to access the API.
{% endstep %}

{% step %}
**Alternative Flow** (Incorrect login attempt):

User provides the incorrect token in the authorization header and executes the API call.

The API returns 401 Unauthorized Error.

User contacts support to trouble shoot this error.
{% endstep %}

{% step %}
**Postconditions**:

Successful response in shown from the API.
{% endstep %}
{% endstepper %}

Check the domains the user had access to Admin functionality only.

[Web Api V1](/web-api-v1/api-reference/customer-corner/users#customer-corner-users)

[Web Api V2](/web-api-v2/api-reference/customer-corner/users#customer-corner-users)

<figure><img src="/files/IbBJR5D5uID6RldPeqZO" alt=""><figcaption></figcaption></figure>

Check if user exists on the platform and if no updates the system.

[Web Api V1](/web-api-v1/api-reference/customer-corner/users#customer-corner-users-1)

[Web Api V2](/web-api-v2/api-reference/customer-corner/users#customer-corner-users-1)

<figure><img src="/files/hrrp1OXcJNEPJu5wqSAR" alt=""><figcaption></figcaption></figure>

**Exceptions:**

401 unauthorized

404 Bad Request

200 Success




---

[Next Page](/llms-full.txt/1)