# Annual Reports
Source: https://docs.tic.io/api-core/annual-reports

How to use the simple API to display and use financial data and metrics.

Our API endpoint for financial and annual reports has been built to simplify for any
developer working with either charts or sheet like data. The annual reports contains
the result- and balancesheet, key metrics, footnotes and any additional information.

## Schema description

Each record contains an order which means which row you should display the data at, think
like an Excel sheet. The localized field name contains a description in the given language.
The display format can be used to simplify the presentation by using the format for almost any
given number and formatting library.

Notes and highlight are specifically if you want to highlight data with color and
a note describing something. If something needs highlighting our API will
output it so it's easy for you to use.

```json Schema for a record theme={null}
{
  "order": 123,
  "localizedFieldName": "<string>",
  "enFieldName": "<string>",
  "displayFormat": "<string>",
  "type": "<string>",
  "value": "<any>",
  "notes": "<string>",
  "highlight": "green"
}
```

## Example request

```bash cURL theme={null}
curl https://api.tic.io/datasets/companies/1893055/financial-reports?key=your_api_key
```


# Addresses
Source: https://docs.tic.io/api-core/companies/addresses

get /datasets/companies/{companyId}/addresses
Lists all known addresses of a company



# Authorizations
Source: https://docs.tic.io/api-core/companies/authorizations

get /datasets/companies/{companyId}/authorizations
Gets the authorizations



# Bank accounts
Source: https://docs.tic.io/api-core/companies/bank-accounts

get /datasets/companies/{companyId}/bank-accounts
Get associated bank accounts of the company by it's id



# Bankgironumbers
Source: https://docs.tic.io/api-core/companies/bankgironumbers

get /datasets/companies/{companyId}/se/bankgironumbers
Lists bankgironumbers belonging to the company

This endpoint replaces the older [bank accounts](bank-accounts) endpoint.


# Beneficial owners
Source: https://docs.tic.io/api-core/companies/beneficial-owners-SE

get /datasets/companies/{companyId}/se/beneficial-owners
Gets current and historic beneficial owner records and any exempts from registration of beneficial owners

This endpoint is specific for Swedish companies since it contain details about current and historic beneficial owners and
any exempts from registration of beneficial owners.


# Bonus issue
Source: https://docs.tic.io/api-core/companies/bonus-issue

get /datasets/companies/{companyId}/bonus-issue
Gets the company bonus issues



# Business mortgages
Source: https://docs.tic.io/api-core/companies/business-mortgages

get /datasets/companies/{companyId}/se/business-mortgages
Get the companys business mortgages



# Credit Report
Source: https://docs.tic.io/api-core/companies/credit-report

post /datasets/companies/{companyId}/credit-report
Get a full credit report hosted on a temporary URL

This endpoint will create a fully hosted credit report (time limited) for the given company and
return the URL including incurred costs. You can post also a E.164 formatted mobile
phone number and we will send a text message including the full credit report to the user

Also you can add an e-mail address that will receive an e-mail containing the link
to the report.

Remember the model that you need to post needs at minimum contain ConsentToPricing set to true.

Example:

```json theme={null}
{
  "consentToPricing": true,
  "sendSMSToE164MobileNumber": "+46xxxxxx",
  "sendEmailToEmailAddress": "some@email.tld"
}
```

## iframe

You can embed the report into an iframe on your page.

```html theme={null}
<iframe
  src="<creditReportUrl>"
  title="<description>"
  frameborder="0"
  marginheight="0"
  marginwidth="0"
  width="100%"
  height="100%"
  scrolling="auto"
>
</iframe>
```


# Credit Score
Source: https://docs.tic.io/api-core/companies/credit-score

get /datasets/companies/{companyId}/credit-score
Gets details information about the credit score for the company

This endpoint delivers the credit score for the company ranging from 0 to 100 where 1 should be interpreted
as the lowest and 100 the highest. 0 means that the credit score cannot be determined since
there are to many negative factors.

The credit score includes an array of strings containing a description of reasons of negative and positive
points.

Expect response times around 250 - 1000 ms because credit scoring happens in real-time based on
many parameters.


# Debtor summary
Source: https://docs.tic.io/api-core/companies/debtor-summary

get /datasets/companies/{companyId}/se/debtor-summary
Get the most recent summary of debtor record of payment applications, non payment and debt balance

### Details

This endpoint will return the most recent debtors summary for companies registered in Sweden. If the response is 404, Not Found, it means there are no debt cases.
A successful response code 200 will include a debt balance (debtBalance) which contains the current debts to public vs private entities. A public entity includes
debt cases, referred in Sweden as A-mål (A-case), regarding debts to the central government, municipality, regions and various authorities.
Example of a public debt are taxes. Private debt cases, referred in Sweden as E-mål (E-case), are debts to individuals and companies.

For public debt cases additional information is included in the description property which holds information about the case type and the creditor. The debt balance
is the actual balance on the date and time supplied in the property lastUpdated (Unix epoch). The update frequency is described in the table below.

| Property                    | Contains                                                                                    |
| --------------------------- | ------------------------------------------------------------------------------------------- |
| debtBalance                 | Weekly updated debt balance for public vs. private debt cases                               |
| recordOfPaymentApplications | Daily updated contains payment applications made by creditors                               |
| recordOfNonPayment          | Daily updated contains records of non payment ()                                            |
| foreclosure                 | Daily updated information if there is a current foreclousre (Swedish: utmätning)            |
| debtRestructuring           | Daily updated information if there is a current debt restructuring (Swedish: skuldsanering) |

### Caution !

The four properties recordOfPaymentApplications, recordOfNonPayment, foreclosure, debtRestructuring may not be identical
between credit reference agencies until second quarter of 2025. The reason is that the central authority, Kronofogdemyndigheten,
which are the source of this information closed down their so called initial data loading for new actors until second quarter 2025.
To solve that problem we had to acquired the current state of record of payment applications and record of non payment
from another source and use the daily partial updates from Kronofogdemyndigheten from 2024-12-11 and onwards.

This could technically cause a slight deviation in registration entries. To cirumvent that issue we have decided to keep
a more relaxed approch in credit scoring of such records until second quarter of 2025.

Meanwhile this does not affect debtBalance since that data is delivered weekly to all credit reference agencies.


# Public documents
Source: https://docs.tic.io/api-core/companies/documents

get /datasets/companies/{companyId}/documents
Gets documents associated with the company



# Domains
Source: https://docs.tic.io/api-core/companies/domains

get /datasets/companies/{companyId}/domains
Lists all domains associated with a company



# Email
Source: https://docs.tic.io/api-core/companies/email

get /datasets/companies/{companyId}/email-addresses
Gets the email addresses of the company



# Employee contributions
Source: https://docs.tic.io/api-core/companies/employee-contributions

get /datasets/companies/{companyId}/se/contributions-employement-service
Lists contributions from Swedish employment service for the company

Deprecated and replaced with [salary contributions endpoint](salary-contributions)


# Financial report file
Source: https://docs.tic.io/api-core/companies/financial-report-file

get /datasets/companies/{companyId}/financial-report-summaries/{financialReportSummaryId}/files/{financialReportFileId}
Gets the file for the financial report summary

This endpoint delivers the actual file requested for the financial report.

## ReportFileFormat

The available files depends on the source format but here is list of all available types, ReportFileType, present in the response.

The default file to use for presentation in web applications are OriginalPDFImage or OriginalPDFSearchable.

| Enum                  | Swedish                                                | English                                                     |
| --------------------- | ------------------------------------------------------ | ----------------------------------------------------------- |
| XBRL                  | XBRL format                                            | XBRL format                                                 |
| XBRL\_RB              | XBRL format av revisionsberättelsen                    | XBRL format of the audit report                             |
| iXBRL                 | iXBRL format (xhtml)                                   | iXBRL format (xhtml)                                        |
| iXBRL\_RB             | iXBRL format (xhtml) av revisionsberättelsen           | iXBRL format (xhtml) of the audit report                    |
| TIFF                  | Orginal multi-page tiff                                | Orginal multi-page tiff                                     |
| EnhancedPDFSearchable | IDP bearbetad PDF med skarpare text och fritext sökbar | IDP processed PDF with sharper text and freetext searchable |
| OriginalPDFImage      | Orginal PDF                                            | Orginal PDF                                                 |
| OriginalPDFSearchable | Orginal PDF fritext sökbar                             | Orginal PDF freetext searchable                             |
| EntityJson            | JSON format av rapporten                               | JSON format of the report                                   |
| OCRJson               | hOCR format av rapporten                               | hOCR format of the report                                   |
| TIFF\_RB              | Orginal multi-page tiff av revisionsberättelsen        | Orginal multi-page of the audit report                      |


# Financial report files
Source: https://docs.tic.io/api-core/companies/financial-report-files

get /datasets/companies/{companyId}/financial-report-summaries/{financialReportSummaryId}/files
Gets all files available for a financial report summary

This endpoint delivers all present available files in the financial report. Please note that this endpoint is redundant since
the files are delivered in the [financial-report-summary](financial-report-summaries).


# Financial report summaries
Source: https://docs.tic.io/api-core/companies/financial-report-summaries

get /datasets/companies/{companyId}/financial-report-summaries
Gets a summary of registered financial reports and their metadata

This endpoint delivers available financial reports and their metadata and files available, more called annual reports but also
interim reports can be present.

The data includes all available files for the financial report. After getting the response you can simply download the files from
[here](financial-report-files).


# Financial reports table
Source: https://docs.tic.io/api-core/companies/financial-reports

get /datasets/companies/{companyId}/financial-reports
Retrieves all or specific financial report for period in a table format suited for simple visualization. If no language code is specificed Swedish is assumed.

### Details

This endpoint is suited for localized views where you intend to visualize the response in a table like format. It
automatically organize the result into cells with rows and columns with the language you provide. It also
returns formatting helpers to help automatically styling the result.

Please note that the order field is used to sort the correct order when outputting the grid for the income statement,
balance sheet, key metrics, footnotes and other additional information.

Here is a simple javascript example you can use to visualize the response with the help of [Handsontable](https://handsontable.com/).

```html index.html theme={null}
<html>
  <head>
    <script
      type="text/javascript"
      src="https://cdn.jsdelivr.net/npm/handsontable/dist/handsontable.full.min.js"
    ></script>
    <script
      type="text/javascript"
      src="https://cdn.jsdelivr.net/npm/lodash/lodash.min.js"
    ></script>
  </head>
  <body>
    <div id="grid" style="width: 100vw; height: 100vh"></div>
    <script type="text/javascript" src="index.js"
  </body>
</html>
```

```javscript index.js theme={null}
  const sourceData = "add your response here from the API";
  const rows = _(sourceData).map('row').uniq().value();
  const columns = _(sourceData).map('column').uniq().value();
  const tableData = [];
  _.forEach(rows, (row) => {
    let rowData = [];
    let first = _.find(
      sourceData,
      (item) => item.column == columns[0] && item.row == row
    );
    rowData.push(first.localizedFieldName);
    _.forEach(columns, (column) => {
      let match = _.find(
        sourceData,
        (item) => item.column == column && item.row == row
      );
      rowData.push(match.value);
    });
    tableData.push(rowData);
  });
  document.addEventListener('DOMContentLoaded', () => {
   const grid = document.getElementById("grid");

  // Helps styling the cells with the cellProperties
  function customRenderer(hotInstance, td, row, column, prop, value, cellProperties) {
    Handsontable.renderers.BaseRenderer.apply(this, arguments);

    if (cellProperties.customData == 'undefined') {
      console.log(
        'Wierd emtpy custom data in row ' + row + ' and column ' + column
      );
    }
    switch (cellProperties.customData?.type) {
      case 'Int':
        if (value != null)
          return (td.innerHTML = value.toLocaleString('sv-SE', {
            maximumFractionDigits: 0,
          }));
        break;
      case 'String':
        break;
      case 'Decimal':
        if (value != null)
          return (td.innerHTML = value.toLocaleString('sv-SE', {
            style: 'decimal', // style: 'percent'
            minimumFractionDigits: 1,
            maximumFractionDigits: 1,
          }));
        break;
      case 'DateTime':
        return (td.innerHTML = new Date(value).toLocaleDateString());
        break;
      case 'Percentage':
        if (value != null)
          return (td.innerHTML = (value * 0.01).toLocaleString('sv-SE', {
            style: 'percent',
            minimumFractionDigits: 1,
            maximumFractionDigits: 1,
          }));
        break;
      default:
        break;
    }
    return (td.innerHTML = value);
  }

  const hotInstance = new Handsontable(grid, {
        data: tableData,
        licenseKey: 'non-commercial-and-evaluation',
        rowHeaders: false,
        colHeaders: false,
        fixedColumnsStart: 1,
        fixedRowsTop: 1,
        manualColumnResize: true,
        wordWrap: true,
        autoColumnSize: true,
        autoWrapRow: true,
        autoWrapCol: true,
        readOnly: true,
        comments: true,
        height: 'auto',
        contextMenu: ['copy'],
        className: 'htRight',
        fillHandle: false,
        stretchH: 'all',
        cells(row, col) {
          const cellProperties = {};
          cellProperties.className = 'htLeft';
          let match = _.find(
            sourceData,
            (item) => item.column == col - 1 && item.row == row
          );
          if (match?.notes != null) {
            cellProperties.comment = {
              value: match.notes,
              readOnly: true,
              style: { width: 200, height: 50 },
            };
          }
          cellProperties.customData = match;
          if (col == 0 || row == 0)
            cellProperties.className = 'htRight font-bold';
          if (col > 0 && row > 0)
            cellProperties.renderer = customRenderer;
          return cellProperties;
        },
      });
      });
```


# Financial reports
Source: https://docs.tic.io/api-core/companies/financial-reports2

get /datasets/companies/{companyId}/financial-reports2
Retrieves all or specific financial report for period in a json object format suited for processing applications. Uses json properties common known on local market.

### Details

This endpoint is suited for applications not intended for visualization. We also supply an endpoint better suited for
visualization the response with localized names [here](financial-reports).

This endpoint contains json property names most common in Swedish system for income statements, balance sheets,
key metrics, footnotes and additional data. We have decided to keep these names since they are most common the
space.

When you use the [endpoint for visualization](financial-reports) you can pick between different languages to be able to quickly
render correcting wordings and sequence of the properties.

Please note !


# Financial summary
Source: https://docs.tic.io/api-core/companies/financial-summary

get /datasets/companies/{companyId}/financial-summary
Gets financial summary of the company by it's id

### Details

This endpoint will return a financial summary for the last four years. Properties are prefixed to give a sense where
they are placed in the financial report. Table below shows the prefixes and description.

| Prefix | Description  |
| ------ | ------------ |
| rs     | Resultsheet  |
| bs     | Balancesheet |
| fn     | Footnote     |
| km     | Key metrics  |

### Key metrics

The keymetrics are calculated according to the following table.

| Prefix                | Description                                                                                                                                                                            |
| --------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| km\_OperatingMargin   | EBIT (Operating profit/loss) divided by net sales                                                                                                                                      |
| km\_NetProfitMargin   | EBIE (Earnings Before Interest Expense) divided by net sales (NOTE ! if net sales isn't present but other other operating income is reported we will instead use that for calculation) |
| km\_EquityAssetsRatio | Sum equity plus adjusted equity (sum untaxed reserves deducated with the corporate tax) divided by total assets                                                                        |
| km\_GrossMargin       | Gross profit/loss divided by net sales                                                                                                                                                 |

Changes to calulcation may occur since different actors are interpreting data slightly differently for km\_NetProfitMargin. If there are no net sales or other operating income reported the
km\_NetProfitMargin will be null.

### Go deeper

To access all records of the financial report you should use the endpoint for [financial-reports](financial-reports) that gives you
a ready to use table structure with localized names for the financial report.


# Graph
Source: https://docs.tic.io/api-core/companies/graph

get /datasets/companies/{companyId}/graph
Returns a graph with companies, optional beneficial owners and persons

Returns a graph with nodes and edges representing the relationships between
persons and companies and optionally beneficial owners.

Can be used by graph visualization such as:

* [Linkurious Ogma](https://resources.linkurious.com/ogma-overview)
* [Cambridge Intelligence Keylines](https://cambridge-intelligence.com/keylines-javascript-graph-visualization/)
* [Sigma.js](https://www.sigmajs.org/)
* [Memgraph Orb](https://github.com/memgraph/orb)

The properties for nodes and edges are dynamic and can be used to control styling and highlighting of nodes.


# Hyperlinks
Source: https://docs.tic.io/api-core/companies/hyperlinks

get /datasets/companies/{companyId}/hyperlinks
Get associated hyperlinks to the business



# Intelligence
Source: https://docs.tic.io/api-core/companies/intelligence

get /datasets/companies/{companyId}/intelligence
Gets intelligence records of the company by it's id

### Details

This endpoint will return all historical and current intelligence records for a business. Intelligence records are part of
our [AI Anomaly Detection](/technology/ai-anomaly-detection) which highlights discrepancies in data and their significance.

## Intelligence types

Intelligence records contains information about various discrepancies that we find in data. A record contains a score between 0 and 255
representing the significance of the discrepancy. If the score equals 0 is means it's just for information while 255 means the discrepancy
is very significant. Each intelligence record also comes with a human English text describing the discrepancy called intelligence.notes.

List of intelligence.companyIntelligenceType below in the table. Please note that while searching you need to enter the value (Int32) and not the name itself. Value
2,4 and 6 are unused currently. They may appear in search result currently just for testing.

| Enum                         | Value | Description                                                |
| ---------------------------- | ----- | ---------------------------------------------------------- |
| CreatedAsShelfCompany        | 0     | The company was created as shelf company                   |
| SuspectedForQuickLiquidation | 1     | The company was seems to be going into "quick liquidation" |
| AffliatedWithArticle         | 3     | The company is affiliated with one or multiple articles    |
| SuspectedAddress             | 5     | The address has earlier been known                         |
| PresentOnWarningList         | 7     | The company is present on certain warning lists            |
| AnnualReportDiscrepancies    | 8     | One or multiple annual reports contains discrepancies      |

The intelligence.externalId is used to reference an id containing the origin of the intelligence record. If for example the
intelligence record is of type: AnnualReportDiscrepancies (8) it means the external id represents the id of the annual report.

## Intelligence subtypes

Certain intelligence types have subtypes to further describe what has been found. The intelligence.companyIntelligenceSubType is
an enum text to make it easier to filter based on search.

List of subtypes. Please note you need to filter by string when using intelligence.companyIntelligenceSubType.

| Enum                     | Description                                                                                           |
| ------------------------ | ----------------------------------------------------------------------------------------------------- |
| BS\_MISMATCH             | The balance sheet doesn't balance                                                                     |
| AGM\_TO\_LATE            | The annual general meeting was held to late                                                           |
| AR\_TO\_LATE             | The annual report was submitted to late                                                               |
| AGM\_WRONG\_DATE         | Suspected wrong date of annual general meeting date                                                   |
| MISSING\_MULTIYEAR       | The multi-year overview is missing                                                                    |
| MISSING\_CHANGEEQUITY    | The table showing change of equity is missing                                                         |
| WRONG\_SIGNATUREDATE     | Signature date (last signature) seems to be wrong                                                     |
| WRONG\_EQUITYASSETSRATIO | The given equity asset ratio doesn't match the calculation                                            |
| MISSING\_AUDITOR         | The company is passing the thresholds requiring an auditor (check response for mandatory requirement) |
| DUPLICATE                | The annual report is a duplicate for another company                                                  |
| NO\_SHARECAPITAL         | The balance sheet is missing share capital                                                            |
| POSSIBLE\_MISSINGASSETS  |                                                                                                       |
| NEGATIVE\_SHARECAPITAL   | The balance sheet contains negative share capital                                                     |
| NEGATIVE\_ASSETS         | The balance sheet total assets are negative                                                           |
| MISSING\_BS\_ASSETS      | Missing part of the balance sheet (assets)                                                            |
| MISSING\_BS\_EQUITY      | Missing part of the balance sheet (equity)                                                            |
| MISSING\_RS              | Missing result sheet                                                                                  |
| LIQUIDATION\_REQUIRED    | The company is subject to liquidation requirements                                                    |
| WRONG\_SHARECAPITAL      | The share capital is wrong in the balance sheet                                                       |
| MISSING\_NUMBEREMPLOYEES | Missing number of employees but required                                                              |
| TAX\_PAID\_LATE          | Taxes have been paid late                                                                             |
| FORBIDDEN\_LOAN          | A forbidden loan exists                                                                               |
| BS\_DISCOURGED           | Auditor has discouraged the balance sheet                                                             |
| BS\_CONTROL              | A control balance sheet exists                                                                        |
| TAX\_AUDIT               | A tax audit has been carried out                                                                      |
| SUM\_INCORRECT           | Various sum records are incorrect                                                                     |
| AUDITOR\_REMARKS         | Auditor remarks exists                                                                                |

Check back continuously since we are adding more subtypes.

### Response and example

This is an example response. Note that you are also getting a source url if it exists which enables you to grab the underlying
data for intelligence record.

```json Example response theme={null}
[
  {
    "companyIntelligenceType": "annualReportDiscrepancies",
    "companyIntelligenceSubType": "MISSING_MULTIYEAR",
    "notes": "The annual report is missing a multi-year overview
    and the first fiscal year has passed.
    Required by the ruleset company is using.",
    "score": 50,
    "firstSeenAtUtc": "2024-07-22T00:00:00",
    "lastSeenAtUtc": null,
    "lastUpdatedAtUtc": "2024-08-20T15:49:50",
    "externalId": 469448,
    "sourceUrl": "https://api.tic.io/financial-documents/se/469448"
  },
  {
    "companyIntelligenceType": "annualReportDiscrepancies",
    "companyIntelligenceSubType": "MISSING_CHANGEEQUITY",
    "notes": "The annual report is missing changes in equity.
    Required by the ruleset company is using.",
    "score": 100,
    "firstSeenAtUtc": "2024-07-22T00:00:00",
    "lastSeenAtUtc": null,
    "lastUpdatedAtUtc": "2024-08-20T15:49:50",
    "externalId": 469448,
    "sourceUrl": "https://api.tic.io/financial-documents/se/469448"
  }
]
```


# Names
Source: https://docs.tic.io/api-core/companies/names

get /datasets/companies/{companyId}/names
Gets the names of the company

This endpoint delivers historic and current names of the business but
also any particular names and other tradenames and their purposes.

The date companyNameDecidedAt represents the date when the business decided
to use the names and the firstSeentAtUtc represents the first date when
we received the information about the name.


# Ownerships
Source: https://docs.tic.io/api-core/companies/ownerships

get /datasets/companies/{companyId}/has-ownership-in
Get companies that the company has ownership in



# Parties
Source: https://docs.tic.io/api-core/companies/parties

get /datasets/companies/{companyId}/parties
Lists all known parties which includes board members



# Payrolls
Source: https://docs.tic.io/api-core/companies/payrolls

get /datasets/companies/{companyId}/se/payroll
Gets any historic known payrolls and includes a summary for each financial year

This endpoint containing the route /se/ intended for Swedish companies only. It contains monthly details
about employeer taxes for payrolls. It also delivers a yearly summary comparing details around the employeer taxes,
late reporting, tax surcharges and deviations.

## Time period

This endpoint delivers updated data each week up to 5 years of history for each company. Summary for financial reports
are calculated when the financial report has been registered.

## Requires elevated rights

To use this endpoint you need to contact [support@tic.io](mailto:support@tic.io) to be granted elevated rights. Such rights are only granted for users
that have specific needs for this information such as banks/lenders during credit check, bankruptcy trustee or system
integrators building systems tailored for similar industries.

## Refiling

The details for the payrolls will include a specific sequence number (9 digits) that is increased for each employee tax declaration submitted.
This means that there could be multiple entries with the same period but with different sequences which indicates a filing of
a change has been done. The result will include the differences between the amounts.

## Deviations

The summary will automatically compare the filed annual report for the business and identifty the payroll periods and use the
normal standard employer tax of 31.42%. Please note that this gives an estimate and personnel costs in the annual report
also contains other related personnel expenses. Deviations are in average +/- 10% but even up to +/- 30% occurs still
considered normal. Be careful to hightlight deviations around the interval of +/- 10-30%.

## Example and how to read the data

The following example shows a company having two financial years, 2022 and 2023. The first year 2022 has a deviation of 28,39%, e.g 330 775 SEK, with
one employee which could be considered normal. The following year 2023 the deviation is 89,07%, e.g 1 866 847 SEK, with 5 employees which is
considered very concerning. Also note that 9 periods has been filed with zero employee tax during 2023 which is also a very high number.

```bash json theme={null}
{
    "summary": [
        {
            "companyPayrollSummaryId": 528773,
            "periodStart": "2023-01-01T00:00:00",
            "periodEnd": "2023-12-31T00:00:00",
            "payrollPeriods": 12,
            "sumPayrollTax": 54786,
            "numberOfPeriods": 14,
            "numberOfPeriodsWithZero": 9,
            "personnelCostsInAnnualReport": 2096000,
            "calculatedPersonnelCosts": 229153,
            "deviationInCosts": 0.1093,
            "deviationInCostsChange": -0.8907,
            "deviationInAmount": -1866847.0,
            "numberOfEmployees": 5.00,
            "numberOfLateFeesForPeriod": 0,
            "taxSurchangeAmountForPeriod": 0,
            "lastUpdatedAtUtc": "2025-04-18T07:57:01"
        },
        {
            "companyPayrollSummaryId": 475181,
            "periodStart": "2022-01-01T00:00:00",
            "periodEnd": "2022-12-31T00:00:00",
            "payrollPeriods": 10,
            "sumPayrollTax": 199432,
            "numberOfPeriods": 10,
            "numberOfPeriodsWithZero": 0,
            "personnelCostsInAnnualReport": 1164936,
            "calculatedPersonnelCosts": 834161,
            "deviationInCosts": 0.7161,
            "deviationInCostsChange": -0.2839,
            "deviationInAmount": -330775.0,
            "numberOfEmployees": 1.00,
            "numberOfLateFeesForPeriod": 0,
            "taxSurchangeAmountForPeriod": 0,
            "lastUpdatedAtUtc": "2025-04-18T07:57:01"
        }
    ],
    "details": [
        {
            "companyPayrollDetailId": 18107908,
            "period": 202501,
            "amount": 0,
            "sequenceNumber": 479788872,
            "changeFromSamePeriodLastSequence": null
        },
        {
            "companyPayrollDetailId": 18107203,
            "period": 202412,
            "amount": 19637,
            "sequenceNumber": 479785950,
            "changeFromSamePeriodLastSequence": null
        },
        {
            "companyPayrollDetailId": 18161986,
            "period": 202411,
            "amount": 19961,
            "sequenceNumber": 480019364,
            "changeFromSamePeriodLastSequence": 19961
        },
        {
            "companyPayrollDetailId": 16756588,
            "period": 202411,
            "amount": 0,
            "sequenceNumber": 474046356,
            "changeFromSamePeriodLastSequence": null
        },
        {
            "companyPayrollDetailId": 18161987,
            "period": 202410,
            "amount": 19935,
            "sequenceNumber": 480019368,
            "changeFromSamePeriodLastSequence": 19935
        },
        {
            "companyPayrollDetailId": 16346751,
            "period": 202410,
            "amount": 0,
            "sequenceNumber": 472288276,
            "changeFromSamePeriodLastSequence": null
        },
        {
            "companyPayrollDetailId": 18161994,
            "period": 202409,
            "amount": 19763,
            "sequenceNumber": 480019396,
            "changeFromSamePeriodLastSequence": 19763
        },
        {
            "companyPayrollDetailId": 15268725,
            "period": 202409,
            "amount": 0,
            "sequenceNumber": 467731326,
            "changeFromSamePeriodLastSequence": null
        },
        {
            "companyPayrollDetailId": 18161985,
            "period": 202408,
            "amount": 19527,
            "sequenceNumber": 480019360,
            "changeFromSamePeriodLastSequence": 19527
        },
        {
            "companyPayrollDetailId": 15268710,
            "period": 202408,
            "amount": 0,
            "sequenceNumber": 467731262,
            "changeFromSamePeriodLastSequence": null
        },
        {
            "companyPayrollDetailId": 18161989,
            "period": 202407,
            "amount": 19841,
            "sequenceNumber": 480019376,
            "changeFromSamePeriodLastSequence": 19841
        },
        {
            "companyPayrollDetailId": 14586111,
            "period": 202407,
            "amount": 0,
            "sequenceNumber": 464883592,
            "changeFromSamePeriodLastSequence": null
        },
        {
            "companyPayrollDetailId": 18161984,
            "period": 202406,
            "amount": 20011,
            "sequenceNumber": 480019356,
            "changeFromSamePeriodLastSequence": 20011
        },
        {
            "companyPayrollDetailId": 14586109,
            "period": 202406,
            "amount": 0,
            "sequenceNumber": 464883584,
            "changeFromSamePeriodLastSequence": null
        },
        {
            "companyPayrollDetailId": 18161995,
            "period": 202405,
            "amount": 10305,
            "sequenceNumber": 480019400,
            "changeFromSamePeriodLastSequence": 10305
        },
        {
            "companyPayrollDetailId": 13773337,
            "period": 202405,
            "amount": 0,
            "sequenceNumber": 461479748,
            "changeFromSamePeriodLastSequence": null
        },
        {
            "companyPayrollDetailId": 18161996,
            "period": 202404,
            "amount": 10337,
            "sequenceNumber": 480019404,
            "changeFromSamePeriodLastSequence": 10337
        },
        {
            "companyPayrollDetailId": 13017287,
            "period": 202404,
            "amount": 0,
            "sequenceNumber": 458268608,
            "changeFromSamePeriodLastSequence": null
        },
        {
            "companyPayrollDetailId": 18161992,
            "period": 202403,
            "amount": 10557,
            "sequenceNumber": 480019388,
            "changeFromSamePeriodLastSequence": 10557
        },
        {
            "companyPayrollDetailId": 13017286,
            "period": 202403,
            "amount": 0,
            "sequenceNumber": 458268604,
            "changeFromSamePeriodLastSequence": null
        },
        {
            "companyPayrollDetailId": 18161997,
            "period": 202402,
            "amount": 10180,
            "sequenceNumber": 480019408,
            "changeFromSamePeriodLastSequence": 10180
        },
        {
            "companyPayrollDetailId": 13017288,
            "period": 202402,
            "amount": 0,
            "sequenceNumber": 458268612,
            "changeFromSamePeriodLastSequence": null
        },
        {
            "companyPayrollDetailId": 18161970,
            "period": 202401,
            "amount": 10211,
            "sequenceNumber": 480019298,
            "changeFromSamePeriodLastSequence": 10211
        },
        {
            "companyPayrollDetailId": 11525412,
            "period": 202401,
            "amount": 0,
            "sequenceNumber": 451898426,
            "changeFromSamePeriodLastSequence": null
        },
        {
            "companyPayrollDetailId": 11510687,
            "period": 202312,
            "amount": 0,
            "sequenceNumber": 451832012,
            "changeFromSamePeriodLastSequence": null
        },
        {
            "companyPayrollDetailId": 10839526,
            "period": 202311,
            "amount": 0,
            "sequenceNumber": 448923710,
            "changeFromSamePeriodLastSequence": null
        },
        {
            "companyPayrollDetailId": 9935592,
            "period": 202310,
            "amount": 0,
            "sequenceNumber": 445082134,
            "changeFromSamePeriodLastSequence": null
        },
        {
            "companyPayrollDetailId": 9746596,
            "period": 202309,
            "amount": 0,
            "sequenceNumber": 444272034,
            "changeFromSamePeriodLastSequence": null
        },
        {
            "companyPayrollDetailId": 9143111,
            "period": 202308,
            "amount": 0,
            "sequenceNumber": 441727966,
            "changeFromSamePeriodLastSequence": null
        },
        {
            "companyPayrollDetailId": 8804812,
            "period": 202307,
            "amount": 0,
            "sequenceNumber": 440292324,
            "changeFromSamePeriodLastSequence": null
        },
        {
            "companyPayrollDetailId": 8233512,
            "period": 202306,
            "amount": 0,
            "sequenceNumber": 437913928,
            "changeFromSamePeriodLastSequence": null
        },
        {
            "companyPayrollDetailId": 7392492,
            "period": 202305,
            "amount": 0,
            "sequenceNumber": 434338430,
            "changeFromSamePeriodLastSequence": null
        },
        {
            "companyPayrollDetailId": 7284634,
            "period": 202304,
            "amount": 0,
            "sequenceNumber": 433874650,
            "changeFromSamePeriodLastSequence": null
        },
        {
            "companyPayrollDetailId": 6878989,
            "period": 202303,
            "amount": 21404,
            "sequenceNumber": 432142666,
            "changeFromSamePeriodLastSequence": 2552
        },
        {
            "companyPayrollDetailId": 6405871,
            "period": 202303,
            "amount": 18852,
            "sequenceNumber": 430126298,
            "changeFromSamePeriodLastSequence": null
        },
        {
            "companyPayrollDetailId": 6334129,
            "period": 202302,
            "amount": 11978,
            "sequenceNumber": 429797046,
            "changeFromSamePeriodLastSequence": -9426
        },
        {
            "companyPayrollDetailId": 5896383,
            "period": 202302,
            "amount": 21404,
            "sequenceNumber": 427950420,
            "changeFromSamePeriodLastSequence": null
        },
        {
            "companyPayrollDetailId": 5378647,
            "period": 202301,
            "amount": 21404,
            "sequenceNumber": 425728230,
            "changeFromSamePeriodLastSequence": null
        },
        {
            "companyPayrollDetailId": 4867707,
            "period": 202212,
            "amount": 21404,
            "sequenceNumber": 423536396,
            "changeFromSamePeriodLastSequence": null
        },
        {
            "companyPayrollDetailId": 4356411,
            "period": 202211,
            "amount": 21404,
            "sequenceNumber": 421345580,
            "changeFromSamePeriodLastSequence": null
        },
        {
            "companyPayrollDetailId": 3860894,
            "period": 202210,
            "amount": 21404,
            "sequenceNumber": 419231924,
            "changeFromSamePeriodLastSequence": null
        },
        {
            "companyPayrollDetailId": 3384860,
            "period": 202209,
            "amount": 21404,
            "sequenceNumber": 417215584,
            "changeFromSamePeriodLastSequence": null
        },
        {
            "companyPayrollDetailId": 2894349,
            "period": 202208,
            "amount": 21404,
            "sequenceNumber": 415142778,
            "changeFromSamePeriodLastSequence": null
        },
        {
            "companyPayrollDetailId": 2331793,
            "period": 202207,
            "amount": 21404,
            "sequenceNumber": 412791498,
            "changeFromSamePeriodLastSequence": null
        },
        {
            "companyPayrollDetailId": 1934797,
            "period": 202206,
            "amount": 17752,
            "sequenceNumber": 411137550,
            "changeFromSamePeriodLastSequence": null
        },
        {
            "companyPayrollDetailId": 1432737,
            "period": 202205,
            "amount": 17752,
            "sequenceNumber": 408999166,
            "changeFromSamePeriodLastSequence": null
        },
        {
            "companyPayrollDetailId": 960012,
            "period": 202204,
            "amount": 17752,
            "sequenceNumber": 406970412,
            "changeFromSamePeriodLastSequence": null
        },
        {
            "companyPayrollDetailId": 441497,
            "period": 202203,
            "amount": 17752,
            "sequenceNumber": 404752120,
            "changeFromSamePeriodLastSequence": null
        }
    ]
}
```


# Phonenumbers
Source: https://docs.tic.io/api-core/companies/phonenumbers

get /datasets/companies/{companyId}/phone-numbers
Gets the phone numbers of the company



# Properties
Source: https://docs.tic.io/api-core/companies/properties

get /datasets/companies/{companyId}/se/properties
Get the companys properties

Returns a list of properties in Sweden belonging to a company. Please note that the field fastighetObjektIdentitet (property UUID)
is the value you use to query for high-resolution ortophotos [here](/api-core/properties/orthophotos) or get a
summary of the property [here](/api-core/properties/summary).


# Purposes
Source: https://docs.tic.io/api-core/companies/purposes

get /datasets/companies/{companyId}/purpose
Gets the purposes of the company



# Registered offices
Source: https://docs.tic.io/api-core/companies/registered-offices

get /datasets/companies/{companyId}/registered-offices
Lists all registered offices addresses of a company



# Registration
Source: https://docs.tic.io/api-core/companies/registration

get /datasets/companies/{companyId}/registration
Gets VAT, Payroll, Tax and other registrations



# Salary contributions
Source: https://docs.tic.io/api-core/companies/salary-contributions

get /datasets/companies/{companyId}/se/salary-contributions
Lists contributions from Swedish employment service for the company



# Share capital
Source: https://docs.tic.io/api-core/companies/share-capital

get /datasets/companies/{companyId}/share-capital
Gets the share capital of the company



# Share class
Source: https://docs.tic.io/api-core/companies/share-class

get /datasets/companies/{companyId}/share-class
Gets the share classes of the company



# Share issue
Source: https://docs.tic.io/api-core/companies/share-issue

get /datasets/companies/{companyId}/share-issue
Gets the company share issues



# Share register
Source: https://docs.tic.io/api-core/companies/share-register

get /datasets/companies/{companyId}/share-register
Gets whats known about the companys share register.

This endpoint contains any information we may know about the share-register. Remember this is not the
companies actual share-register. Instead this information is gathered from multiple sources such
as minutes where the voters register could be present or from authorities such as SCB (Statistikmyndigheten)
which collects information about parent companies.

If numberOfShares is empty / null it means we have no information about the actual number of shares but
typically it represents a parent company.

The endpoint helps gathering information from various sources for ownership investigations tailored for KYC
purposes. The purpose is not to visualize the full share-register.


# Signatories
Source: https://docs.tic.io/api-core/companies/signatories

get /datasets/companies/{companyId}/signatories
Gets the company signatories



# SNI codes
Source: https://docs.tic.io/api-core/companies/sni-codes

get /datasets/companies/{companyId}/se/sni
Get the companys industry codes as per Swedish Standard Industrial Classification (SNI)



# Status
Source: https://docs.tic.io/api-core/companies/status

get /datasets/companies/{companyId}/status
Gets the status of the company



# Summary
Source: https://docs.tic.io/api-core/companies/summary

get /datasets/companies/{companyId}
Gets a summary of the company by it's id



# Tax respite
Source: https://docs.tic.io/api-core/companies/temporary-tax-respites

get /datasets/companies/{companyId}/se/temporary-tax-payment-respite
Retrieves historic and current temporary payment tax respite

This endpoint contains information about temporary tax payment respites that companies has been granted.


# Trademarks
Source: https://docs.tic.io/api-core/companies/trademarks

get /datasets/companies/{companyId}/trademarks
Gets trademarks registered to the company



# Ownership tree
Source: https://docs.tic.io/api-core/companies/tree

get /datasets/companies/{companyId}/tree
Retrieves a tree representing the group of companies

Returns a tree representing what's known about the ownership of the group of companies. Each node and company contains
up-to-date information about the company. The field, isSelected, will be set to true for the requested companyId to simplify
highlighting.

<Note>
  This is a recursive cached endpoint meaning expect large responses for
  companies included in a large group. Also expect response times between 0-5000
  ms depending on size of the tree and if it's cached or not. Therefore set your
  request timeout to 5000 ms.
</Note>

## Sources

Trees are built from the following sources:

1. Annual reports
2. Records of beneficial ownership
3. Registered information for the group of companies at SCB

## Accurancy

There is no requirement for companies to register the structure of the group of companies with any authority in Sweden. This
means that the information acquired from an annual report could be outdated or deviate against the actual ownership records
a few months later.

There is a flag in the root object called, deviationExists, which marks if the tree structure cannot be validated
against information the company has registered with SCB (Swedish: Statistikmyndigheten).

## Update frequency

We continuously make updates based on new filings of annual reports, changes of beneficial ownership and registered information at SCB
and reports from companies themself or our users.


# Vehicles
Source: https://docs.tic.io/api-core/companies/vehicles

get /datasets/companies/{companyId}/se/vehicles
Retrieves current vehicles the company owns or is a user of

Returns a list of vehicles and their technical data that the company owns or is a current user of. You can return
maximum 250 records per page, use querystring parameters pageSize=10 and page=1 to control how many records you want to retrieve per page.

## Lightning fast

This endpoint uses our lightning fast and ultra modern search for vehicles. If you want to do additional
filtering you can use [Search for vehicles here](/datasets/search-vehicles).

To query for specific owners in [Search for vehicles here](/datasets/search-vehicles) you simply attach either a query string
\&filter\_by=currentUserCompanyId:=1911258||currentOwnerCompanyId:=1911258 or post this to the MultiSearch endpoint. Replace
19111258 with our companyId which is a worldwide identifier for companies.

CompanyId is retrived from our lighting fast [Search for companies here](/datasets/search-companies).


# Vehicles history
Source: https://docs.tic.io/api-core/companies/vehicles-history-owner

get /datasets/companies/{companyId}/se/vehicles-history-owner
Retrieves historic vehicles the company owned or was a user of

Returns a list of vehicles that company has been an owner or user of. History up to about 3 years in time. Vehicles are returned
in the order of when the last owner change from the company occured. The intention of the endpoint is to quickly get an overview of any vehicles
that may have been sold or transferred to other parties for example prior to a bankruptcy event.

Therfore only maximum 1000 history owned or used vehicles are returned in the response.

## EventStartDate and EventEndDate

The fields EventStartDate and EventEndDate represents that last duration when the company was the owner or user of the vehicle. This means
for example with the following json response:

```json Example response theme={null}
{
[
    {
        "vehicleId": 1,
        "licencePlate": "XXX000",
        "vehicleType": "SLÄP",
        "vehicleName": "ABC",
        "tradeName": null,
        "modelYear": 2008,
        "vehicleYear": 2008,
        "colorSwedish": "VIT",
        "vin": "123",
        "currentOwnerCompanyId": 123,
        "currentOwnerCompanyRegistrationNumber": "This is the current company registered as owner",
        "currentOwnerCompanyLegalName": "XXX",
        "currentUserCompanyId": 123,
        "currentUserCompanyRegistrationNumber": null,
        "currentUserCompanyLegalName": "This is the company currentley using the vehicle",
        "eventStartDate": "2023-08-02T00:00:00",
        "eventEndDate": "2025-01-22T00:00:00"
    },
```

This means that the company you are requesting date for was an owner or user of the vehicle between 2023-08-02, e.g eventStartDate,
and 2025-01-22, e.g eventEndDate.


# Workplace summary
Source: https://docs.tic.io/api-core/companies/workplaces

get /datasets/companies/{companyId}/workplaces
Gets a summary of the companys workplaces



# Documents
Source: https://docs.tic.io/api-core/financial-documents/financial-documents-se

get /financial-documents/se/{financialDocumentReference}
Get available financial documents by id

### Details

This endpoint with the URL segment /se is for Sweden. Each region has it's own URL. With this endpoint you get information
about which format exists of each document and various content.

Please note that this endpoint is for fast retrieval from our distributed storage plattform. If you want to access the
financial data that has been interpreted, calculated and run through our [AI Anomly Detection](/technology/ai-anomaly-detection) you
should look in the [intelligence](/api-core/companies/intelligence), [financial-summary](/api-core/companies/financial-summary) and
[financial-reports](/api-core/companies/financial-reports) endpoints.

These endpoints are for downloading and showing users financial reports or for your own custom solutions.

### Response and example

This endpoint with the URL segment /se is for Sweden. Each region has it's own URL. With this endpoint you get information
about which documents exists. The response includes an array of documents available for each report. To retrieve metadata
about a report the URL metadata should be included in the availableFiles array.

```json Example response theme={null}
{
  "financialDocumentReference": "2_0",
  "isElectronic": true,
  "caseNumber": 9000102,
  "caseYear": 2024,
  "caseRegistrationDate": "2024-01-01T16:05:16",
  "availableFiles": [
    {
      "fileType": "reportPDF",
      "url": "https://api.tic.io/financial-documents/se/2_0/pdf"
    },
    {
      "fileType": "reportXBRL",
      "url": "https://api.tic.io/financial-documents/se/2_0/xbrl"
    },
    {
      "fileType": "errorXHTML",
      "url": "https://api.tic.io/financial-documents/se/2_0/error"
    },
    {
      "fileType": "reportXHTML",
      "url": "https://api.tic.io/financial-documents/se/2_0/ixbrl"
    },
    {
      "fileType": "metadata",
      "url": "https://api.tic.io/financial-documents/se/2_0/metadata"
    }
  ]
}
```


# Audit iXBRL
Source: https://docs.tic.io/api-core/financial-documents/financial-documents-se-audit-ixbrl

get /financial-documents/se/{financialDocumentReference}/audit/ixbrl
Download or view the financial audit document by it's id in the iXBRL format

### Details

This will return the audit document in a XHTML (iXBRL) format inline with the browser.
To force a download you can use querystring inline=false.


# Audit PDF
Source: https://docs.tic.io/api-core/financial-documents/financial-documents-se-audit-pdf

get /financial-documents/se/{financialDocumentReference}/audit/pdf
Download or view the financial audit document by it's id in the PDF format

### Details

This will return the audit document in a PDF format inline with the browser e.g it will
open the browser PDF viewer. To force a download you can use querystring inline=false.


# Audit XBRL
Source: https://docs.tic.io/api-core/financial-documents/financial-documents-se-audit-xbrl

get /financial-documents/se/{financialDocumentReference}/audit/xbrl
Download or view the financial audit document by it's id in the XBRL format

### Details

This will return the audit document in a XBRL format inline with the browser e.g it will
open the browser PDF viewer (XML). To force a download you can use querystring inline=false.


# Report overlay
Source: https://docs.tic.io/api-core/financial-documents/financial-documents-se-report-error

get /financial-documents/se/{financialDocumentReference}/error
Download or view the financial document by it's id in the iXBRL format and overlay errors

### Details

This will return the report in a XBRL format inline with the browser e.g it will
open the browser PDF viewer (XML). To force a download you can use querystring inline=false.

It will inject a script that hightlights any errors in the annual report and also display a
table. You can acess the error object in the window object, window\.model.

Example

```json Example of window.model object theme={null}
{
  "intellience": [
    {
      "id": 1172573,
      "subType": "MANAGEMENT_REPORT_ERR",
      "notes": "The annual report is missing the management report.",
      "score": 255
    }
  ],
  "duplicates": [
    {
      "elementName": "se-gen-base:AndraLangfristigaVardepappersinnehavAnskaffningsvarden",
      "context": "BALANS1",
      "description": "Duplicate facts with inconsistency",
      "errorValue": "70240",
      "elements": [{}, {}]
    }
  ]
}
```


# Report iXBRL
Source: https://docs.tic.io/api-core/financial-documents/financial-documents-se-report-ixbrl

get /financial-documents/se/{financialDocumentReference}/ixbrl
Download or view the financial document by it's id in the iXBRL format

### Details

This will return the report in a XHTML (iXBRL) format inline with the browser.
To force a download you can use querystring inline=false.

Please note that if no iXBRL document is available you will get 404 - Not found.

iXBRL is a format that combines tradional HTML with XML elements from the XBRL standard.
It works fine for user experiences where you don't want a PDF viewer to open.

You can also use this document if you want to provide your own processing of the
financial data.


# Report metadata
Source: https://docs.tic.io/api-core/financial-documents/financial-documents-se-report-metadata

get /financial-documents/se/{financialDocumentReference}/metadata
Get metadata for the financial document with id

### Details

This will return the any known metadata for the financial report.


# Report PDF
Source: https://docs.tic.io/api-core/financial-documents/financial-documents-se-report-pdf

get /financial-documents/se/{financialDocumentReference}/pdf
Download or view the financial document by it's id in the PDF format

### Details

This will return the report in a PDF format inline with the browser e.g it will
open the browser PDF viewer. To force a download you can use querystring inline=false.

It the financial report was scanned it has been going through TIC IDP solution which
means we try to increase visiblity and make the document searchable (PDF freetext search).

Embedded in the PDF you will find hOCR data.


# Report XBRL
Source: https://docs.tic.io/api-core/financial-documents/financial-documents-se-report-xbrl

get /financial-documents/se/{financialDocumentReference}/xbrl
Download or view the financial document by it's id in the XBRL format

### Details

This will return the report in a XBRL format inline with the browser e.g it will
open the browser PDF viewer (XML). To force a download you can use querystring inline=false.

Used by users wanting to process raw compact information not used to visualize data
directly.


# Legacy API (v1)
Source: https://docs.tic.io/api-core/introduction

TIC's legacy v1 API - still fully supported for existing integrations. For new integrations, use the LENS API (v2).

Our core datasets constitutes our core as a credit reference agency. We gather and process information
continuously every second. Industry datasets are combined with our core datasets to enrich data and offer
much better tools for credit scoring, vendor and customer evaluation, prospecting and statistical data analysis.

# Search

TIC provides an easy to use search API based on [Typesense](https://typesense.org) lightning-fast search database.

Check out examples and [documentation here](/api-core/search).

## Accounts

<Note>
  In the [LENS API (v2)](/api-lens/introduction), "accounts" have been renamed to **watchlists** and their scope expanded to include addresses, properties, and vehicles in addition to companies and persons. The v1 term "account" and the v2 term "watchlist" refer to the same concept.
</Note>

An account groups together companies and persons - technically it's a list. Each account can contain one or more users with access.

Accounts are useful for:

* Grouping vendors
* Grouping customers
* Tracking arbitrary lists of companies and persons

Each account references one or more companies and/or persons, and can have a webhook attached to post event changes for those members.

## Companies

Each company contains a large number of current and historic records. Each stored in different entities and
urls. When you search you will get an aggregate of certain records that are used for search purposes. but
to get access to all historic records you need to access each endpoint.

Changes in for example in a company purpose is recorded under
[https://api.tic.io/datasets/companies/\{companyId}/purpose](https://api.tic.io/datasets/companies/\{companyId}/purpose) with details when it was changed.


# Authorizations
Source: https://docs.tic.io/api-core/lists/lists-authorizations

get /datasets/lists/authorizations
Gets a list of all authorizations

Allows you to get a list optionally filtered by from and to date. Please note that a list
would could contain also historic changes so you need to handle the case number and
case year to group you result.


# Bonus issues
Source: https://docs.tic.io/api-core/lists/lists-bonus-issues

get /datasets/lists/bonus-issues
Gets a list of all bonus issues

Allows you to get a list optionally filtered by from and to date. Please note that a list
would could contain also historic changes so you need to handle the case number and
case year to group you result.


# Share issues
Source: https://docs.tic.io/api-core/lists/lists-share-issues

get /datasets/lists/share-issues
Gets a list of all shares issues

Allows you to get a list optionally filtered by from and to date. Please note that a list
would could contain also historic changes so you need to handle the case number and
case year to group you result.


# Trademark media
Source: https://docs.tic.io/api-core/media/trademark-se-availablemedia

get /media/trademarks/se/{trademarkId}
Gets available media for trademark

### Details

This will return available media for the given trademark.


# Trademark media format
Source: https://docs.tic.io/api-core/media/trademark-se-mediaformat

get /media/trademarks/se/{trademarkId}/{mediaFileFormat}
Gets the media for the trademark

### Details

This will return the actual given media file with the format. Note
that only formats available can be returned and no conversion
will be carried out.


# Addresses
Source: https://docs.tic.io/api-core/persons/addresses

get /datasets/persons/{personId}/addresses
Returns a list of known addresses

Lists all addresses for a given person. If you want latitude and longitude for the address
you can use the adressId to query for additional address details.

### Source

The property, source, contains the actual source of the information and depends on country.

### Address Type

The property, addressType, is a string enum containing the type of the address

| Field                          | Description                                                      |
| ------------------------------ | ---------------------------------------------------------------- |
| populationRegisterAddress      | The public adress of the person                                  |
| contactAddress                 | Contact adress to the person                                     |
| internationalAddress           | International address to the person                              |
| particularAddress              | Particular address (särskild adress) to the person               |
| particularInternationalAddress | Particular adress (särskild internationell adress) to the person |
| contactInternationalAddress    | International contact address to the person                      |


# Beneficial owner
Source: https://docs.tic.io/api-core/persons/beneficial-owner

get /datasets/persons/se/{personId}/beneficial-owner
Gets a list of companies where the person has beneficiary owner entries

Lists all companies where the person has current of historic beneficial owner entries. Please note that
the default page size is 100 but this endpoint allows up to 1000 records
per page.

The result is flattened meaning it can include multiple lines for each registered case number and
year that specifies extent codes, extent descriptions, govern codes and govern descriptions. Also
it can include multiple results for each company depending on changes of beneficiary entries.

Includes a summary for the beneficial owner company but if the entry is governed through another
company we include company id, registration number and legal name.


# Companies
Source: https://docs.tic.io/api-core/persons/companies

get /datasets/persons/{personId}/companies
Gets a list of the companies where the person is or has been a representative of

Lists all companies the person is being a representative of. Please note that
the default page size is 100 but this endpoint allows up to 1000 records
per page.

Includes a summary for the company.


# Details by person id
Source: https://docs.tic.io/api-core/persons/details

get /datasets/persons/{personId}
Gets the person by id



# Details by identity number
Source: https://docs.tic.io/api-core/persons/details-se

get /datasets/persons/se/{identityNumber}
Gets the person by identity number for Swedish identities

This endpoint is used to retrieve the personId for subsequent calls. You can query by personal identity numbers,
coordination numbers and retrieve a summary including the personId.


# Details with SPAR by identity number
Source: https://docs.tic.io/api-core/persons/details-se-spar

get /datasets/persons/se-spar/{identityNumber}
Gets the person by identity number for Swedish identities

This endpoint is used to retrieve the person with SPAR details. This endpoint is only enabled for customers that passed certain requirements (purpose validation) and
has separate throttling enabled.


# Graph
Source: https://docs.tic.io/api-core/persons/graph

get /datasets/persons/{personId}/graph
Returns a graph with persons, companies and optional beneficial owners

Returns a graph with nodes and edges representing the relationships between
persons and companies and optionally beneficial owners.

Can be used by graph visualization such as:

* [Linkurious Ogma](https://resources.linkurious.com/ogma-overview)
* [Cambridge Intelligence Keylines](https://cambridge-intelligence.com/keylines-javascript-graph-visualization/)
* [Sigma.js](https://www.sigmajs.org/)
* [Memgraph Orb](https://github.com/memgraph/orb)

The properties for nodes and edges are dynamic and can be used to control styling and highlighting of nodes.


# Properties
Source: https://docs.tic.io/api-core/persons/properties

get /datasets/persons/se/{personId}/properties
Get the persons properties

This endpoint is used to retrieve information about owned properties for an individual. This endpoint is only applicable for credit information
customers that passed certain requirements (purpose validation) and has separate throttling enabled.


# Search
Source: https://docs.tic.io/api-core/persons/search

get /datasets/persons
Search for a person



# Get all current historic property owners
Source: https://docs.tic.io/api-core/properties/all-owners

get /datasets/properties/se/{uuid}/all-owners
Gets all current and historic property owners based on it's UUID

Gets all current and historic owners of a property. This endpoint is a direct order endpoint meaning it will incur costs on your account based on the fee schedule from Lantmäteriet. This endpoint is only available to customers that
passed certain requirements (purpose test).

Each request is cached for 24 hours so making subsequent request will not incur additional costs. If you want to test without causing any costs you can use the property uuid: 909a6a85-299b-90ec-e040-ed8f66444c3f which
is the property UMEÅ AMERIKA 1:1.

The endpoint contains specific throttling.

Use the querystring includeXml to also retrieve the raw xml data that was handed over from Lantmäteriet.


# Get property by latitude and longitude (WGS84)
Source: https://docs.tic.io/api-core/properties/by-location

get /datasets/properties/se/by-location
Gets the property (fastighet) containing the given WGS84 position



# Get property by easting and northing (SWEREF99 TM)
Source: https://docs.tic.io/api-core/properties/by-location-sweref99

get /datasets/properties/se/by-location-sweref99
Gets the property (fastighet) containing the given SWEREF99 TM position (SRID 3006)



# Details
Source: https://docs.tic.io/api-core/properties/details

get /datasets/properties/se/{uuid}/details
Gets the details of the property based on it's UUID

Gets the details for the given property with it's unique identifier. This endpoint includes free to use property data that is included in the subscription.

It contains the following data:

* Basic information about area, label
* Areas, areals, surface in WGS84
* Buildings, usage, type, shelter and surface in WGS84
* Taxation, basic information

If you need access to all registration information for example owner, purchase amount and many other things you need to download a full property report that
will be charged to your account separatley.


# Details full
Source: https://docs.tic.io/api-core/properties/details-full

get /datasets/properties/se/{uuid}/details-full
Gets the full details of the property based on it's UUID

Gets the details for the given property with it's unique identifier. This endpoint includes extended credit data only available to customers that
passed certain requirements (purpose test).

The endpoint contains specific throttling.


# Get land regulation provisions
Source: https://docs.tic.io/api-core/properties/land-regulation-provisions

get /datasets/properties/se/{uuid}/land-regulation-provisions
Gets the land regulation provisions for a property based on it's UUID

Gets all land regulation provisions (markreglerande bestämmelser). This endpoint is a direct order endpoint meaning it will incur costs on your account based on the fee schedule from Lantmäteriet. This endpoint is only available to customers that
passed certain requirements (purpose test).

Each request is cached for 24 hours so making subsequent request will not incur additional costs. If you want to test without causing any costs you can use the property uuid: 909a6a85-299b-90ec-e040-ed8f66444c3f which
is the property UMEÅ AMERIKA 1:1.

The endpoint contains specific throttling.

Use the querystring includeXml to also retrieve the raw xml data that was handed over from Lantmäteriet.


# Get ortophotos by property UUID
Source: https://docs.tic.io/api-core/properties/orthophotos

get /datasets/properties/se/{uuid}/orthophotos
Gets available ortophotos by authority UUID

Get a list of all high-resolution orthophotos for each year. We will automatically mark
the property areas and their boundary and enhance image quality for displaying directly in a web application.

The response will include the open URL or reduced image URL to the high resolution image which you can directly reference.
Please note that typical response times are 50-100 ms per image for areas up to \~100 000 m2 so make sure your request doesn't time out since a response could contain
up to 10 years of high-resolutions images (expect 1-3 seconds of non cached images).

<Warning>
  This endpoint will only serve images up to 2 000 000 m² and for very large
  areas response times can vary between 5-15 seconds per image (expect 45 - 90
  seconds response times).
</Warning>

Response will include a URL, url, representing loseless PNG which can be expected to be significant of size for large areas. We also
include a reduced version, urlReduced, in JPEG format (compressed) and images exceeding 2500 px in width will be resized to 2500 px
to avoid very large image sizes.

We recommend using the urlReduced for small displays and only use the full loselsess PNG for situations where you may need
the full details. Also included is the file sizes in byte for fileNameLength (url) and fileNameReducedLength (urlReduced). These
can help to make simple checks if you want to display the PNG or the JPEG image.

### Example

This example shows a retrieved image for the property, UMEÅ AMERIKA 1:1, having an area of 1 068 479 m² (large)
and the image rendered represents urlReduced e.g a compressed version in JPEG format. File size is \~2.3MB since it has been reduced to maximum 2500px in width (2500 x 1814px).

If you switch the URL extension to PNG (e.g [https://storage.tic.io/909a6a85-299b-90ec-e040-ed8f66444c3f\_2024\_32098.png](https://storage.tic.io/909a6a85-299b-90ec-e040-ed8f66444c3f_2024_32098.png))
you will get the full uncompressed and unmodified size of 12619 x 9156 px. The file size is now \~237MB.

![Example of a property 1 068 479 m²](https://storage.tic.io/909a6a85-299b-90ec-e040-ed8f66444c3f_2024_32098.jpg)

### Recommendations

Recommendation is to use an if-statement to check if the fileNameLength is less than 10000000 (10MB) and
display the url and if it's greater than 10000000 display the urlReduced.


# Get ortophotos by latitude and longitude
Source: https://docs.tic.io/api-core/properties/orthophotos-by-location

get /datasets/properties/se/orthophotos
Gets available ortophotos by latitude and longitude

Get a list of all high-resolution orthophotos for each year based on given center latitude and longitude.

The response will include the open URL to the high resolution image which you can directly reference.
Please note that typical response times are 50-100 ms per image so make sure your request doesn't time out since a response could contain
up to 10 years of high-resolutions images (expect 1-3 seconds of non cached images).

Use the bufferDistance to set a distance from 20 meters up to 200 meters (default 100 meters) from the center.


# Get property rights
Source: https://docs.tic.io/api-core/properties/rights

get /datasets/properties/se/{uuid}/rights
Gets the property rights for a property based on it's UUID

Gets all property rights (rättigheter). This endpoint is a direct order endpoint meaning it will incur costs on your account based on the fee schedule from Lantmäteriet. This endpoint is only available to customers that
passed certain requirements (purpose test).

Each request is cached for 24 hours so making subsequent request will not incur additional costs. If you want to test without causing any costs you can use the property uuid: 909a6a85-299b-90ec-e040-ed8f66444c3f which
is the property UMEÅ AMERIKA 1:1.

The endpoint contains specific throttling.

Use the querystring includeXml to also retrieve the raw xml data that was handed over from Lantmäteriet.


# Summary
Source: https://docs.tic.io/api-core/properties/summary

get /datasets/properties/se/{uuid}
Gets a summary of the property based on it's UUID

Get a summary for the given property with it's unique identifier.


# Search companies
Source: https://docs.tic.io/api-core/search

Lightning fast and ultra modern search search-as-you-type, autocomplete, geo-search, LLM augmentation

We provide an easy to use search API based on [Typesense](https://typesense.org) lightning-fast search database.
That means that all features described in [Typesense API version 29](https://typesense.org/docs/29.0/api/) is available in our API.

Search index is stored on RAM memory meaning requests to our search serves very fast and you can use it for search-as-you-type,
autocomplete and other applications.

We today provide four rich search collections:

* **Company search (you are here)**
* [Workplace search](/datasets/search-workplaces)
* [Financial reports search](/datasets/search-reports-se)
* [Bankruptcies](/datasets/search-bankruptcies-se)

## Company search

In companies search you can query and filter by more than **187 fields** listed in the next chapter.

Examples on what you can query on:

* Company Id (our system wide identifier for global companies used across all API calls)
* Country code (ISO 2 letters)
* Registrationnumber (For local region)
* Most recent purpose
* Names (all historic and current names)
* Phonenumbers
* Email addresses
* Hyperlinks
* Bankaccounts
* Addresses (registered, visting and mailing address)
* Document and case history
* Stock
* LEI
* PIC (European Commission)
* Franchises and licences
* Involvement by representatives
* Company representatives
* Beneficial owners
* Property tax
* Vehicles

The response model (schema) depends on your query and if you use faceting. If you
do plain search we have added to our OpenAPI Schema the default response
model namned TypesenseCompanyDocument.

<Card title="OpenAPI Schema" icon="link" href="https://api.tic.io/docs/v1/swagger.json">
  Look for the model name TypesenseCompanyDocument in the schema definition.
</Card>

## Important about redacted properties

Depending on price plan certain properties may not be included. For simplicity we add an object called redacted which contains
a list of redacted properties. An example below shows how the JSON response would look like if you for example don't have AUDITOR\_ACCOUNTING\_ISSUES
to the properties mostRecentDebtorSummary and currentBeneficialOwners.

```bash json theme={null}
"redacted": ['mostRecentDebtorSummary','currentBeneficialOwners']...
```

## Fields indexed

The following fields are currently indexed in memory. These can be used in the query\_by parameter and filter\_by. Remember this is not the
schema of the JSON response since it contains a large number of additional properties.

| Field                                                        | Type     | Description                                                                                                                                    |
| ------------------------------------------------------------ | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
| companyId                                                    | Int32    | Our global internal company identifier                                                                                                         |
| registrationNumber                                           | String   | The local registration number in the country                                                                                                   |
| legalEntityType                                              | String   | Type of legal entity as described in local market                                                                                              |
| localCompanyCode                                             | String   | The local company code as known by the market (for example Aktiebolag = AB)                                                                    |
| elfCode                                                      | String   | ISO Standard 20275 Entity Legal Form (ELF)                                                                                                     |
| registrationDate (unix epoch)                                | Int64    | Unix time (epoch) seconds since 1st January 1970                                                                                               |
| ceasedDate (unix epoch)                                      | Int64    | Unix time (epoch) seconds since 1st January 1970, when the company ceased to exist (note date may be unknown by the flag isCeased will be set) |
| isCeased                                                     | Bool     | A flag indicating the business have ceased                                                                                                     |
| mostRecentPurpose                                            | String   | The last purpose registered for the business                                                                                                   |
| names.nameOrIdentifier                                       | String   | Current and former names of the business (could be legalname, particularName etc)                                                              |
| isRegisteredForVAT                                           | Bool     | If the business is registered for VAT                                                                                                          |
| isRegisteredForFTax                                          | Bool     | If the business is registered for F-tax                                                                                                        |
| isRegisteredForPayroll                                       | Bool     | If the business is registered for payroll                                                                                                      |
| ftaxTerminationReason                                        | String   | If the termination of F-tax is known a description                                                                                             |
| phoneNumbers.e164PhoneNumber                                 | String   | E164 formatted phone number                                                                                                                    |
| phoneNumbers.numberPlanServiceType                           | String   | Service type as described in local number plan                                                                                                 |
| phoneNumbers.orginalOperator                                 | String   | The original operator that held the number                                                                                                     |
| phoneNumbers.priorOperator                                   | String   | Last prior operator before the porting                                                                                                         |
| phoneNumbers.currentOperator                                 | String   | Current operator                                                                                                                               |
| phoneNumbers.lastPortingDate                                 | Int64    | Last porting date in Unix time (epoch) seconds since 1st January 1970                                                                          |
| emailAddresses.emailAddress                                  | String   | E-mail addresses to the business                                                                                                               |
| hyperlinks.hyperlink                                         | String   | Hyperlinks to the business                                                                                                                     |
| sniCodes.sni\_2007Name                                       | String   | SNI 2007 name                                                                                                                                  |
| sniCodes.sni\_2007Code                                       | String   | SNI 2007 code                                                                                                                                  |
| sniCodes.rank                                                | String   | SNI 2007 order                                                                                                                                 |
| bankAccounts.accountNumber                                   | String   | Bank accounts                                                                                                                                  |
| mostRecentRegisteredAddress.co                               | String   | C/O = care of address                                                                                                                          |
| mostRecentRegisteredAddress.streetAddress                    | String   | Street address                                                                                                                                 |
| mostRecentRegisteredAddress.postalCode                       | String   | The postalcode                                                                                                                                 |
| mostRecentRegisteredAddress.city                             | String   | City                                                                                                                                           |
| mostRecentRegisteredAddress.countryCodeAlpha3                | String   | Country code 3 char alpha                                                                                                                      |
| mostRecentRegisteredAddress.location                         | GeoPoint | Allows geosearch                                                                                                                               |
| mostRecentMailingAddress.co                                  | String   | C/O = care of address                                                                                                                          |
| mostRecentMailingAddress.streetAddress                       | String   | Street address                                                                                                                                 |
| mostRecentMailingAddress.postalCode                          | String   | The postalcode                                                                                                                                 |
| mostRecentMailingAddress.city                                | String   | City                                                                                                                                           |
| mostRecentMailingAddress.countryCodeAlpha3                   | String   | Country code 3 char alpha                                                                                                                      |
| mostRecentMailingAddress.location                            | GeoPoint | Allows geosearch                                                                                                                               |
| mostRecentVisitingAddress.co                                 | String   | C/O = care of address                                                                                                                          |
| mostRecentVisitingAddress.streetAddress                      | String   | Street address                                                                                                                                 |
| mostRecentVisitingAddress.postalCode                         | String   | The postalcode                                                                                                                                 |
| mostRecentVisitingAddress.city                               | String   | City                                                                                                                                           |
| mostRecentVisitingAddress.countryCodeAlpha3                  | String   | Country code 3 char alpha                                                                                                                      |
| mostRecentVistingAddress.location                            | GeoPoint | Allows geosearch                                                                                                                               |
| registeredOffices.municipality                               | String   | The registered office municipality (säte)                                                                                                      |
| registeredOffices.municipalityCode                           | String   | The registered office municipality code (säte)                                                                                                 |
| registeredOffices.county                                     | String   | The registered office county (säte)                                                                                                            |
| registeredOffices.countyCode                                 | String   | The registered office county code (säte)                                                                                                       |
| documents.documentTitle                                      | String   | Title of the document                                                                                                                          |
| documents.documentVersion                                    | String   | Version of the document                                                                                                                        |
| documents.documentValue3                                     | String   | Used to provide additional data about the document                                                                                             |
| intelligence.companyIntelligenceType                         | String   | The specific enum (int) that you want to query by                                                                                              |
| intelligence.companyIntelligenceSubType                      | String   | A text enum describing the sub-type of the intelligence type (see documentation)                                                               |
| intelligence.notes                                           | String   | The description of the discrepancy                                                                                                             |
| intelligence.score                                           | Int32    | A score rank between 0-255 where 0 means only for information and 255 is a serious mark                                                        |
| intelligence.externalId                                      | Int32    | A reference for the intelligence type used to find the associated underlying document                                                          |
| mostRecentFinancialSummary.annualReportPeriod                | Int32    | The endpoint report of the annual report in YYYYMM as Int32                                                                                    |
| mostRecentFinancialSummary.periodStart                       | Int64    | Start period epoch seconds                                                                                                                     |
| mostRecentFinancialSummary.periodEnd                         | Int64    | End period epoch seconds                                                                                                                       |
| mostRecentFinancialSummary.rs\_NetSalesK                     | Int32    | Net sales in K (thousands)                                                                                                                     |
| mostRecentFinancialSummary.rs\_OtherOperatingIncomeK         | Int32    | Other operating income in K (thousands)                                                                                                        |
| mostRecentFinancialSummary.rs\_OperatingProfitOrLossK        | Int32    | Operating profit or loss in K (thousands)                                                                                                      |
| mostRecentFinancialSummary.rs\_SumFinancialItemsK            | Int32    | Sum of financial items in K (thousands)                                                                                                        |
| mostRecentFinancialSummary.rs\_ProfitAfterFinancialItemsK    | Int32    | Profit after financial items in K (thousands)                                                                                                  |
| mostRecentFinancialSummary.bs\_TotalAssetsK                  | Int32    | Total assets in balance sheet in K (thouands)                                                                                                  |
| mostRecentFinancialSummary.fn\_NumberOfEmployees             | Float    | Number of employees with one decimal                                                                                                           |
| mostRecentFinancialSummary.km\_OperatingMargin               | Float    | Operating margin with four decimals                                                                                                            |
| mostRecentFinancialSummary.km\_NetProfitMargin               | Float    | Net profit margin with four decimals                                                                                                           |
| mostRecentFinancialSummary.km\_EquityAssetsRatio             | Float    | Equity asset ratio with four decimals                                                                                                          |
| mostRecentFinancialSummary.km\_GrossMargin                   | Float    | Gross margin with four decimals                                                                                                                |
| mostRecentFinancialSummary.software                          | String   | Software used to generate the financial report (if known)                                                                                      |
| mostRecentSignatory.signatureDescription                     | String   | Description of the signature rights                                                                                                            |
| currentRepresentatives.personId                              | Int32    | An internal id representing the person which makes it simpler to query                                                                         |
| mostRecentDebtorSummary.debtBalance.totalAmountInSEK         | Float    | Holds the total amount, currency SEK, out outstanding debts of public- vs. private debt cases in Sweden                                        |
| mostRecentDebtorSummary.debtBalance.public.description       | String   | The public case debt type and creditor                                                                                                         |
| mostRecentDebtorSummary.debtBalance.public.numberOfCases     | Int32    | Number of public debt cases relating to public debt                                                                                            |
| mostRecentDebtorSummary.debtBalance.public.totalAmountInSEK  | Float    | Total amount outstanding debt for public debt cases                                                                                            |
| mostRecentDebtorSummary.debtBalance.private.numberOfCases    | Int32    | Number of private debt cases relating to public debt                                                                                           |
| mostRecentDebtorSummary.debtBalance.private.totalAmountInSEK | Float    | Total amount private debt for public debt cases                                                                                                |
| currentRepresentatives.personalIdentityNumber                | String   | The local market personal identity number                                                                                                      |
| currentRepresentatives.positionType                          | String   | The position of the representative                                                                                                             |
| currentRepresentatives.positionDescription                   | String   | Text description of the position                                                                                                               |
| currentRepresentatives.fullName                              | String   | Fullname of the person                                                                                                                         |
| currentRepresentatives.roleByCompanyName                     | String   | If the position is held by a company                                                                                                           |
| currentRepresentatives.roleByCompanyRegistrationNumber       | String   | If the position is held by a company                                                                                                           |
| currentRepresentatives.auditorType                           | String   | Auditor type                                                                                                                                   |
| currentRepresentatives.bornYearMonthDay                      | String   | For foreign persons                                                                                                                            |
| currentBeneficialOwners.personId                             | Int32    | An internal id representing the person which makes it simpler to query                                                                         |
| currentBeneficialOwners.personalIdentityNumber               | String   | The local market personal identity number                                                                                                      |
| currentBeneficialOwners.fullName                             | String   | Fullname of the person                                                                                                                         |
| currentBeneficialOwners.countryOfResidenceCode               | String   | ISO3166 Country code 2-char                                                                                                                    |
| currentBeneficialOwners.citizenshipCountryCode               | String   | ISO3166 Country code 2-char                                                                                                                    |
| currentBeneficialOwners.extentDescription                    | String   | Description of the extent                                                                                                                      |
| currentBeneficialOwners.governDescription                    | String   | Description of the govern                                                                                                                      |
| currentBeneficialOwners.throughName                          | String   | If managed through a name / company                                                                                                            |
| currentBeneficialOwners.throughRegistrationNumber            | String   | If managed through a name / company                                                                                                            |
| currentBeneficialOwners.bornYearMonthDay                     | String   | For foreign persons                                                                                                                            |
| mostRecentSignatory.signatureDescription                     | String   | The signature description                                                                                                                      |
| mostRecentShareCapital.shareCapitalAmount                    | Float    | The current share capital amount                                                                                                               |
| franchisesOrLicences.linkedToName                            | String   | From which company name is the franchise, licence or permit given                                                                              |
| franchisesOrLicences.actingUnderName                         | String   | Under which name is the business providing services or sales of goods                                                                          |
| franchisesOrLicences.linkedToCompanyId                       | Int32    | From which company id is the franchise, licence or permit given                                                                                |
| franchisesOrLicences.description                             | String   | Description of the franchise, licence or permit given                                                                                          |
| franchisesOrLicences.companyFranchiseOrLicenceType           | String   | Type of franchise, licence or permit (franchise, licence, membership, agent, other)                                                            |
| currentWorkplaces.companyWorkplaceId                         | Int32    | Our worldwide identifier for the workplace                                                                                                     |
| currentWorkplaces.workplaceCode                              | Int32    | A code for the workplace                                                                                                                       |
| currentWorkplaces.mostRecentName                             | Int32    | The name of workplace                                                                                                                          |
| currentWorkplaces.labelAddress                               | String   | A label containing the street address, postalcode and city                                                                                     |
| currentWorkplaces.location                                   | GeoPoint | Allows geosearch                                                                                                                               |
| trademarks.word                                              | String   | The word representing a word-trademark                                                                                                         |
| trademarks.expire                                            | Int64    | When the trademark expire in Unix time (epoch) seconds since 1st January 1970                                                                  |
| stock.isin                                                   | String   | ISIN                                                                                                                                           |
| stock.ticker                                                 | String   | Ticker symbol on market                                                                                                                        |
| stock.marketName                                             | String   | Market name                                                                                                                                    |
| stock.marketExchangeName                                     | String   | Market exchange name                                                                                                                           |
| stock.sectorName                                             | String   | Business sector as provided on market                                                                                                          |
| stock.branchName                                             | String   | Business branch as provided on market                                                                                                          |
| stock.enterpriseValue                                        | String   | Enterprise value last closing day                                                                                                              |
| stock.nextReportDate                                         | String   | Next report date for the listed company                                                                                                        |
| stock.dividendExDate                                         | String   | Next X-date to receive the dividend                                                                                                            |
| stock.yahooSymbol                                            | String   | The Yahoo finance symbol                                                                                                                       |
| lei.leiCode                                                  | String   | LEI Code                                                                                                                                       |
| lei.registrationStatus                                       | String   | RETIRED, DUPLICATE, LAPSED, ANNULLED, PENDING\_TRANSFER, ISSUED, PENDING\_ARCHIVAL                                                             |
| lei.initialRegistrationDate                                  | Int64    | Initial registration date in Unix time (epoch) seconds since 1st January 1970                                                                  |
| lei.nextRenewalDate                                          | Int64    | Initial registration date in Unix time (epoch) seconds since 1st January 1970                                                                  |
| lei.managingLOU                                              | String   | LEI of the managing LOU                                                                                                                        |
| lei.managingLOULegalName                                     | String   | Legal name of the LOU                                                                                                                          |
| ecParticipant.pic                                            | String   | Participant Identification Code (PIC) as registered with European Commission                                                                   |
| ecParticipant.validationStatus                               | String   | Declared, Validated, Sleeping, Suspended, Blocked, Deprecated (see further documentation)                                                      |
| ecParticipant.numberOfProjects                               | Int32    | Number of projects where the organization has been present with the PIC                                                                        |
| franchisesOrLicences.linkedToName                            | String   | The name of the licencee or company providing the franchise                                                                                    |
| franchisesOrLicences.actingUnderName                         | String   | The name/s under which the company is acting under                                                                                             |
| franchisesOrLicences.linkedToCompanyId                       | Int32    | The company id if exists for which the licence or franchise was given                                                                          |
| salesToPublicActors.actorName                                | String   | The name of the public actor                                                                                                                   |
| salesToPublicActors.actorType                                | String   | The name of the public actor                                                                                                                   |
| salesToPublicActors.actorCode                                | String   | The code of the actor, e.g municipality = municipality code                                                                                    |
| hasSalesToPublicActors                                       | Bool     | Helper flag for knowing if the company has sold to public actors                                                                               |
| hasPhoneNumbers                                              | Bool     | Helper flag for knowing if the company has phone numbers present                                                                               |
| hasEmailAddresses                                            | Bool     | Helper flag for knowing if the company has email addresses present                                                                             |
| hasHyperlinks                                                | Bool     | Helper flag for knowing if the company has hyperlinks present                                                                                  |
| hasIntelligence                                              | Bool     | Helper flag for knowing if the company has intelligence records present                                                                        |
| hasStatus                                                    | Bool     | Helper flag for knowing if the company has status records present                                                                              |
| hasBankAccounts                                              | Bool     | Helper flag for knowing if the company has bank accounts present                                                                               |
| hasAddresses                                                 | Bool     | Helper flag for knowing if the company has addresses present                                                                                   |
| hasDocuments                                                 | Bool     | Helper flag for knowing if the company has documents present                                                                                   |
| hasStock                                                     | Bool     | Helper flag for knowing if the company has stock data present                                                                                  |
| hasLEI                                                       | Bool     | Helper flag for knowing if the company has LEI information present                                                                             |
| hasECParticipant                                             | Bool     | Helper flag for knowing if the company has EU participant information present                                                                  |
| hasFranchisesOrLicences                                      | Bool     | Helper flag for knowing if the company has franchises or licences present                                                                      |
| hasTrademarks                                                | Bool     | Helper flag for knowing if the company has trademarks                                                                                          |
| hasMostRecentDebtorSummary                                   | Bool     | Helper flag for knowing if the company has summary of debts                                                                                    |
| cNbrEmployeesInterval.categoryCode                           | Int32    | The code for the employee interval                                                                                                             |
| cNbrEmployeesInterval.categoryCodeDescription                | String   | Description of the interval                                                                                                                    |
| cVATInterval.categoryCode                                    | Int32    | The code representing the VAT reporting                                                                                                        |
| cVATInterval.categoryCodeDescription                         | String   | Description of the interval                                                                                                                    |
| cTurnoverInterval.categoryCode                               | Int32    | The code for the turnover interval                                                                                                             |
| cTurnoverInterval.categoryCodeDescription                    | String   | Description of the interval                                                                                                                    |
| cPropertyTaxationInterval.categoryCode                       | Int32    | The code for the employee interval                                                                                                             |
| cPropertyTaxationInterval.categoryCodeDescription            | String   | Description of the interval                                                                                                                    |
| cSector.categoryCode                                         | Int32    | The code for the sector                                                                                                                        |
| cSector.categoryCodeDescription                              | String   | Description of the sector                                                                                                                      |
| cTradeAfrica.categoryCode                                    | Int32    | A code (0 or 1) representing if the company is exporting/importing from the continent.                                                         |
| cTradeAfrica.categoryCodeDescription                         | String   | Description of the interval                                                                                                                    |
| cTradeAsia.categoryCode                                      | Int32    | A code (0 or 1) representing if the company is exporting/importing from the continent.                                                         |
| cTradeAsia.categoryCodeDescription                           | String   | Description of the interval                                                                                                                    |
| cTradeEU.categoryCode                                        | Int32    | A code (0 or 1) representing if the company is exporting/importing from the continent.                                                         |
| cTradeEU.categoryCodeDescription                             | String   | Description of the interval                                                                                                                    |
| cTradeFarEast.categoryCode                                   | Int32    | A code (0 or 1) representing if the company is exporting/importing from the continent.                                                         |
| cTradeFarEast.categoryCodeDescription                        | String   | Description of the interval                                                                                                                    |
| cTradeNorthCentralAmerica.categoryCode                       | Int32    | A code (0 or 1) representing if the company is exporting/importing from the continent.                                                         |
| cTradeNorthCentralAmerica.categoryCodeDescription            | String   | Description of the interval                                                                                                                    |
| cTradeNordics.categoryCode                                   | Int32    | A code (0 or 1) representing if the company is exporting/importing from the continent.                                                         |
| cTradeNordics.categoryCodeDescription                        | String   | Description of the interval                                                                                                                    |
| cTradeSouthAmerica.categoryCode                              | Int32    | A code (0 or 1) representing if the company is exporting/importing from the continent.                                                         |
| cTradeSouthAmerica.categoryCodeDescription                   | String   | Description of the interval                                                                                                                    |
| cTradeOtherEurope.categoryCode                               | Int32    | A code (0 or 1) representing if the company is exporting/importing from the continent.                                                         |
| cTradeOtherEurope.categoryCodeDescription                    | String   | Description of the interval                                                                                                                    |
| cTradeExportInterval.categoryCode                            | Int32    | A code representing the export interval                                                                                                        |
| cTradeExportInterval.categoryCodeDescription                 | String   | Description of the interval                                                                                                                    |
| cTradeImportInterval.categoryCode                            | Int32    | A code representing the import interval                                                                                                        |
| cTradeImportInterval.categoryCodeDescription                 | String   | Description of the interval                                                                                                                    |
| cGenderRatioFemale.categoryCode                              | Int32    | Gender ratio females in percentage (no fraction)                                                                                               |
| cGenderRatioFemale.categoryCodeDescription                   | String   | Gender ratio females with percentage sign                                                                                                      |
| cPrivPubl.categoryCode                                       | Int32    | Code representing if the company is private/public/listed etc                                                                                  |
| cPrivPubl.categoryCodeDescription                            | String   | Description of the type of company                                                                                                             |
| cOwnership.categoryCode                                      | Int32    | Code representing the kind of ownership                                                                                                        |
| cOwnership.categoryCodeDescription                           | String   | Description of ownership type                                                                                                                  |

## Category fields

Fields starting with the letter c are category fields. They contain typical intervals across all company types.
Category fields are objects with the same type containing categoryCode, categoryCodeDescription and categoryCode2.

categoryCode is the actual code used to describe the category and categoryCodeDescription contains a formatted string
describing the categoryCode. categoryCode2 typically contains for example the year and month (formatted YYYYMM) or year (YYYY)
for the various categories.

Example:
cTurnoverInterval contains is an object containing the turnover interval.
cTradeImportInterval contains is an object containing the import interval (e.g how much the company is importing per year).

Category fields are efficient when you query across multiple company types since only limited companies (Aktiebolag) typically
submit annual reports (some exceptions other legal types may be required to submit an annual report). Therefore the goverment
agency, Statistics Sweden, weekly compiles data across all legal entities types that we acquire and makes it easier to search
within.

## Unix time only

Typesense only allows unix timestamps to be indexed so search will only present time by the number of non-leap seconds that have elapsed
since 00:00:00 UTC on 1st January 1970, the Unix epoch. Since we may have timestamps earlier than 1st January 1970 negative number of seconds
may appear.

## European Commission and participant status

ecParticipant.validationStatus can contain the following statuses:

**Declared**
Organisation registered by self-registrant. Will remain in this status if the validation is done decentrally by the National Agency.

**Validated**
Organisation validated centrally by REA (Research Executive Agency).

**Suspended**
The legal entity is "frozen" because of an external reason (Bankruptcy, etc.) as a result of central validation by REA (Research Executive Agency).

**Sleeping**
Some data was passed, but the contact person does not react on any demands from the REA (Research Executive Agency) validation team.

**Deprecated**
When duplication is identified by REA (Research Executive Agency), the validity will be Deprecated and the master PIC will be associated. Will not be published in the search.

**Blocked**
Blocked during the validation process by REA (Research Executive Agency).

## Enums

Enums have been stored as plain text in search making it easier to service and not having to remember their numeric values.

## Intelligence types

Intelligence records contains information about various discrepancies that we find in data. A record contains a score between 0 and 255
representing the significance of the discrepancy. If the score equals 0 is means it's just for information while 255 means the discrepancy
is very significant. Each intelligence record also comes with a human English text describing the discrepancy called intelligence.notes.

List of intelligence.companyIntelligenceType below in the table. Please note that while searching you need to enter the value (Int32) and not the name itself. Value
2,4 and 6 are unused currently. They may appear in search result currently just for testing.

| Enum                         | Value | Description                                                                                       |
| ---------------------------- | ----- | ------------------------------------------------------------------------------------------------- |
| CreatedAsShelfCompany        | 0     | The company was created as shelf company                                                          |
| SuspectedForQuickLiquidation | 1     | The company was seems to be going into "quick liquidation"                                        |
| AffliatedWithArticle         | 3     | The company is affiliated with one or multiple articles                                           |
| SuspectedAddress             | 5     | The address has earlier been known                                                                |
| PresentOnWarningList         | 7     | The company is present on certain warning lists                                                   |
| AnnualReportDiscrepancies    | 8     | One or multiple annual reports contains discrepancies                                             |
| AuditorResignation           | 9     | Auditor has resigned from their duties                                                            |
| Registration                 | 10    | One or more issues about registration                                                             |
| RegisterChanges              | 11    | A change in a registry triggered an intelligence policy                                           |
| PenaltyFees                  | 12    | The company has been penalized by a fee                                                           |
| BeneficialOwner              | 13    | The registration office have indicated issues relating to registration of beneficial owners       |
| Claims                       | 14    | Claims from various goverment agencies e.g company is required to repay for example contributions |

The intelligence.externalId is used to reference an id containing the orgin of the intelligence record. If for example the
intelligence record is of type: AnnualReportDiscrepancies (8) it means the external id represents the id of the annual report.

## Intelligence subtypes

Certain intelligence types have subtypes to further describe what has been found. The intelligence.companyIntelligenceSubType is
an enum text to make it easier to filter based on search.

List of subtypes. Please note you need to filter by string when using intelligence.companyIntelligenceSubType.

| Enum                            | Description                                                                                           |
| ------------------------------- | ----------------------------------------------------------------------------------------------------- |
| BS\_MISMATCH                    | The balance sheet doesn't balance                                                                     |
| AGM\_TO\_LATE                   | The annual general meeting was held to late                                                           |
| AR\_TO\_LATE                    | The annual report was submitted to late                                                               |
| AGM\_WRONG\_DATE                | Suspected wrong date of annual general meeting date                                                   |
| MISSING\_MULTIYEAR              | The multi-year overview is missing                                                                    |
| MISSING\_CHANGEEQUITY           | The table showing change of equity is missing                                                         |
| WRONG\_SIGNATUREDATE            | Signature date (last signature) seems to be wrong                                                     |
| WRONG\_EQUITYASSETSRATIO        | The given equity asset ratio doesn't match the calculation                                            |
| MISSING\_AUDITOR                | The company is passing the thresholds requiring an auditor (check response for mandatory requirement) |
| DUPLICATE                       | The annual report is a duplicate for another company                                                  |
| NO\_SHARECAPITAL                | The balance sheet is missing share capital                                                            |
| POSSIBLE\_MISSINGASSETS         |                                                                                                       |
| NEGATIVE\_SHARECAPITAL          | The balance sheet contains negative share capital                                                     |
| NEGATIVE\_ASSETS                | The balance sheet total assets are negative                                                           |
| MISSING\_BS\_ASSETS             | Missing part of the balance sheet (assets)                                                            |
| MISSING\_BS\_EQUITY             | Missing part of the balance sheet (equity)                                                            |
| MISSING\_RS                     | Missing result sheet                                                                                  |
| LIQUIDATION\_REQUIRED           | The company is subject to liquidation requirements                                                    |
| WRONG\_SHARECAPITAL             | The share capital is wrong in the balance sheet                                                       |
| MISSING\_NUMBEREMPLOYEES        | Missing number of employees but required                                                              |
| MISMATCH\_PL\_RS\_BS            | Mismatch of profit/loss in result sheet and balance sheet                                             |
| MISMATCH\_PL\_CE                | Mismatch of profit/loss in change of equity                                                           |
| SUSPECT\_YEAR\_DUPLICATE        | Suspected annual report for duplicated data from last year                                            |
| PROPOSED\_DIVIDEND\_ERR         | Proposed dividend contains a too high number                                                          |
| MANAGEMENT\_REPORT\_ERR         | The management report contains errors                                                                 |
| MANAGEMENT\_REPORT\_UNCERTAINTY | The management report mention uncertainty in the business                                             |
| FORBIDDEN\_LOAN                 | The management report mention a forbidden loan                                                        |
| CONTROL\_BS                     | The management report mention a control balance sheet                                                 |
| AUDITOR\_CONTROL\_BS            | Auditor mentions a control balance sheet                                                              |
| AUDITOR\_LIQUIDATION\_REQUIRED  | Auditor mentions liquidation requirements                                                             |
| AUDITOR\_FORBIDDEN\_LOAN        | Auditor mentions forbidden loan                                                                       |
| AUDITOR\_DISCOURGES             | Auditor discourges the balance/or/and result sheet                                                    |
| AUDITOR\_ACCOUNTING\_LAG        | Auditor mentions lag in the accounting of the company                                                 |
| AUDITOR\_MISSING\_EVIDENCE      | Auditor is missing documentation / evidence for transactions                                          |
| AUDITOR\_TAXES\_LATE            | Auditor mentions taxes have been paid late                                                            |
| AUDITOR\_UNAUTH\_VALUETRANSFER  | Auditor mentions unauthorized value transfers                                                         |
| AUDITOR\_ACCOUNTING\_ISSUES     | Auditor mentions accounting issues                                                                    |
| AUDITOR\_UNCERTAINTY            | Auditor mentions uncertainty in the business                                                          |
| AUDITOR\_ACCOUNTING\_ERR        | Auditor mentions errors in accounting                                                                 |
| AUDITOR\_REMARK                 | Auditor report contains a remark                                                                      |
| COMPARATIVE\_FIGURES\_ERR       | There is an error in compartative figures for the year                                                |
| AUDITOR\_EARLY\_RESIGNATION     | An auditor has made an early resignation leaving certain remarks                                      |
| SUSPECTED\_AR                   | One or multiple discrepancies have been found in the annual report                                    |
| K3\_REQUIRED                    | Company is using K2 ruleset but is required to use K3 ruleset                                         |
| ISSUE\_WITH\_REGISTRATION       | The annual report was registered with a discrepancy indicating one or multiple issues                 |
| F\_TAX\_REVOKED                 | The F-tax registration of the company have been revoked                                               |
| AFFILIATION                     | The business is affiliated with external data                                                         |
| CEO\_MISSING                    | Company is missing a CEO registered but required to have one registered                               |
| AR\_MISSING                     | Annual report is missing for a period                                                                 |
| UNAUTH\_BOARD                   | Board is unauthorized and doesn't meet the terms                                                      |
| AUDITOR\_MISSING                | Company is missing an auditor                                                                         |
| REPR\_MISSING                   | Company is missing a special recipient of service                                                     |
| BR\_SURPLUS                     | Bankruptcy terminated with surplus and is subject to liquidation                                      |
| AR\_SHORTAGE                    | Shortage listed by Bolagsverket to the company                                                        |
| PENALTY\_FEE                    | The company has been penalized with a fee, see more in the description data                           |

Check back continuously since we are adding more subtypes.

## Examples

We have put together a few example of how you can use search to efficiently query the millions of companies we track.

### Search for companies at at specific street

```bash cURL theme={null}
curl https://api.tic.io/search/companies?q=Fabriksgatan&query_by=addresses.street&key=your_api_key
{
    {
    "facet_counts": [],
    "found": 1563,
    "hits": [
        {
            "document": {
                "id": "3427183",
                "companyId": 3427183,
                "iso3166CountryCode": "SE",
                "registrationNumber": "5564228509",
                "registrationDate": 669510000....
}
```

### Search for a specific phone number in E164 format

<Note>
  What is E.164? E164 format is an international format for phone numbers. E.164
  numbers are formatted \[+] \[country code] \[subscriber number including area
  code] and can have a maximum of fifteen digits.
</Note>

```bash cURL theme={null}
curl https://api.tic.io/search/companies?q=+46850565800&query_by=phoneNumbers.e164PhoneNumber&key=your_api_key
```

### Search for companies within a certain geographic area

Search for companies covering a 300 meters radius around the provided location by latitude and longitude in WGS84 format.
Read more about geosearch [here](https://typesense.org/docs/26.0/api/geosearch.html).

```bash cURL theme={null}
curl https://api.tic.io/search/companies?q=*&query_by=addresses.street&filter_by=addresses.location:(57.6799,12.09162, 0.300 km)&sort_by=addresses.location(57.6799,12.09162):asc&key=your_api_key
```

### Filter for a specific companyId

Filters allows you to narrow down your search. This example shows how to specifically match only the company with id 3508351.
Read more about filters [here](https://typesense.org/docs/26.0/api/search.html#filter-parameters).

```bash cURL theme={null}
curl https://api.tic.io/search/companies?q=*&query_by=registrationNumber&filter_by=companyId:[3508351]&key=your_api_key
```

### Search for companies with specific industry names or codes

Searches for companies that have a number of specific industry codes as defined in [SNI 2007 standard](https://www.scb.se/en/documentation/classifications-and-standards/swedish-standard-industrial-classification-sni). You
can search either for the name as described in the standard or the code itself.

```bash cURL theme={null}
curl https://api.tic.io/search/companies?q=Handel%20med%20personbilar%20och%20l%C3%A4tta%20motorfordon&query_by=sniCodes.sni_2007Name&key=your_api_key"
```

### Search for stock listed companies

Searches for companies listed on market exchange name, OMX Stockholm,

```bash cURL theme={null}
curl https://api.tic.io/search/companies?q=OMX+Stockholm&query_by=stock.marketExchangeName&key=your_api_key
```

### Search for companies that have sold to public actors

Searches for companies that have sold to Gävle municipality.

```bash cURL theme={null}
curl https://api.tic.io/search/companies?q=gävle&query_by=salesToPublicActors.actorName&key=your_api_key
{
    {
    "facet_counts": [],
    "found": 1563,
    "hits": [
        {
            "document": {
                "id": "3427183",
                "companyId": 3427183,
                "iso3166CountryCode": "SE",
                "registrationNumber": "5564228509",
                "registrationDate": 669510000....
}
```

### Search for intelligence records

Searches for companies that have passed auditor requirements by third consecutive year. Note that the score should exceed 254.

```bash cURL theme={null}
curl https://api.tic.io/search/companies?q=*&query_by=registrationNumber&filter_by=intelligence.companyIntelligenceSubType:['MISSING_AUDITOR']&&intelligence.score:>254&key=your_api_key
```

### Multi search

Multi search enables you to carry out multi searches in one request by posting a json model to the search endpoint. Typesense have a description of the feature in their [documentation](https://typesense.org/docs/26.0/api/federated-multi-search.html).

Here is an example of how to use multisearch while searching for a company registration number, e-mail, stock ticker and LEI code.

```bash cURL theme={null}
curl  \
--request POST
--header "Content-Type: application/json"
--header "x-api-key:your_api_key"
--data '{
  "searches": [
    {
      "collection": "companies",
      "query_by": "registrationNumber",
      "q": "5565199493"
    },
    {
      "collection": "companies",
      "query_by": "emailAddresses.emailAddress",
      "q": "kundtjanst@tibroenergi.se"
    },
    {
      "collection": "companies",
      "query_by": "stock.ticker",
      "q": "SBB"
    },
     {
      "collection": "companies",
      "query_by": "lei.leiCode",
      "q": "549300YECS8HKCIMMB67"
    }
  ]
}'
https://api.tic.io/search/companies
```

### Response model

The search response for example when you search for our company would look like the example below for our company.

<Note>
  The registrationDate is in Unix epoch seconds e.g the number of seconds that
  have elapsed since January 1, 1970 (midnight UTC/GMT). Same applies for
  various dates since Typesense requires dates to be serialized to epoch. For
  example listingDate (stock) and nextRenewalDate (lei) are both epoch.
</Note>

```json Search response for companies theme={null}
{
  "results": [
    {
      "facet_counts": [],
      "found": 1,
      "hits": [
        {
          "document": {
            "addresses": [
              {
                "addressType": "mailAddress",
                "city": "BORLÄNGE",
                "postalCode": "78129",
                "street": "Box 930"
              },
              {
                "addressType": "mailAddress",
                "city": "Stockholm",
                "countryCodeAlpha3": "SWE",
                "houseNumber": "41",
                "location": [59.33876, 18.06013],
                "postalCode": "11134",
                "street": "Sveavägen"
              },
              {
                "addressType": "registeredAddress",
                "city": "STOCKHOLM",
                "co": "Bahnhof AB",
                "countryCodeAlpha3": "SE ",
                "postalCode": "10395",
                "street": "Box 7702"
              }
            ],
            "bankAccounts": [
              {
                "accountNumber": "1746635",
                "bankAccountType": "bankgiro"
              },
              {
                "accountNumber": "51365088",
                "bankAccountType": "bankgiro"
              },
              {
                "accountNumber": "56117526",
                "bankAccountType": "bankgiro"
              },
              {
                "accountNumber": "59219212",
                "bankAccountType": "bankgiro"
              },
              {
                "accountNumber": "7859291",
                "bankAccountType": "bankgiro"
              }
            ],
            "companyId": 1893055,
            "currentBeneficialOwners": [
              {
                "beneficialOwnerId": 1651253,
                "personalIdentityNumber": "redacted for privacy reasons",
                "personId": 2954253,
                "citizenshipCountryCode": "SE",
                "countryOfResidenceCode": "SE",
                "extentCode": "INTERVALL2",
                "extentDescription": "Mer än 25 % men inte mer än 50 %",
                "fromDate": 1506866424,
                "fullName": "redacted for privacy reasons",
                "governDescription": "Personen har kontroll genom aktier, andelar, medlemskap, avtal eller bestämmelse i exempelvis bolagsordning eller stadgar."
              }
            ],
            "currentRepresentatives": [
              {
                "fullName": "redacted for privacy reasons",
                "personalIdentityNumber": "redacted for privacy reasons",
                "personId": 2954253,
                "positionDescription": "STYRELSELEDAMOT",
                "positionStart": 1723161600,
                "positionType": "LE"
              },
              {
                "fullName": "redacted for privacy reasons",
                "personalIdentityNumber": "redacted for privacy reasons",
                "personId": 2954253,
                "positionDescription": "VERKSTÄLLANDE DIREKTÖR",
                "positionStart": 1723161600,
                "positionType": "VD"
              }
            ],
            "documents": [
              {
                "companyDocumentId": 13036521,
                "companyDocumentType": "minutes",
                "documentDate": 1723161600,
                "documentTitle": "Minutes registered on 2024-08-09",
                "documentUrl": "https://api.tic.io/company-documents/13036521/order",
                "documentVersion": "219870278",
                "grossPriceIfAny": 2.0
              },
              {
                "companyDocumentId": 10801798,
                "companyDocumentType": "annualReport",
                "documentDate": 1719360000,
                "documentTitle": "Annual report submitted by mail on 2024-06-26 for 2023-01-01 to 2023-12-31 and registered on 2024-08-08",
                "documentUrl": "https://api.tic.io/financial-documents/se/520470",
                "documentValue1": "2023-01-01",
                "documentValue2": "2023-12-31",
                "documentVersion": "9392305/2024"
              },
              {
                "companyDocumentId": 13036522,
                "companyDocumentType": "minutes",
                "documentDate": 1715731200,
                "documentTitle": "Minutes registered on 2024-05-15",
                "documentUrl": "https://api.tic.io/company-documents/13036522/order",
                "documentVersion": "214580527",
                "grossPriceIfAny": 2.0
              },
              {
                "companyDocumentId": 8894711,
                "companyDocumentType": "case",
                "documentDate": 1715644800,
                "documentTitle": "Change of representative/company signature",
                "documentValue1": "FÖR",
                "documentValue2": "2024-05-15",
                "documentVersion": "263117/2024"
              },
              {
                "companyDocumentId": 16922683,
                "companyDocumentType": "case",
                "documentDate": 1694476800,
                "documentTitle": "Change of the company's representative address",
                "documentValue1": "FÖRP",
                "documentValue2": "2023-09-12",
                "documentVersion": "476753/2023"
              },
              {
                "companyDocumentId": 16922684,
                "companyDocumentType": "case",
                "documentDate": 1694476800,
                "documentTitle": "Change of the company's representative address",
                "documentValue1": "FÖRP",
                "documentValue2": "2023-09-12",
                "documentVersion": "476744/2023"
              },
              {
                "companyDocumentId": 13036523,
                "companyDocumentType": "minutes",
                "documentDate": 1684108800,
                "documentTitle": "Minutes registered on 2023-05-15",
                "documentUrl": "https://api.tic.io/company-documents/13036523/order",
                "documentVersion": "197346117",
                "grossPriceIfAny": 2.0
              },
              {
                "companyDocumentId": 23646449,
                "companyDocumentType": "annualReport",
                "documentDate": 1672444800,
                "documentTitle": "Annual report for period ending 2022-12-31 registered",
                "documentUrl": "https://api.tic.io/company-documents/23646449/order",
                "documentValue2": "2022-12-31",
                "documentVersion": "202977827",
                "grossPriceIfAny": 40.0
              },
              {
                "companyDocumentId": 16922685,
                "companyDocumentType": "case",
                "documentDate": 1661731200,
                "documentTitle": "Change relating to auditors",
                "documentValue1": "REV",
                "documentValue2": "2022-08-29",
                "documentVersion": "432632/2022"
              },
              {
                "companyDocumentId": 13036524,
                "companyDocumentType": "minutes",
                "documentDate": 1653350400,
                "documentTitle": "Minutes registered on 2022-05-24",
                "documentUrl": "https://api.tic.io/company-documents/13036524/order",
                "documentVersion": "182079292",
                "grossPriceIfAny": 2.0
              },
              {
                "companyDocumentId": 23646450,
                "companyDocumentType": "annualReport",
                "documentDate": 1640908800,
                "documentTitle": "Annual report for period ending 2021-12-31 registered",
                "documentUrl": "https://api.tic.io/company-documents/23646450/order",
                "documentValue2": "2021-12-31",
                "documentVersion": "185126852",
                "grossPriceIfAny": 40.0
              },
              {
                "companyDocumentId": 13036525,
                "companyDocumentType": "minutes",
                "documentDate": 1636588800,
                "documentTitle": "Minutes registered on 2021-11-11",
                "documentUrl": "https://api.tic.io/company-documents/13036525/order",
                "documentVersion": "173834528",
                "grossPriceIfAny": 2.0
              },
              {
                "companyDocumentId": 16922686,
                "companyDocumentType": "case",
                "documentDate": 1635897600,
                "documentTitle": "Change of representative/company signature,Change of subject's mailing address",
                "documentValue1": "FÖR,PA",
                "documentValue2": "2021-11-11",
                "documentVersion": "624165/2021"
              },
              {
                "companyDocumentId": 23646451,
                "companyDocumentType": "annualReport",
                "documentDate": 1609372800,
                "documentTitle": "Annual report for period ending 2020-12-31 registered",
                "documentUrl": "https://api.tic.io/company-documents/23646451/order",
                "documentValue2": "2020-12-31",
                "documentVersion": "164060402",
                "grossPriceIfAny": 40.0
              },
              {
                "companyDocumentId": 13036526,
                "companyDocumentType": "minutes",
                "documentDate": 1590624000,
                "documentTitle": "Minutes registered on 2020-05-28",
                "documentUrl": "https://api.tic.io/company-documents/13036526/order",
                "documentVersion": "144379934",
                "grossPriceIfAny": 2.0
              },
              {
                "companyDocumentId": 16922687,
                "companyDocumentType": "case",
                "documentDate": 1589414400,
                "documentTitle": "Change of representative/company signature",
                "documentValue1": "FÖR",
                "documentValue2": "2020-05-28",
                "documentVersion": "272195/2020"
              },
              {
                "companyDocumentId": 23646452,
                "companyDocumentType": "annualReport",
                "documentDate": 1577750400,
                "documentTitle": "Annual report for period ending 2019-12-31 registered",
                "documentUrl": "https://api.tic.io/company-documents/23646452/order",
                "documentValue2": "2019-12-31",
                "documentVersion": "148605084",
                "grossPriceIfAny": 40.0
              },
              {
                "companyDocumentId": 13036527,
                "companyDocumentType": "minutes",
                "documentDate": 1564358400,
                "documentTitle": "Minutes registered on 2019-07-29",
                "documentUrl": "https://api.tic.io/company-documents/13036527/order",
                "documentVersion": "140284912",
                "grossPriceIfAny": 2.0
              },
              {
                "companyDocumentId": 13036528,
                "companyDocumentType": "minutes",
                "documentDate": 1564358400,
                "documentTitle": "Minutes registered on 2019-07-29",
                "documentUrl": "https://api.tic.io/company-documents/13036528/order",
                "documentVersion": "140284911",
                "grossPriceIfAny": 2.0
              },
              {
                "companyDocumentId": 16922688,
                "companyDocumentType": "case",
                "documentDate": 1561593600,
                "documentTitle": "Change of representative/company signature",
                "documentValue1": "FÖR",
                "documentValue2": "2019-07-29",
                "documentVersion": "344374/2019"
              },
              {
                "companyDocumentId": 23646570,
                "companyDocumentType": "annualReport",
                "documentDate": 1546214400,
                "documentTitle": "Annual report for period ending 2018-12-31 registered",
                "documentUrl": "https://api.tic.io/company-documents/23646570/order",
                "documentValue2": "2018-12-31",
                "documentVersion": "134135352",
                "grossPriceIfAny": 40.0
              },
              {
                "companyDocumentId": 16922689,
                "companyDocumentType": "case",
                "documentDate": 1527120000,
                "documentTitle": "Change of representative/company signature",
                "documentValue1": "FÖR",
                "documentValue2": "2018-06-13",
                "documentVersion": "273061/2018"
              },
              {
                "companyDocumentId": 23646571,
                "companyDocumentType": "annualReport",
                "documentDate": 1514678400,
                "documentTitle": "Annual report for period ending 2017-12-31 registered",
                "documentUrl": "https://api.tic.io/company-documents/23646571/order",
                "documentValue2": "2017-12-31",
                "documentVersion": "106264065",
                "grossPriceIfAny": 40.0
              },
              {
                "companyDocumentId": 13036520,
                "companyDocumentType": "articlesOfAssociation",
                "documentDate": 1507680000,
                "documentTitle": "Articles of association stated on 2017-10-11",
                "documentUrl": "https://api.tic.io/company-documents/13036520/order",
                "documentVersion": "116345562",
                "grossPriceIfAny": 40.0
              },
              {
                "companyDocumentId": 23646572,
                "companyDocumentType": "annualReport",
                "documentDate": 1483142400,
                "documentTitle": "Annual report for period ending 2016-12-31 registered",
                "documentUrl": "https://api.tic.io/company-documents/23646572/order",
                "documentValue2": "2016-12-31",
                "documentVersion": "36159320",
                "grossPriceIfAny": 40.0
              },
              {
                "companyDocumentId": 23646573,
                "companyDocumentType": "annualReport",
                "documentDate": 1451520000,
                "documentTitle": "Annual report for period ending 2015-12-31 registered",
                "documentUrl": "https://api.tic.io/company-documents/23646573/order",
                "documentValue2": "2015-12-31",
                "documentVersion": "30454182",
                "grossPriceIfAny": 40.0
              },
              {
                "companyDocumentId": 23646574,
                "companyDocumentType": "annualReport",
                "documentDate": 1419984000,
                "documentTitle": "Annual report for period ending 2014-12-31 registered",
                "documentUrl": "https://api.tic.io/company-documents/23646574/order",
                "documentValue2": "2014-12-31",
                "documentVersion": "26697277",
                "grossPriceIfAny": 40.0
              },
              {
                "companyDocumentId": 23646575,
                "companyDocumentType": "annualReport",
                "documentDate": 1388448000,
                "documentTitle": "Annual report for period ending 2013-12-31 registered",
                "documentUrl": "https://api.tic.io/company-documents/23646575/order",
                "documentValue2": "2013-12-31",
                "documentVersion": "22762254",
                "grossPriceIfAny": 40.0
              },
              {
                "companyDocumentId": 16922690,
                "companyDocumentType": "case",
                "documentDate": 1369785600,
                "documentTitle": "Change of representative/company signature",
                "documentValue1": "FÖR",
                "documentValue2": "2013-06-17",
                "documentVersion": "193232/2013"
              },
              {
                "companyDocumentId": 23646576,
                "companyDocumentType": "annualReport",
                "documentDate": 1356912000,
                "documentTitle": "Annual report for period ending 2012-12-31 registered",
                "documentUrl": "https://api.tic.io/company-documents/23646576/order",
                "documentValue2": "2012-12-31",
                "documentVersion": "20035600",
                "grossPriceIfAny": 40.0
              },
              {
                "companyDocumentId": 16922691,
                "companyDocumentType": "case",
                "documentDate": 1349913600,
                "documentTitle": "Change of representative/company signature",
                "documentValue1": "FÖR",
                "documentValue2": "2012-10-16",
                "documentVersion": "390371/2012"
              },
              {
                "companyDocumentId": 16922692,
                "companyDocumentType": "case",
                "documentDate": 1338163200,
                "documentTitle": "Change of representative/company signature",
                "documentValue1": "FÖR",
                "documentValue2": "2012-05-30",
                "documentVersion": "208178/2012"
              },
              {
                "companyDocumentId": 23646577,
                "companyDocumentType": "annualReport",
                "documentDate": 1325289600,
                "documentTitle": "Annual report for period ending 2011-12-31 registered",
                "documentUrl": "https://api.tic.io/company-documents/23646577/order",
                "documentValue2": "2011-12-31",
                "documentVersion": "18120881",
                "grossPriceIfAny": 40.0
              },
              {
                "companyDocumentId": 16922693,
                "companyDocumentType": "case",
                "documentDate": 1304553600,
                "documentTitle": "Change of mailing address of representative and/or auditor in several companies",
                "documentValue1": "MPA",
                "documentValue2": "2011-05-09",
                "documentVersion": "171354/2011"
              },
              {
                "companyDocumentId": 16922694,
                "companyDocumentType": "case",
                "documentDate": 1294790400,
                "documentTitle": "Change of representative/company signature",
                "documentValue1": "FÖR",
                "documentValue2": "2011-01-27",
                "documentVersion": "12506/2011"
              },
              {
                "companyDocumentId": 23646578,
                "companyDocumentType": "annualReport",
                "documentDate": 1293753600,
                "documentTitle": "Annual report for period ending 2010-12-31 registered",
                "documentUrl": "https://api.tic.io/company-documents/23646578/order",
                "documentValue2": "2010-12-31",
                "documentVersion": "15944944",
                "grossPriceIfAny": 40.0
              },
              {
                "companyDocumentId": 16922695,
                "companyDocumentType": "case",
                "documentDate": 1288656000,
                "documentTitle": "Resignation from the board of directors",
                "documentValue1": "FÖRU",
                "documentValue2": "2010-11-03",
                "documentVersion": "560174/2010"
              },
              {
                "companyDocumentId": 16922696,
                "companyDocumentType": "case",
                "documentDate": 1282608000,
                "documentTitle": "Change of representative/company signature",
                "documentValue1": "FÖR",
                "documentValue2": "2010-09-06",
                "documentVersion": "399206/2010"
              },
              {
                "companyDocumentId": 23646579,
                "companyDocumentType": "annualReport",
                "documentDate": 1262217600,
                "documentTitle": "Annual report for period ending 2009-12-31 registered",
                "documentUrl": "https://api.tic.io/company-documents/23646579/order",
                "documentValue2": "2009-12-31",
                "documentVersion": "13522725",
                "grossPriceIfAny": 40.0
              },
              {
                "companyDocumentId": 16922697,
                "companyDocumentType": "case",
                "documentDate": 1243209600,
                "documentTitle": "Authorisation to increase share capital through the issue of new shares,Change of representative/company signature,Change of subject's mailing address",
                "documentValue1": "BENY,FÖR,PA",
                "documentValue2": "2009-06-01",
                "documentVersion": "225051/2009"
              },
              {
                "companyDocumentId": 23646580,
                "companyDocumentType": "annualReport",
                "documentDate": 1230681600,
                "documentTitle": "Annual report for period ending 2008-12-31 registered",
                "documentUrl": "https://api.tic.io/company-documents/23646580/order",
                "documentValue2": "2008-12-31",
                "documentVersion": "11901777",
                "grossPriceIfAny": 40.0
              },
              {
                "companyDocumentId": 16922698,
                "companyDocumentType": "case",
                "documentDate": 1222300800,
                "documentTitle": "Change of information for legal person registered as representative/auditor",
                "documentValue1": "BVEJUR",
                "documentValue2": "2008-09-25",
                "documentVersion": "414260/2008"
              },
              {
                "companyDocumentId": 16922699,
                "companyDocumentType": "case",
                "documentDate": 1213574400,
                "documentTitle": "Change of representative/company signature",
                "documentValue1": "FÖR",
                "documentValue2": "2008-06-17",
                "documentVersion": "275101/2008"
              },
              {
                "companyDocumentId": 23646581,
                "companyDocumentType": "annualReport",
                "documentDate": 1199059200,
                "documentTitle": "Annual report for period ending 2007-12-31 registered",
                "documentUrl": "https://api.tic.io/company-documents/23646581/order",
                "documentValue2": "2007-12-31",
                "documentVersion": "10193935",
                "grossPriceIfAny": 40.0
              },
              {
                "companyDocumentId": 16922700,
                "companyDocumentType": "case",
                "documentDate": 1191542400,
                "documentTitle": "Change of business name,Change of representative/company signature,Change of limits for the number of board members,Amendment of Articles of Association,Change of category from private to public company,Change relating to auditors,Issue or change of warrants,Ökning av aktiekapitalet genom nyemission",
                "documentValue1": "FIRM,FÖR,FÖRGR,ORDN,PUBL,REV,TOPT,ÖKNY",
                "documentValue2": "2007-11-16",
                "documentVersion": "308663/2007"
              },
              {
                "companyDocumentId": 23646582,
                "companyDocumentType": "annualReport",
                "documentDate": 1167523200,
                "documentTitle": "Annual report for period ending 2006-12-31 registered",
                "documentUrl": "https://api.tic.io/company-documents/23646582/order",
                "documentValue2": "2006-12-31",
                "documentVersion": "8619003",
                "grossPriceIfAny": 40.0
              },
              {
                "companyDocumentId": 23646765,
                "companyDocumentType": "annualReport",
                "documentDate": 1135987200,
                "documentTitle": "Annual report for period ending 2005-12-31 registered",
                "documentUrl": "https://api.tic.io/company-documents/23646765/order",
                "documentValue2": "2005-12-31",
                "documentVersion": "6930943",
                "grossPriceIfAny": 40.0
              },
              {
                "companyDocumentId": 16922701,
                "companyDocumentType": "case",
                "documentDate": 1117065600,
                "documentTitle": "Registration of secondary name or change in the business conducted under the secondary name.,Change of business name,Change of representative/company signature,Amendment of Articles of Association,Change of subject's mailing address",
                "documentValue1": "BIF,FIRM,FÖR,ORDN,PA",
                "documentValue2": "2005-06-01",
                "documentVersion": "142782/2005"
              },
              {
                "companyDocumentId": 16922702,
                "companyDocumentType": "case",
                "documentDate": 1105488000,
                "documentTitle": "Change relating to auditors",
                "documentValue1": "REV",
                "documentValue2": "2005-01-15",
                "documentVersion": "8175/2005"
              },
              {
                "companyDocumentId": 23646766,
                "companyDocumentType": "annualReport",
                "documentDate": 1104451200,
                "documentTitle": "Annual report for period ending 2004-12-31 registered",
                "documentUrl": "https://api.tic.io/company-documents/23646766/order",
                "documentValue2": "2004-12-31",
                "documentVersion": "5584259",
                "grossPriceIfAny": 40.0
              },
              {
                "companyDocumentId": 16922703,
                "companyDocumentType": "case",
                "documentDate": 1095724800,
                "documentTitle": "Change of representative/company signature",
                "documentValue1": "FÖR",
                "documentValue2": "2004-10-11",
                "documentVersion": "256580/2004"
              },
              {
                "companyDocumentId": 23646767,
                "companyDocumentType": "annualReport",
                "documentDate": 1072828800,
                "documentTitle": "Annual report for period ending 2003-12-31 registered",
                "documentUrl": "https://api.tic.io/company-documents/23646767/order",
                "documentValue2": "2003-12-31",
                "documentVersion": "4371486",
                "grossPriceIfAny": 40.0
              },
              {
                "companyDocumentId": 16922704,
                "companyDocumentType": "case",
                "documentDate": 1067644800,
                "documentTitle": "Conversion of objects to the Swedish Companies Registration Office's data system",
                "documentValue1": "KONV",
                "documentValue2": "2003-11-01",
                "documentVersion": "1093215/2003"
              },
              {
                "companyDocumentId": 23646768,
                "companyDocumentType": "annualReport",
                "documentDate": 1041292800,
                "documentTitle": "Annual report for period ending 2002-12-31 registered",
                "documentUrl": "https://api.tic.io/company-documents/23646768/order",
                "documentValue2": "2002-12-31",
                "documentVersion": "3339325",
                "grossPriceIfAny": 40.0
              },
              {
                "companyDocumentId": 23646769,
                "companyDocumentType": "annualReport",
                "documentDate": 1009756800,
                "documentTitle": "Annual report for period ending 2001-12-31 registered",
                "documentUrl": "https://api.tic.io/company-documents/23646769/order",
                "documentValue2": "2001-12-31",
                "documentVersion": "2621768",
                "grossPriceIfAny": 40.0
              },
              {
                "companyDocumentId": 23646770,
                "companyDocumentType": "annualReport",
                "documentDate": 978220800,
                "documentTitle": "Annual report for period ending 2000-12-31 registered",
                "documentUrl": "https://api.tic.io/company-documents/23646770/order",
                "documentValue2": "2000-12-31",
                "documentVersion": "323673",
                "grossPriceIfAny": 40.0
              },
              {
                "companyDocumentId": 23646771,
                "companyDocumentType": "annualReport",
                "documentDate": 962323200,
                "documentTitle": "Annual report for period ending 2000-06-30 registered",
                "documentUrl": "https://api.tic.io/company-documents/23646771/order",
                "documentValue2": "2000-06-30",
                "documentVersion": "176529",
                "grossPriceIfAny": 40.0
              },
              {
                "companyDocumentId": 23646772,
                "companyDocumentType": "annualReport",
                "documentDate": 930700800,
                "documentTitle": "Annual report for period ending 1999-06-30 registered",
                "documentUrl": "https://api.tic.io/company-documents/23646772/order",
                "documentValue2": "1999-06-30",
                "documentVersion": "1094929",
                "grossPriceIfAny": 40.0
              },
              {
                "companyDocumentId": 16922705,
                "companyDocumentType": "case",
                "documentDate": 917481600,
                "documentTitle": "Åtgärd av Bolagsverket på grund av personlig konkurs,Change of representative/company signature",
                "documentValue1": "PRVK,ST",
                "documentValue2": "1999-01-29",
                "documentVersion": "18651/1999"
              },
              {
                "companyDocumentId": 16922706,
                "companyDocumentType": "case",
                "documentDate": 898041600,
                "documentTitle": "Amendment of Articles of Association,Change of business name,Change of financial year,Change of representative/company signature,Change relating to auditors,Auditor's commisssion terminated early",
                "documentValue1": "ORDN,FIRM,RÄK,ST,REV,REVF",
                "documentValue2": "1998-06-24",
                "documentVersion": "115524/1998"
              },
              {
                "companyDocumentId": 23646773,
                "companyDocumentType": "annualReport",
                "documentDate": 883526400,
                "documentTitle": "Annual report for period ending 1997-12-31 registered",
                "documentUrl": "https://api.tic.io/company-documents/23646773/order",
                "documentValue2": "1997-12-31",
                "documentVersion": "529477",
                "grossPriceIfAny": 40.0
              },
              {
                "companyDocumentId": 16922707,
                "companyDocumentType": "case",
                "documentDate": 804297600,
                "documentTitle": "New registration,Registrering av ärende utan avgift",
                "documentValue1": "NYB,UP",
                "documentValue2": "1995-07-14",
                "documentVersion": "132365/1995"
              }
            ],
            "elfCode": "XJHM",
            "emailAddresses": [
              {
                "emailAddress": "ekonomi@bahnhof.se",
                "emailAddressType": "general"
              }
            ],
            "franchisesOrLicences": [],
            "hasAddresses": true,
            "hasBankAccounts": true,
            "hasDocuments": true,
            "hasECParticipant": false,
            "hasEmailAddresses": true,
            "hasFranchisesOrLicences": false,
            "hasHyperlinks": true,
            "hasIntelligence": false,
            "hasLEI": true,
            "hasMostRecentFinancialSummary": true,
            "hasPhoneNumbers": true,
            "hasSalesToPublicActors": true,
            "hasStatus": false,
            "hasStock": true,
            "hasTrademarks": true,
            "hyperlinks": [
              {
                "hyperlink": "https://bahnhof.se/",
                "hyperlinkType": "homepage"
              },
              {
                "hyperlink": "https://se.linkedin.com/company/bahnhof",
                "hyperlinkType": "linkedIn"
              }
            ],
            "id": "1893055",
            "intelligence": [],
            "isCeased": false,
            "isRegisteredForFTax": true,
            "isRegisteredForPayroll": true,
            "isRegisteredForVAT": true,
            "iso3166CountryCode": "SE",
            "legalEntityType": "Aktiebolag",
            "lei": {
              "initialRegistrationDate": 1477533600,
              "leiCode": "213800K7LQU3H85KCU96",
              "managingLOU": "549300O897ZC5H7CY412",
              "managingLOULegalName": "Nordic Legal Entity Identifier AB",
              "nextRenewalDate": 1745795880,
              "registrationStatus": "ISSUED"
            },
            "localCompanyCode": "AB",
            "mostRecentFinancialSummary": {
              "bs_TotalAssetsK": 1101530,
              "fn_NumberOfEmployees": 290.0,
              "isAudited": true,
              "km_EquityAssetsRatio": 0.4946,
              "km_GrossMargin": 0.2893,
              "km_NetProfitMargin": 0.1264,
              "km_OperatingMargin": 0.1254,
              "periodEnd": 1672444800,
              "periodStart": 1640995200,
              "rs_NetSalesK": 1730020,
              "rs_OperatingProfitOrLossK": 216943,
              "rs_OtherOperatingIncomeK": 691,
              "rs_ProfitAfterFinancialItemsK": 218657,
              "rs_SumFinancialItemsK": 1714
            },
            "mostRecentPurpose": "Aktiebolaget ska bedriva försäljning av mjukvaror, hårdvaror samt tjänster inom datakommunikation, produktion och försäljning av mediaprodukter och mediatjänster samt därmed förenlig verksamhet.",
            "mostRecentRegisteredAddress": {
              "addressType": "registeredAddress",
              "city": "STOCKHOLM",
              "co": "Bahnhof AB",
              "countryCodeAlpha3": "SE ",
              "postalCode": "10395",
              "street": "Box 7702"
            },
            "mostRecentShareCapital": {
              "firstSeenAt": 1723209756,
              "numberOfShares": 107565130,
              "numberOfSharesHigherLimit": 400000000,
              "numberOfSharesLowerLimit": 100000000,
              "shareCapitalAmount": 1075651.0,
              "shareCapitalHigherLimitAmount": 4000000.0,
              "shareCapitalISO4217CurrencyCode": "SEK",
              "shareCapitalLowerLimitAmount": 1000000.0
            },
            "mostRecentSignatory": {
              "firstSeenAt": 1723209756,
              "signatureDescription": "Firman tecknas av styrelsen Firman tecknas i förening av >Karlung, Jon >Norman, Bengt Staffan Andreas Dessutom har verkställande direktören rätt att teckna firman beträffande löpande förvaltningsåtgärder"
            },
            "names": [
              {
                "companyNamingType": "legalName",
                "firstSeenAt": 1195171200,
                "nameOrIdentifier": "Bahnhof AB (publ)"
              },
              {
                "companyNamingType": "particularName",
                "firstSeenAt": 1117584000,
                "nameOrIdentifier": "Komintern"
              }
            ],
            "phoneNumbers": [
              {
                "e164PhoneNumber": "+46105100000",
                "numberPlanServiceType": "Geografiskt oberoende tjänster",
                "orginalOperator": "Bahnhof AB",
                "phoneNumberType": "fixedLine"
              }
            ],
            "registeredOffices": [
              {
                "county": "Stockholms län",
                "countyCode": "01",
                "firstSeenAt": 1723209756,
                "municipality": "Stockholm",
                "municipalityCode": "0180"
              }
            ],
            "registrationDate": 805680000,
            "registrationNumber": "5565199493",
            "salesToPublicActors": [
              {
                "actorCode": "2260",
                "actorName": "Ånge",
                "actorType": "Municipality",
                "invoicedApprox2022K": 90,
                "invoicedApprox2023K": 59
              },
              {
                "actorCode": "1765",
                "actorName": "Årjäng",
                "actorType": "Municipality",
                "invoicedApprox2022K": 14,
                "invoicedApprox2023K": 8
              }
              {
                "actorName": "Got Event AB",
                "actorType": "MunicipalityCompany",
                "invoicedApprox2022K": 153,
                "invoicedApprox2023K": 179
              },
              {
                "actorName": "Region Halland",
                "actorType": "Region",
                "invoicedApprox2022K": 0,
                "invoicedApprox2023K": 59
              },
              {
                "actorName": "Västra Götalandsregionen",
                "actorType": "Region",
                "invoicedApprox2022K": 52,
                "invoicedApprox2023K": 40
              },
              {
                "actorName": "Sveriges lantbruksuniversitet",
                "actorType": "University",
                "invoicedApprox2022K": 0,
                "invoicedApprox2023K": 448
              },
              {
                "actorName": "Kungliga biblioteket",
                "actorType": "Authority",
                "invoicedApprox2022K": 23,
                "invoicedApprox2023K": 0
              },
              {
                "actorName": "Statens konstråd",
                "actorType": "Authority",
                "invoicedApprox2022K": 35,
                "invoicedApprox2023K": 34
              },
              {
                "actorName": "Institutet för rymdfysik",
                "actorType": "Authority",
                "invoicedApprox2022K": 0,
                "invoicedApprox2023K": 18
              },
              {
                "actorName": "Trafikverket",
                "actorType": "Authority",
                "invoicedApprox2022K": 0,
                "invoicedApprox2023K": 8
              }
            ],
            "sniCodes": [
              {
                "sni_2007Code": "61100",
                "sni_2007Name": "Trådbunden telekommunikation"
              },
              {
                "sni_2007Code": "63110",
                "sni_2007Name": "Databehandling, hosting o.d."
              },
              {
                "sni_2007Code": "69201",
                "sni_2007Name": "Redovisning och bokföring"
              }
            ],
            "status": [],
            "stock": {
              "branchName": "Bredband & Telefoni",
              "dividendAmount": 2.0,
              "dividendCurrency": "SEK",
              "dividendExDate": 1715731200,
              "dividendsPerYear": 1,
              "enterpriseValue": 5163.99,
              "enterpriseValueUpdated": 1731043862,
              "isin": "SE0010442418",
              "listingDate": 1198022400,
              "marketCountryCodeAlpha3": "SWE",
              "marketExchangeName": "OMX Stockholm",
              "marketName": "First North",
              "nextReportDate": 1739836800,
              "nextReportType": "ANNUAL",
              "sectorName": "Telekommunikation",
              "stockQuote": 52.0,
              "stockQuoteUpdated": 1731087908,
              "ticker": "BAHN B",
              "yahooSymbol": "BAHN-B.ST"
            },
            "trademarks": [
              {
                "applicationNumber": "2007-05003",
                "feature": "Figurative",
                "mediaUrl": "https://api.tic.io/media/trademarks/se/415329",
                "registeredCountryCode": "SE",
                "status": "Applicationrefused",
                "trademarkId": 415329,
                "word": "B BAHNHOF"
              },
              {
                "applicationNumber": "2009-06701",
                "expire": 1574812800,
                "feature": "Word",
                "registered": 1259280000,
                "registeredCountryCode": "SE",
                "status": "Expired",
                "trademarkId": 447292,
                "word": "Comptainer"
              },
              {
                "applicationNumber": "2009-06702",
                "expire": 1574812800,
                "feature": "Word",
                "registered": 1259280000,
                "registeredCountryCode": "SE",
                "status": "Expired",
                "trademarkId": 447293,
                "word": "Servtainer"
              },
              {
                "applicationNumber": "2012-04739",
                "expire": 1982361600,
                "feature": "Word",
                "registered": 1351209600,
                "registeredCountryCode": "SE",
                "status": "Registered",
                "trademarkId": 482096,
                "word": "Thule Data Center"
              },
              {
                "applicationNumber": "2013-00692",
                "expire": 1996876800,
                "feature": "Word",
                "registered": 1365724800,
                "registeredCountryCode": "SE",
                "status": "Registered",
                "trademarkId": 488573,
                "word": "IKAPP Finans"
              },
              {
                "applicationNumber": "2013-00975",
                "expire": 1997481600,
                "feature": "Word",
                "registered": 1366329600,
                "registeredCountryCode": "SE",
                "status": "Registered",
                "trademarkId": 489078,
                "word": "OpenGiga"
              },
              {
                "applicationNumber": "2013-02106",
                "expire": 2001110400,
                "feature": "Word",
                "registered": 1369958400,
                "registeredCountryCode": "SE",
                "status": "Registered",
                "trademarkId": 490365,
                "word": "DCDH - Data Center for District Heating"
              },
              {
                "applicationNumber": "2013-04191",
                "expire": 1697587200,
                "feature": "Word",
                "registered": 1382054400,
                "registeredCountryCode": "SE",
                "status": "Expired",
                "trademarkId": 492972,
                "word": "NoLeaks"
              },
              {
                "applicationNumber": "2013-05251",
                "expire": 2027116800,
                "feature": "Word",
                "registered": 1395964800,
                "registeredCountryCode": "SE",
                "status": "Registered",
                "trademarkId": 494265,
                "word": "Based in Sweden"
              },
              {
                "applicationNumber": "2014-03224",
                "feature": "Word",
                "registeredCountryCode": "SE",
                "status": "Applicationrefused",
                "trademarkId": 502301,
                "word": "Kraftwerk"
              },
              {
                "applicationNumber": "2014-08132",
                "expire": 1749081600,
                "feature": "Word",
                "registered": 1433462400,
                "registeredCountryCode": "SE",
                "status": "Registered",
                "trademarkId": 508011,
                "word": "Triple Green"
              },
              {
                "applicationNumber": "2016-05296",
                "expire": 1793664000,
                "feature": "Word",
                "registered": 1478131200,
                "registeredCountryCode": "SE",
                "status": "Registered",
                "trademarkId": 525052,
                "word": "Northern Light"
              },
              {
                "applicationNumber": "2016-05808",
                "expire": 1795392000,
                "feature": "Word",
                "registered": 1479859200,
                "registeredCountryCode": "SE",
                "status": "Registered",
                "trademarkId": 525563,
                "word": "Spridningskollen"
              },
              {
                "applicationNumber": "2017-05526",
                "expire": 1827014400,
                "feature": "Word",
                "registered": 1511481600,
                "registeredCountryCode": "SE",
                "status": "Registered",
                "trademarkId": 536066,
                "word": "Climate+"
              },
              {
                "applicationNumber": "2017-07191",
                "feature": "Word",
                "registeredCountryCode": "SE",
                "status": "Applicationrefused",
                "trademarkId": 537998,
                "word": "Big City"
              },
              {
                "applicationNumber": "2017-08630",
                "expire": 1836777600,
                "feature": "Word",
                "registered": 1521158400,
                "registeredCountryCode": "SE",
                "status": "Registered",
                "trademarkId": 539770,
                "word": "VXDC"
              },
              {
                "applicationNumber": "2018-02465",
                "feature": "Word",
                "registeredCountryCode": "SE",
                "status": "Applicationrefused",
                "trademarkId": 543262,
                "word": "Streama lagligt"
              },
              {
                "applicationNumber": "2018-02507",
                "feature": "Word",
                "registeredCountryCode": "SE",
                "status": "Applicationrefused",
                "trademarkId": 543304,
                "word": "Öppet Spektrum"
              },
              {
                "applicationNumber": "2019-06976",
                "feature": "Word",
                "registeredCountryCode": "SE",
                "status": "Applicationrefused",
                "trademarkId": 558152,
                "word": "Quantum Cloud"
              },
              {
                "applicationNumber": "2020-01310",
                "expire": 1898121600,
                "feature": "Word",
                "registered": 1599609600,
                "registeredCountryCode": "SE",
                "status": "Registered",
                "trademarkId": 561236,
                "word": "Bahnhof"
              },
              {
                "applicationNumber": "2020-03102",
                "expire": 1904342400,
                "feature": "Figurative",
                "mediaUrl": "https://api.tic.io/media/trademarks/se/563313",
                "registered": 1591056000,
                "registeredCountryCode": "SE",
                "status": "Registered",
                "trademarkId": 563313,
                "word": "B BAHNHOF INTERNET MED SEKRETESS"
              },
              {
                "applicationNumber": "2020-03106",
                "expire": 1904342400,
                "feature": "Word",
                "registered": 1590537600,
                "registeredCountryCode": "SE",
                "status": "Registered",
                "trademarkId": 563317,
                "word": "Elementica Data Center Construction"
              },
              {
                "applicationNumber": "2020-03596",
                "expire": 1906070400,
                "feature": "Word",
                "registered": 1592438400,
                "registeredCountryCode": "SE",
                "status": "Registered",
                "trademarkId": 563926,
                "word": "GothCom"
              },
              {
                "applicationNumber": "2021-04259",
                "feature": "Word",
                "registeredCountryCode": "SE",
                "status": "Applicationrefused",
                "trademarkId": 574763,
                "word": "FOLIE"
              },
              {
                "applicationNumber": "2021-06328",
                "expire": 1947196800,
                "feature": "Word",
                "registered": 1634860800,
                "registeredCountryCode": "SE",
                "status": "Registered",
                "trademarkId": 577183,
                "word": "Foliehatt"
              },
              {
                "applicationNumber": "2022-01324",
                "expire": 1962316800,
                "feature": "Word",
                "registered": 1648425600,
                "registeredCountryCode": "SE",
                "status": "Registered",
                "trademarkId": 581448,
                "word": "Nord Stream 3"
              }
            ]
          },
          "highlight": {
            "registrationNumber": {
              "matched_tokens": ["5565199493"],
              "snippet": "<mark>5565199493</mark>"
            }
          },
          "highlights": [
            {
              "field": "registrationNumber",
              "matched_tokens": ["5565199493"],
              "snippet": "<mark>5565199493</mark>"
            }
          ],
          "text_match": 578730123365711993,
          "text_match_info": {
            "best_field_score": "1108091339008",
            "best_field_weight": 15,
            "fields_matched": 1,
            "num_tokens_dropped": 0,
            "score": "578730123365711993",
            "tokens_matched": 1,
            "typo_prefix_score": 0
          }
        }
      ],
      "out_of": 1840750,
      "page": 1,
      "request_params": {
        "collection_name": "companies_se_20241215202246",
        "first_q": "5565199493",
        "per_page": 10,
        "q": "5565199493"
      },
      "search_cutoff": false,
      "search_time_ms": 2
    }
  ]
}
```


# Search companies
Source: https://docs.tic.io/api-core/search-companies/search-companies

get /search/companies
Search companies in our lightning-fast memory database

Check our extensive examples and description [here](/api-core/search).

<Tip>
  You can add <code>\&view=html</code> to your querystring and we will render an
  html page with explanations.
</Tip>


# Search companies multi
Source: https://docs.tic.io/api-core/search-companies/search-companies-multi

post /search/companies
Multi search enables to carry out multiple search requests in a single request



# Search for bankruptcies since 1979 in Sweden
Source: https://docs.tic.io/api-core/search-company-bankruptcies/search-company-bankruptcies

get /search/companies/bankruptcies/se
Search bankruptcies in our lightning-fast memory database

Check our extensive examples and description [here](/datasets/search-bankruptcies-se).

<Tip>
  You can add \&view=html to your querystring and we will render an html page
  with explanations.
</Tip>


# Search for bankruptcies since 1979 in Sweden
Source: https://docs.tic.io/api-core/search-company-bankruptcies/search-company-bankruptcies-multi

post /search/companies/bankruptcies/se
Multi search enables to carry out multiple search requests in a single request



# Search for workplaces for companies
Source: https://docs.tic.io/api-core/search-company-workplaces/search-company-workplaces

get /search/company-workplaces
Search workplaces in our lightning-fast memory database

Check our extensive examples and description [here](/datasets/search-workplaces).

<Tip>
  You can add <code>\&view=html</code> to your querystring and we will render an
  html page with explanations.
</Tip>


# Search for workplaces for companies
Source: https://docs.tic.io/api-core/search-company-workplaces/search-company-workplaces-multi

post /search/company-workplaces
Multi search enables to carry out multiple search requests in a single request

Check our extensive examples and description [here](/datasets/search-workplaces).


# Search for persons
Source: https://docs.tic.io/api-core/search-persons/search-persons

get /search/persons
Search persons in our lightning-fast memory database

This endpoint is only enabled for customers that passed certain requirements (purpose validation) and
has separate throttling enabled.


# Search for persons
Source: https://docs.tic.io/api-core/search-persons/search-persons-multi

post /search/persons
Multi search enables to carry out multiple search requests in a single request

This endpoint is only enabled for customers that passed certain requirements (purpose validation) and
has separate throttling enabled.


# Search properties
Source: https://docs.tic.io/api-core/search-properties/search-properties-se

get /search/properties/se
Search properties in our lightning-fast memory database

Check our extensive examples and description [here](/datasets/search-properties-se).

<Tip>
  You can add <code>\&view=html</code> to your querystring and we will render an
  html page with explanations.
</Tip>


# Search properties multi
Source: https://docs.tic.io/api-core/search-properties/search-properties-se-multi

post /search/properties/se
Multi search enables to carry out multiple search requests in a single request

Check our extensive examples and description [here](/datasets/search-properties-se).


# Search text in financial reports belonging to Swedish businesses
Source: https://docs.tic.io/api-core/search-reports/search-reports

get /search/companies/reports/se
Search reports in our lightning-fast memory database

Check our extensive examples and description [here](/datasets/search-reports-se).

<Tip>
  You can add <code>\&view=html</code> to your querystring and we will render an
  html page with explanations.
</Tip>


# Search text in financial reports belonging to Swedish businesses multi
Source: https://docs.tic.io/api-core/search-reports/search-reports-multi

post /search/companies/reports/se
Multi search enables to carry out multiple search requests in a single request



# Search for vehicles in Sweden
Source: https://docs.tic.io/api-core/search-vehicles/search-vehicles

get /search/vehicles/se
Search vehicles in our lightning-fast memory database

Check our extensive examples and description [here](/datasets/search-vehicles).

<Tip>
  You can add \&view=html to your querystring and we will render an html page
  with explanations.
</Tip>


# Search for vehicles in Sweden
Source: https://docs.tic.io/api-core/search-vehicles/search-vehicles-multi

post /search/vehicles/se
Multi search enables to carry out multiple search requests in a single request



# Vehicle details
Source: https://docs.tic.io/api-core/vehicles/details

get /datasets/vehicles/se/{vehicleId}/details
Get all vehicle details

Get's the most recent details of the vehicle. Model is large and
contains over 300 fields.


# Vehicle events
Source: https://docs.tic.io/api-core/vehicles/events

get /datasets/vehicles/se/{vehicleId}/events
Get all events related to a vehicle

Will get all known historic events for the vehicle.


# Vehicle licence plate
Source: https://docs.tic.io/api-core/vehicles/licence-plate

get /datasets/vehicles/se/licence-plate/{licencePlate}
Get a summary of the vehicle by it's licence plate

Get's a summary of the vehicle based on the licence plate. Will only get the current
vehicle using the licence plate and not historic vehicles that may have have
been registered with the licence plate.


# Vehicle mileage
Source: https://docs.tic.io/api-core/vehicles/mileage

get /datasets/vehicles/se/{vehicleId}/mileage
Get all known mileage records for a vehicle

Will get all historic mileage records for the vehicle.


# Vehicle summary
Source: https://docs.tic.io/api-core/vehicles/summary

get /datasets/vehicles/se/{vehicleId}
Get a summary of the vehicle by it's id

Get's a summary of the vehicle.


# Create
Source: https://docs.tic.io/api-core/watchlists/create

https://api.tic.io/docs/v1/swagger.json POST /watchlists
Creates a new watchlist



# Add member to watchlist
Source: https://docs.tic.io/api-core/watchlists/create-member

post /watchlists/{watchListId}/members
Add a member to the watchlist

This endpoint is used to add a single company or person per request. If you
want to add multiple companies and/or persons you can use this [endpoint](create-members2)
instead.


# Add multiple members to watchlist
Source: https://docs.tic.io/api-core/watchlists/create-member2

post /watchlists/{watchListId}/members2
Add multiple members to the watchlist

This endpoints allows up adding multiple companies and/or persons to a watchlist
in a single request. Up to 10 000 records are allowed to be added with
one request. If a company or person has already been added it will jump
over the record and only recorded added will be returned.

Please note that this endpoint doesn't allow you to include custom
identifiers (externalId) that the single endpoint for adding companies
or persons allows for.


# Add trigger to watchlist
Source: https://docs.tic.io/api-core/watchlists/create-trigger

post /watchlists/{watchListId}/triggers
Add a trigger to the watchlist

On 2025-05-02 we made a change so creating triggers will monitor all
available events and push them invidually. Earlier we required
you to instruct which events you wanted to watch.

This means that the webhook will contain a payload containing an
array of events.

Example of how the payload will look like:

```json Webhook post to your endpoint theme={null}
[
  {
    "teamWatchListMemberEventId": 1,
    "teamWatchListMemberId": 9029,
    "teamWatchListId": 18,
    "externalId": "MY_NUMBER_1",
    "companyId": 12345678,
    "watchListMemberEventType": "companyAddress",
    "eventDate": "2024-02-02T10:49:24",
    "lastUpdatedAtUtc": "2025-05-02T11:30:09"
  },
  {
    "teamWatchListMemberEventId": 2,
    "teamWatchListMemberId": 9029,
    "teamWatchListId": 18,
    "externalId": "MY_NUMBER_2",
    "companyId": 12345678,
    "watchListMemberEventType": "companyRegistration",
    "eventDate": "2025-04-09T15:21:04",
    "lastUpdatedAtUtc": "2025-05-02T11:30:09"
  },
  {
    "teamWatchListMemberEventId": 3,
    "teamWatchListMemberId": 9029,
    "teamWatchListId": 18,
    "externalId": "MY_NUMBER_3",
    "companyId": 12345678,
    "watchListMemberEventType": "companyIntelligence",
    "eventDate": "2025-04-13T15:47:27",
    "lastUpdatedAtUtc": "2025-05-02T11:30:09"
  },
  {
    "teamWatchListMemberEventId": 4,
    "teamWatchListMemberId": 9029,
    "teamWatchListId": 18,
    "externalId": "MY_NUMBER_4",
    "companyId": 12345678,
    "watchListMemberEventType": "companyFinancialDocument",
    "eventDate": "2025-02-25T08:51:23",
    "lastUpdatedAtUtc": "2025-05-02T11:30:09"
  }
]
```

## WatchListMemberEventTypes

The property watchListMemberEventType has the following valid types.

| Type                     | Description                                                                      |
| ------------------------ | -------------------------------------------------------------------------------- |
| companyAddress           | New information surrounding one or multiple addresses                            |
| companyName              | New information surrounding names of the business                                |
| companyStatus            | New information surrounding status of the business                               |
| companyRegistration      | New information surrounding registration of the business (VAT, payroll, tax etc) |
| companyIntelligence      | New information surrounding intelligence of the business                         |
| companyBeneficialOwner   | New information surrounding beneficial owners of the business                    |
| companyWorkplace         | New information surrounding one or multiple workplaces owned by the business     |
| companyPerson            | New information surrounding company representatives                              |
| companyRegisteredOffice  | New information surrounding the companys registered office                       |
| companyShareCapital      | New information surrounding the companys share capital                           |
| companyPurpose           | New information surrounding the company purpose                                  |
| companyDebtBalance       | New information surrounding changes of the debt balance                          |
| companyOrderToPayCase    | New information surrounding one or multiple order to pay cases                   |
| companyFinancialDocument | New information surrounding financial documents such as annual reports           |
| companyCase              | New information surrounding cases (inneliggande ärenden)                         |
| personAddress            | New information surrounding person addresses                                     |
| personName               | New information surrounding person name                                          |
| personStatus             | New information surrounding person status                                        |
| personCompany            | New information surrounding the persons involvement as company representative    |


# Delete watchlist
Source: https://docs.tic.io/api-core/watchlists/delete

delete /watchlists/{watchListId}
Deletes a watchlist



# Delete member
Source: https://docs.tic.io/api-core/watchlists/delete-member

delete /watchlists/{watchListId}/members/{memberId}
Deletes a member



# Delete trigger
Source: https://docs.tic.io/api-core/watchlists/delete-trigger

delete /watchlists/{watchListId}/triggers/{triggerId}
Deletes a trigger



# Details
Source: https://docs.tic.io/api-core/watchlists/details

get /watchlists/{watchListId}
Get watchlist by id



# Get member
Source: https://docs.tic.io/api-core/watchlists/details-member

get /watchlists/{watchListId}/members/{memberId}
Get member by id



# Get trigger
Source: https://docs.tic.io/api-core/watchlists/details-trigger

get /watchlists/{watchListId}/triggers/{triggerId}
Get trigger by id



# Edit
Source: https://docs.tic.io/api-core/watchlists/edit

put /watchlists/{watchListId}
Updates an existing watchlist



# Edit
Source: https://docs.tic.io/api-core/watchlists/edit-member

put /watchlists/{watchListId}/members/{memberId}
Updates an existing member



# Edit
Source: https://docs.tic.io/api-core/watchlists/edit-trigger

put /watchlists/{watchListId}/triggers/{triggerId}
Updates an existing trigger



# List members
Source: https://docs.tic.io/api-core/watchlists/members

get /watchlists/{watchListId}/members
Lists all the watchlist members for the watchlist



# Test a trigger
Source: https://docs.tic.io/api-core/watchlists/test-trigger

post /watchlists/{watchListId}/triggers/{triggerId}/test
Test a trigger by id

You can use this endpoint to test your triggers (only webhoooks) and
we will send a webhook to your endpoint.


# List triggers
Source: https://docs.tic.io/api-core/watchlists/triggers

get /watchlists/{watchListId}/triggers
Lists all the triggers for the watchlist



# List
Source: https://docs.tic.io/api-core/watchlists/watchlists

https://api.tic.io/docs/v1/swagger.json GET /watchlists
Lists all the watchlists for the team



# Health
Source: https://docs.tic.io/api-free/health

https://api.tic.io/docs/v1/swagger.json GET /free/health
Gets health status for our API, search and other services

This endpoint allows you to get our status health. It doesn't require any token or authentication. If you provide your authentication with your x-api-key or included
in the querystring we will respond back also with the current limits for the API key equals the header data you receive for X-RateLimit-\*.

Response also includes information about any upcoming service windows. Example:

```json Response for health with upcoming service window theme={null}
{
  "ok": true,
  "upcomingServiceWindows": [
    {
      "startDateUtc": "2025-02-02T06:00:00",
      "endDateUtc": "2025-02-02T06:05:00",
      "notes": "Just for demonstration",
      "lastUpdatedAtUtc": "2025-02-01T08:52:43"
    }
  ],
  "limits": {
    "rateLimitReset": 2435948,
    "rateLimit": 3000,
    "rateLimitRemaining": 2965,
    "rateLimitMinute": 960,
    "rateLimitIP": 200
  }
}
```


# Export companies at an address as CSV
Source: https://docs.tic.io/api-lens/addresses/export-companies-at-an-address-as-csv

get /addresses/{id}/companies/export
Returns a CSV of every company registered at this address. The response is UTF-8 CSV with a `Content-Disposition` header.

<Badge>Max+ tier</Badge>


# Export companies at an address by Lantmäteriet UUID as CSV
Source: https://docs.tic.io/api-lens/addresses/export-companies-at-an-address-by-lantmäteriet-uuid-as-csv

get /addresses/se/{externalId}/companies/export
Same as GET /addresses/{id:int}/companies/export but keyed by the Lantmäteriet `Belägenhetsadress` ObjektIdentitet UUID.

<Badge>Max+ tier</Badge>


# Export persons at an address as CSV
Source: https://docs.tic.io/api-lens/addresses/export-persons-at-an-address-as-csv

get /addresses/{id}/persons/export
Returns a CSV of every non-protected natural person registered at this address. The response is UTF-8 CSV with a `Content-Disposition` header.

<Badge>Enterprise+ tier</Badge>


# Export persons at an address by Lantmäteriet UUID as CSV
Source: https://docs.tic.io/api-lens/addresses/export-persons-at-an-address-by-lantmäteriet-uuid-as-csv

get /addresses/se/{externalId}/persons/export
Same as GET /addresses/{id:int}/persons/export but keyed by the Lantmäteriet `Belägenhetsadress` ObjektIdentitet UUID.

<Badge>Enterprise+ tier</Badge>


# Export workplaces at an address as CSV
Source: https://docs.tic.io/api-lens/addresses/export-workplaces-at-an-address-as-csv

get /addresses/{id}/workplaces/export
Returns a CSV of every workplace (arbetsställe) located at this address. The response is UTF-8 CSV with a `Content-Disposition` header.

<Badge>Max+ tier</Badge>


# Export workplaces at an address by Lantmäteriet UUID as CSV
Source: https://docs.tic.io/api-lens/addresses/export-workplaces-at-an-address-by-lantmäteriet-uuid-as-csv

get /addresses/se/{externalId}/workplaces/export
Same as GET /addresses/{id:int}/workplaces/export but keyed by the Lantmäteriet `Belägenhetsadress` ObjektIdentitet UUID.

<Badge>Max+ tier</Badge>


# Get address by easting and northing (SWEREF99 TM)
Source: https://docs.tic.io/api-lens/addresses/get-address-by-easting-and-northing-sweref99-tm

get /addresses/by-location-sweref99
Same as GET /addresses/by-location but the input point is in SWEREF99 TM (SRID 3006). Resolves the registered cadastral unit containing the point (a fastighet or a settled samfällighet) — 404 when none contains the point — then the building footprint containing the point and its `belägenhetsadress`. Address fields may be null when the point is not inside a building or the building has no address.

<Badge>Pro+ tier</Badge>


# Get address by latitude and longitude (WGS84)
Source: https://docs.tic.io/api-lens/addresses/get-address-by-latitude-and-longitude-wgs84

get /addresses/by-location
Resolves a WGS84 coordinate to its Lantmäteriet location context. First the registered cadastral unit containing the point is resolved — a fastighet or a settled samfällighet (both carry a registerenhetsreferens); when no registered unit contains the point (only an unsettled 'outrett' area, water, or outside coverage) 404 is returned. Then the building footprint containing the point is found and its `belägenhetsadress` returned. When the point is on a property but not inside a building (or the building has no address), the property is returned with all address fields null.

<Badge>Pro+ tier</Badge>


# Get address by Swedish Lantmäteriet UUID
Source: https://docs.tic.io/api-lens/addresses/get-address-by-swedish-lantmäteriet-uuid

get /addresses/se/{externalId}
Looks up a Swedish address by its Lantmäteriet `Belägenhetsadress` ObjektIdentitet UUID and returns the corresponding address record, including AddressIntelligence for max/enterprise tiers.

<Badge>Pro+ tier</Badge>


# Get address details by internal ID
Source: https://docs.tic.io/api-lens/addresses/get-address-details-by-internal-id

get /addresses/{id}
Returns core address details, including Lantmäteriet `Belägenhetsadress` enrichment and, for max/enterprise tiers, AddressIntelligence signals.

<Badge>Pro+ tier</Badge>


# Get address by easting and northing (SWEREF99 TM)
Source: https://docs.tic.io/api-lens/addresses/get-closest-address-by-easting-and-northing-sweref99-tm

get /addresses/by-location-sweref99
Same as GET /addresses/by-location but the input point is in SWEREF99 TM (SRID 3006). Resolves the registered cadastral unit containing the point (a fastighet or a settled samfällighet) — 404 when none contains the point — then the building footprint containing the point and its `belägenhetsadress`. Address fields may be null when the point is not inside a building or the building has no address.

<Badge>Pro+ tier</Badge>


# Get address by latitude and longitude (WGS84)
Source: https://docs.tic.io/api-lens/addresses/get-closest-address-by-latitude-and-longitude-wgs84

get /addresses/by-location
Resolves a WGS84 coordinate to its Lantmäteriet location context. First the registered cadastral unit containing the point is resolved — a fastighet or a settled samfällighet (both carry a registerenhetsreferens); when no registered unit contains the point (only an unsettled 'outrett' area, water, or outside coverage) 404 is returned. Then the building footprint containing the point is found and its `belägenhetsadress` returned. When the point is on a property but not inside a building (or the building has no address), the property is returned with all address fields null.

<Badge>Pro+ tier</Badge>


# List companies registered at an address (AG Grid)
Source: https://docs.tic.io/api-lens/addresses/list-companies-registered-at-an-address-ag-grid

post /addresses/{id}/companies
Returns a paginated list of companies that are or were registered at this address. The request body follows the AG Grid server-side row model.

<Badge>Max+ tier</Badge>


# List companies registered at an address by Lantmäteriet UUID (AG Grid)
Source: https://docs.tic.io/api-lens/addresses/list-companies-registered-at-an-address-by-lantmäteriet-uuid-ag-grid

post /addresses/se/{externalId}/companies
Same as POST /addresses/{id:int}/companies but keyed by the Lantmäteriet `Belägenhetsadress` ObjektIdentitet UUID.

<Badge>Max+ tier</Badge>


# List persons registered at an address (AG Grid)
Source: https://docs.tic.io/api-lens/addresses/list-persons-registered-at-an-address-ag-grid

post /addresses/{id}/persons
Returns a paginated list of non-protected natural persons registered at this address. The request body follows the AG Grid server-side row model. Protected identities are excluded.

<Badge>Enterprise+ tier</Badge>


# List persons registered at an address by Lantmäteriet UUID (AG Grid)
Source: https://docs.tic.io/api-lens/addresses/list-persons-registered-at-an-address-by-lantmäteriet-uuid-ag-grid

post /addresses/se/{externalId}/persons
Same as POST /addresses/{id:int}/persons but keyed by the Lantmäteriet `Belägenhetsadress` ObjektIdentitet UUID.

<Badge>Enterprise+ tier</Badge>


# List workplaces at an address (AG Grid)
Source: https://docs.tic.io/api-lens/addresses/list-workplaces-at-an-address-ag-grid

post /addresses/{id}/workplaces
Returns a paginated list of company workplaces (arbetsställen) located at this address. The request body follows the AG Grid server-side row model.

<Badge>Max+ tier</Badge>


# List workplaces at an address by Lantmäteriet UUID (AG Grid)
Source: https://docs.tic.io/api-lens/addresses/list-workplaces-at-an-address-by-lantmäteriet-uuid-ag-grid

post /addresses/se/{externalId}/workplaces
Same as POST /addresses/{id:int}/workplaces but keyed by the Lantmäteriet `Belägenhetsadress` ObjektIdentitet UUID.

<Badge>Max+ tier</Badge>


# Authentication
Source: https://docs.tic.io/api-lens/authentication

How to authenticate against the LENS API with an x-api-key header, how plan-feature gating works, and the full 401/403 error reference.

All LENS API requests require an API key passed via the `x-api-key` header.

For a general overview of authentication flows (querystring, header, OTP + JWT) that apply to **both** APIs, see [Authentication](/authentication). This page focuses on the LENS-specific key management, feature gating, and error model.

## Example

```bash theme={null}
curl -H "x-api-key: YOUR_API_KEY" \
  "https://lens-api.tic.io/search-public/companies?q=Volvo&query_by=names.nameOrIdentifier"
```

## Managing API keys

API keys are managed through the TIC Lens web application under **Settings → API Keys**. Each key is tied to a team and inherits the team's subscription plan and features.

## Key properties

| Property         | Description                                                                    |
| ---------------- | ------------------------------------------------------------------------------ |
| Scopes           | Comma-separated access scopes controlling which operations the key can perform |
| Valid until      | Optional expiry date after which the key stops working                         |
| Blocked until    | Temporary block set by an administrator                                        |
| Monthly limit    | Maximum requests per calendar month                                            |
| Per-minute limit | Maximum requests per sliding 60-second window                                  |
| IP limit         | Maximum number of distinct IP addresses that can use the key per month         |

## Subscription and features

Your API key is linked to a team subscription. Endpoints are gated by plan features (e.g. `pro`, `max`, `enterprise`). If your plan does not include the required feature, the endpoint returns `403` with the missing feature name:

```json theme={null}
{
  "status": 403,
  "title": "Feature Not Available",
  "detail": "Your subscription does not include the 'enterprise' feature.",
  "code": "feature_required",
  "features": ["enterprise"]
}
```

If the team's subscription has expired, all endpoints return `403`:

```json theme={null}
{
  "status": 403,
  "title": "Subscription Expired",
  "detail": "Your team's subscription has expired. Please renew to continue.",
  "code": "subscription_expired"
}
```

## Brute-force protection

After **10 failed attempts** within a 15-minute window, the IP is blocked for **15 minutes**. All requests from that IP will return `401` until the block expires.

The API tracks failed authentication attempts per IP address. During a block:

```json theme={null}
{
  "status": 401,
  "title": "Unauthorized",
  "detail": "Too many failed authentication attempts. Please try again later.",
  "code": "ip_blocked"
}
```

## Endpoint access

API keys can only access endpoints marked as public API endpoints. Attempting to call an internal endpoint returns `403`:

```json theme={null}
{
  "status": 403,
  "title": "Endpoint Not Available",
  "detail": "This endpoint is not available for API key authentication.",
  "code": "endpoint_not_available"
}
```

## Request validation

Requests containing SQL injection, XSS, or path traversal patterns are blocked with `400 Bad Request`. All requests are inspected for malicious patterns before reaching the application.

## Error reference

All error responses use the RFC 7807 Problem Details format with an additional `code` field.

| Status | Code                     | Cause                                                                    |
| ------ | ------------------------ | ------------------------------------------------------------------------ |
| `400`  | -                        | Request blocked by input validation (SQL injection, XSS, path traversal) |
| `401`  | `missing_token`          | No `x-api-key` header provided                                           |
| `401`  | `invalid_api_key`        | API key not found                                                        |
| `401`  | `ip_blocked`             | Too many failed attempts from this IP (15-minute cooldown)               |
| `403`  | `api_key_blocked`        | Key has been temporarily blocked by an administrator                     |
| `403`  | `api_key_expired`        | Key has passed its `ValidUntil` date                                     |
| `403`  | `subscription_required`  | Team has no active subscription                                          |
| `403`  | `subscription_expired`   | Team subscription has expired                                            |
| `403`  | `feature_required`       | Endpoint requires a plan feature the team doesn't have                   |
| `403`  | `endpoint_not_available` | Endpoint is not available for API key access                             |
| `429`  | `rate_limit_exceeded`    | Rate limit exceeded (see [Rate limits](/api-lens/rate-limits))           |


# Get the most recent Bolagsverket case list for a company
Source: https://docs.tic.io/api-lens/bolagsverket/get-the-most-recent-bolagsverket-case-list-for-a-company

get /bolagsverket/case-list/{id}
Returns the most recent previously-ordered Bolagsverket case list (ärendelista) for the company. If no prior order exists, an empty response is returned — use the POST variant to place a new order.

<Badge>Pro+ tier</Badge>


# Order Bolagsverket case details
Source: https://docs.tic.io/api-lens/bolagsverket/order-bolagsverket-case-details

post /bolagsverket/case-details
Places an order with Bolagsverket for detailed information about a specific case (ärende) identified by case number and year. Returns the structured case details (A15 schema).

<Badge>Pro+ tier</Badge>


# Order full Bolagsverket case list for a company
Source: https://docs.tic.io/api-lens/bolagsverket/order-full-bolagsverket-case-list-for-a-company

post /bolagsverket/case-list/{id}
Places an order with Bolagsverket to retrieve the full list of cases (ärendelista) for the company with the given internal ID. Returns the ordered case list (A30 schema).

<Badge>Pro+ tier</Badge>


# Download a BRF annual-report file
Source: https://docs.tic.io/api-lens/brf/download-a-brf-annual-report-file

get /brf/{companyId}/annual-report-file/{fileId}
Streams an annual-report file that belongs to the given BRF. Only TIFF, OriginalPDFImage, and EnhancedPDFSearchable file types are served; any other report file types return 404. Pass `inline=true` to render PDFs in the browser.

<Badge>BRF add-on</Badge>


# Get aggregated BRF data
Source: https://docs.tic.io/api-lens/brf/get-aggregated-brf-data

get /brf/{companyId}
Returns a BRF-tailored aggregate for a housing cooperative (bostadsrättsförening): core identity, owned properties, historical financial reports (with raw-LLM extract), and available annual-report files. Only returns data when the company is registered as a BRF.

<Badge>BRF add-on</Badge>

## Understanding `extendedDetails`

Each entry in `financials[]` may include an `extendedDetails` object - content
extracted by an agent system that runs a sequence of steps:

* PDF / TIFFs are deskewed, cleaned and we run a layout analysis through custom CUDA-kernels
* Customed trained SVTRv2 model runs on the rectangles to identify the text / numbers
* Data is spot-checked against a fast VLM (currentley local hosted GPU Qwen3-VL)
* The full first 15 pages including the full text and spot-corrected data is sent to larger VLM (subject to loading times the agent system chooses among a range of the state of the art high resolution market VLMs)

Data not available as typed columns are created under extendedDetails. Treat `extendedDetails` as a best-effort, evolving block.

**What's in it today**

| Field                     | Description                                                                                                                                                                    |
| ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `managementReportSummary` | Free-text summary of the förvaltningsberättelse.                                                                                                                               |
| `property`                | `propertyDesignation`, `constructionYear`, `landTenure`, `tomtrattsavgald`, residential / commercial / total area in m², counts of commercial units, parking, garage, storage. |
| `board`                   | Chairman, board-member count, deputy count.                                                                                                                                    |
| `auditor`                 | Auditor company, auditor name, audit opinion (e.g. `"ren"`).                                                                                                                   |
| `management`              | Technical / financial property management providers.                                                                                                                           |
| `loanPortfolio`           | Loan count, total debt, weighted-average interest rate, fixed-rate share, loans maturing within 12 months.                                                                     |
| `feeChanges`              | Latest fee-change date and percent, free-text description of planned changes.                                                                                                  |
| `energy`                  | Energy class, energy performance (kWh/m²), energy-declaration date.                                                                                                            |
| `extendedKeyRatios`       | Equity ratio, loan-to-value, maintenance-fund balance, annual maintenance-fund contribution.                                                                                   |
| `significantEvents`       | Array of strings - the väsentliga händelser noted in the report.                                                                                                               |
| `plannedMaintenance`      | Array of strings - line items from the underhållsplan.                                                                                                                         |

**Rules an integrator should know**

<Note>
  **Only the primary period carries `extendedDetails`.** When a financial row's
  `report.createdFromComparativeFigures` is `true`, the row intentionally omits
  `extendedDetails` - the narrative belongs to the year the annual report was
  filed, not to its prior-year comparatives. The same BRF will therefore have
  exactly one `extendedDetails` block per filed annual report, attached to the
  primary-period row only.
</Note>

* **Missing fields are dropped, not nulled.** If the annual report doesn't
  state something or the agent system couldn't extract it confidently, the field - or
  the entire sub-object - is absent from the response. Always treat
  `extendedDetails` and every property under it as optional.
* **Prefer typed siblings when they exist.** A value that appears in both
  `extendedDetails.*` and a structured field on the same `financials[]` row
  (`brfMetrics`, `keyRatios`, `report`, `notes`) is authoritative under the
  typed name. Use `extendedDetails` for fields that have no typed equivalent
  today, and re-check when you upgrade integrations - fields move out as the
  schema matures.
* **The schema is intentionally fluid.** New top-level keys can appear under
  `extendedDetails` without an API version bump, and existing keys can
  disappear (graduating to typed columns) the same way. Don't hardcode
  exhaustive type definitions against this object - model it as
  `Record<string, unknown>` or `Map<string, any>` and access fields
  defensively.
* **Some values carry Swedish terminology** where the concept doesn't
  translate cleanly - e.g. `property.landTenure` returns
  `"agandeRatt"` (freehold) or `"tomtratt"` (site leasehold),
  `auditor.auditOpinion` returns `"ren"` (clean), `"oren"`, etc.


# Get aggregated BRF data by registration number
Source: https://docs.tic.io/api-lens/brf/get-aggregated-brf-data-by-registration-number

get /brf/by-registration-number/{registrationNumber}
Same response as `GET /brf/{companyId}` but looks the BRF up by Swedish organisationsnummer. Accepts the number in any common format: with or without dash (`769603-9952` or `7696039952`), and tolerates surrounding whitespace.

<Badge>BRF add-on</Badge>

This endpoint accepts the Swedish BRF organisationsnummer in any common format -
`769603-9952`, `7696039952`, or with surrounding whitespace - and returns the
same payload as `GET /brf/{companyId}`.

## Understanding `extendedDetails`

Each entry in `financials[]` may include an `extendedDetails` object - content
extracted by an agent system that runs a sequence of steps:

* PDF / TIFFs are deskewed, cleaned and we run a layout analysis through custom CUDA-kernels
* Customed trained SVTRv2 model runs on the rectangles to identify the text / numbers
* Data is spot-checked against a fast VLM (currentley local hosted GPU Qwen3-VL)
* The full first 15 pages including the full text and spot-corrected data is sent to larger VLM (subject to loading times the agent system chooses among a range of the state of the art high resolution market VLMs)

Data not available as typed columns are created under extendedDetails. Treat `extendedDetails` as a best-effort, evolving block.

**What's in it today**

| Field                     | Description                                                                                                                                                                    |
| ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `managementReportSummary` | Free-text summary of the förvaltningsberättelse.                                                                                                                               |
| `property`                | `propertyDesignation`, `constructionYear`, `landTenure`, `tomtrattsavgald`, residential / commercial / total area in m², counts of commercial units, parking, garage, storage. |
| `board`                   | Chairman, board-member count, deputy count.                                                                                                                                    |
| `auditor`                 | Auditor company, auditor name, audit opinion (e.g. `"ren"`).                                                                                                                   |
| `management`              | Technical / financial property management providers.                                                                                                                           |
| `loanPortfolio`           | Loan count, total debt, weighted-average interest rate, fixed-rate share, loans maturing within 12 months.                                                                     |
| `feeChanges`              | Latest fee-change date and percent, free-text description of planned changes.                                                                                                  |
| `energy`                  | Energy class, energy performance (kWh/m²), energy-declaration date.                                                                                                            |
| `extendedKeyRatios`       | Equity ratio, loan-to-value, maintenance-fund balance, annual maintenance-fund contribution.                                                                                   |
| `significantEvents`       | Array of strings - the väsentliga händelser noted in the report.                                                                                                               |
| `plannedMaintenance`      | Array of strings - line items from the underhållsplan.                                                                                                                         |

**Rules an integrator should know**

<Note>
  **Only the primary period carries `extendedDetails`.** When a financial row's
  `report.createdFromComparativeFigures` is `true`, the row intentionally omits
  `extendedDetails` - the narrative belongs to the year the annual report was
  filed, not to its prior-year comparatives. The same BRF will therefore have
  exactly one `extendedDetails` block per filed annual report, attached to the
  primary-period row only.
</Note>

* **Missing fields are dropped, not nulled.** If the annual report doesn't
  state something or the agent system couldn't extract it confidently, the field - or
  the entire sub-object - is absent from the response. Always treat
  `extendedDetails` and every property under it as optional.
* **Prefer typed siblings when they exist.** A value that appears in both
  `extendedDetails.*` and a structured field on the same `financials[]` row
  (`brfMetrics`, `keyRatios`, `report`, `notes`) is authoritative under the
  typed name. Use `extendedDetails` for fields that have no typed equivalent
  today, and re-check when you upgrade integrations - fields move out as the
  schema matures.
* **The schema is intentionally fluid.** New top-level keys can appear under
  `extendedDetails` without an API version bump, and existing keys can
  disappear (graduating to typed columns) the same way. Don't hardcode
  exhaustive type definitions against this object - model it as
  `Record<string, unknown>` or `Map<string, any>` and access fields
  defensively.
* **Some values carry Swedish terminology** where the concept doesn't
  translate cleanly - e.g. `property.landTenure` returns
  `"agandeRatt"` (freehold) or `"tomtratt"` (site leasehold),
  `auditor.auditOpinion` returns `"ren"` (clean), `"oren"`, etc.


# Get demographics for a BRF
Source: https://docs.tic.io/api-lens/brf/get-demographics-for-a-brf

get /brf/{companyId}/demographics
Returns aggregated resident demographics for the BRF: total resident count, median age, median förvärvsinkomst (when ResidentCount ≥ 20 of adults), and a per-bucket breakdown by age band × gender. Cells with fewer than 5 residents are suppressed for k-anonymity. Numbers refer to all current residents folkbokförda at the BRF's addresses; income is computed over the 18+ subset.

<Badge>BRF add-on</Badge>


# Create a secure link to a company report
Source: https://docs.tic.io/api-lens/companies/create-a-secure-link-to-a-company-report

post /companies/{companyId}/secure-link
Mints a time-limited encrypted URL to `rapport.tic.io/foretagsrapport/saker-lank/...` that renders the company report without requiring the recipient to authenticate. `ExpiresAtUtc` must be between 1 hour and 31 days from now; defaults to 7 days. When `EmailTo` is set, a localised email with the link is queued for delivery.

<Badge>Enterprise+ tier</Badge>


# Get accounting periods for a company
Source: https://docs.tic.io/api-lens/companies/get-accounting-periods-for-a-company

get /companies/{id}/accounting-periods
Returns the company's detailed accounting periods (redovisningsperioder), typically monthly/quarterly windows.

<Badge>Pro+ tier</Badge>


# Get addresses for a company
Source: https://docs.tic.io/api-lens/companies/get-addresses-for-a-company

get /companies/{id}/addresses
Returns every address linked to the company (visiting, mailing, registered office, etc.). For max/enterprise tiers, each address is enriched with active AddressIntelligence signals.

<Badge>Pro+ tier</Badge>


# Get Arbetsförmedlingen salary contributions
Source: https://docs.tic.io/api-lens/companies/get-arbetsförmedlingen-salary-contributions

get /companies/{id}/salary-contributions
Returns salary subsidies (lönebidrag) granted by Arbetsförmedlingen to the company.

<Badge>Max+ tier</Badge>


# Get authorizations held by a company
Source: https://docs.tic.io/api-lens/companies/get-authorizations-held-by-a-company

get /companies/{id}/authorizations
Returns the company's registered authorizations — e.g. Finansinspektionen permits, special licences.

<Badge>Pro+ tier</Badge>


# Get bank accounts (Bankgirot) for a company
Source: https://docs.tic.io/api-lens/companies/get-bank-accounts-bankgirot-for-a-company

get /companies/{id}/bank-accounts
Returns the company's bank-giro numbers registered with Bankgirot.

<Badge>Pro+ tier</Badge>


# Get bankruptcy records for a company
Source: https://docs.tic.io/api-lens/companies/get-bankruptcy-records-for-a-company

get /companies/{id}/bankruptcy
Returns the company's registered bankruptcy (konkurs) cases.

<Badge>Pro+ tier</Badge>


# Get beneficial owners for a company
Source: https://docs.tic.io/api-lens/companies/get-beneficial-owners-for-a-company

get /companies/{id}/beneficial-owners
Returns the Bolagsverket beneficial-owner notifications for the company, with owners, representatives, govern codes, and any flagged suspect notifications. Pro tier has personal identity numbers masked.

<Badge>Pro+ tier</Badge>


# Get bonus issues for a company
Source: https://docs.tic.io/api-lens/companies/get-bonus-issues-for-a-company

get /companies/{id}/bonus-issue
Returns the company's historical bonus issues (fondemissioner).

<Badge>Pro+ tier</Badge>


# Get business mortgages (företagsinteckningar)
Source: https://docs.tic.io/api-lens/companies/get-business-mortgages-företagsinteckningar

get /companies/{id}/business-mortgages
Returns the company's registered business mortgages (företagsinteckningar) from Bolagsverket.

<Badge>Max+ tier</Badge>


# Get company debt summary
Source: https://docs.tic.io/api-lens/companies/get-company-debt-summary

get /companies/{id}/debts
Returns the company's debt position from the Swedish Enforcement Authority (Kronofogden): most recent debtor summary, aggregate debt summary, current debt cases, and weekly/case-type breakdowns for charting.

<Badge>Max+ tier</Badge>


# Get company ownership graph
Source: https://docs.tic.io/api-lens/companies/get-company-ownership-graph

get /companies/{id}/ownership-graph
Returns an ORB graph of the company's ownership network to the given depth. Nodes/edges are enriched with any watchlist memberships in the caller's team.

<Badge>Max+ tier</Badge>


# Get company ownership hierarchy (tree)
Source: https://docs.tic.io/api-lens/companies/get-company-ownership-hierarchy-tree

get /companies/{id}/ownership-tree
Returns a nested ownership tree built from the `CompanyOwnershipEdge` staging table. Combines ownership from multiple sources (annual reports, SCB, board minutes) with their metadata. Suitable for tree-style UI components.

<Badge>Max+ tier</Badge>


# Get company representatives
Source: https://docs.tic.io/api-lens/companies/get-company-representatives

get /companies/{id}/representatives
Returns the company's representatives: board members, CEO, auditor, signatories — grouped by person and role. Protected persons have their name and personal identity number masked. Pro tier has additional fields masked.

<Badge>Pro+ tier</Badge>


# Get company risk / credit score summary
Source: https://docs.tic.io/api-lens/companies/get-company-risk-credit-score-summary

get /companies/{id}/risks
Returns the cached credit-score and risk summary for a company. Generated from the full credit-scoring pipeline (including the network / ORB graph) and cached for 4 hours. Pro tier receives a downscaled version.

<Badge>Pro+ tier</Badge>


# Get company status history
Source: https://docs.tic.io/api-lens/companies/get-company-status-history

get /companies/{id}/status
Returns the company's full status history — activity status changes, ceased/liquidation transitions, and similar events.

<Badge>Pro+ tier</Badge>


# Get core company details
Source: https://docs.tic.io/api-lens/companies/get-core-company-details

get /companies/{id}
Returns the main company record with its most important summary fields, keyed by internal company ID.

<Badge>Pro+ tier</Badge>


# Get current legal/administrative cases for a company
Source: https://docs.tic.io/api-lens/companies/get-current-legaladministrative-cases-for-a-company

get /companies/{id}/current-cases
Returns the company's currently open legal and administrative cases (e.g. Kronofogden, Skatteverket, Bolagsverket).

<Badge>Pro+ tier</Badge>


# Get demerger records for a company
Source: https://docs.tic.io/api-lens/companies/get-demerger-records-for-a-company

get /companies/{id}/demergers
Returns demergers where the company was the source and any demergers the company was the acquiring party of (overtagande bolag).

<Badge>Pro+ tier</Badge>


# Get email addresses for a company
Source: https://docs.tic.io/api-lens/companies/get-email-addresses-for-a-company

get /companies/{id}/email-addresses
Returns all email addresses linked to the company across internal sources.

<Badge>Pro+ tier</Badge>


# Get export/import categories for a company
Source: https://docs.tic.io/api-lens/companies/get-exportimport-categories-for-a-company

get /companies/{id}/export-import
Returns the company's export/import category classifications (e.g. SCB trade export/import categories).

<Badge>Max+ tier</Badge>


# Get financial plans and related documents
Source: https://docs.tic.io/api-lens/companies/get-financial-plans-and-related-documents

get /companies/{id}/financial-plans
Returns the company's registered financial plans (ekonomiska planer) and any linked Bolagsverket document files.

<Badge>Pro+ tier</Badge>


# Get fiscal years for a company
Source: https://docs.tic.io/api-lens/companies/get-fiscal-years-for-a-company

get /companies/{id}/fiscal-years
Returns the company's declared fiscal years (räkenskapsår).

<Badge>Pro+ tier</Badge>


# Get franchise and licence records for a company
Source: https://docs.tic.io/api-lens/companies/get-franchise-and-licence-records-for-a-company

get /companies/{id}/franchise-licences
Returns franchise agreements and operating licences associated with the company.

<Badge>Pro+ tier</Badge>


# Get full annual-report financials
Source: https://docs.tic.io/api-lens/companies/get-full-annual-report-financials

get /companies/{id}/financials
Returns all annual-report financial tables (income statement, balance sheet, cash flow, supplementary tables) for every period on record. Labels are localised from the caller's user locale — Swedish ("sv") by default; otherwise English.

<Badge>Pro+ tier</Badge>


# Get income tax returns (inkomsttaxeringar)
Source: https://docs.tic.io/api-lens/companies/get-income-tax-returns-inkomsttaxeringar

get /companies/{id}/income-tax-return
Returns the company's annual income tax returns (inkomsttaxeringar). Results are grouped by taxable year; the most recent sequence per year is returned.

<Badge>Enterprise+ tier</Badge>


# Get intelligence flags for a company
Source: https://docs.tic.io/api-lens/companies/get-intelligence-flags-for-a-company

get /companies/{id}/intelligence
Returns the company's raised intelligence flags — computed signals that indicate risks, anomalies, or noteworthy events (e.g. annual-report discrepancies).

<Badge>Max+ tier</Badge>


# Get Kammarkollegiet sanction cases for a company
Source: https://docs.tic.io/api-lens/companies/get-kammarkollegiet-sanction-cases-for-a-company

get /companies/{id}/kammarkollegiet-penalty-fees
Returns Kammarkollegiet sanction/penalty cases for the company, grouped by diary number, with the most recent balance and the full history per case.

<Badge>Max+ tier</Badge>


# Get liquidation records for a company
Source: https://docs.tic.io/api-lens/companies/get-liquidation-records-for-a-company

get /companies/{id}/liquidation
Returns the company's liquidation history together with any ordered liquidation filings (likvidationsbeslut).

<Badge>Pro+ tier</Badge>


# Get Länsstyrelsen decisions for a company
Source: https://docs.tic.io/api-lens/companies/get-länsstyrelsen-decisions-for-a-company

get /companies/{id}/lansstyrelsen-penalty-fees
Returns Länsstyrelsen (County Administrative Board) decisions and penalty fees issued against the company.

<Badge>Max+ tier</Badge>


# Get merger records for a company
Source: https://docs.tic.io/api-lens/companies/get-merger-records-for-a-company

get /companies/{id}/mergers
Returns merger records the company is part of, grouped by plan case number/year. Each group includes all raw rows plus the most recently seen row.

<Badge>Pro+ tier</Badge>


# Get naming history (legal name, trade names)
Source: https://docs.tic.io/api-lens/companies/get-naming-history-legal-name-trade-names

get /companies/{id}/naming
Returns the company's naming history — current and historical legal names as well as any trade names (bifirma).

<Badge>Pro+ tier</Badge>


# Get official registrations for a company
Source: https://docs.tic.io/api-lens/companies/get-official-registrations-for-a-company

get /companies/{id}/registrations
Returns the company's official registrations (Bolagsverket Flux/Quark, internal Tensor) — e.g. form of business, legal entity type, first registration date.

<Badge>Pro+ tier</Badge>


# Get ownership/role graph for a company
Source: https://docs.tic.io/api-lens/companies/get-ownershiprole-graph-for-a-company

get /companies/{id}/graph
Returns a progressive ORB (Ownership, Roles, Beneficial owners) graph centred on the company. Optional flags toggle beneficial-owner edges and visual risk highlighting. Node and role-expansion limits protect against explosively large graphs.

<Badge>Max+ tier</Badge>


# Get payroll summary for a company
Source: https://docs.tic.io/api-lens/companies/get-payroll-summary-for-a-company

get /companies/{id}/payrolls
Returns the company's payroll and employer-fee history, including Skatteverket MOMS-AG (VAT/employer tax) filings and aggregated CompanyPayroll2 rows.

<Badge>Enterprise+ tier</Badge>


# Get penalties and late fees for a company
Source: https://docs.tic.io/api-lens/companies/get-penalties-and-late-fees-for-a-company

get /companies/{id}/penalities-and-late-fees
Returns a consolidated list of penalties and late fees across Skatteverket, Kammarkollegiet (sanctions), Länsstyrelsen (decisions), Försäkringskassan (claims) and internal CompanyFee records.

<Badge>Max+ tier</Badge>


# Get phone numbers for a company
Source: https://docs.tic.io/api-lens/companies/get-phone-numbers-for-a-company

get /companies/{id}/phone-numbers
Returns all phone numbers linked to the company across internal sources.

<Badge>Pro+ tier</Badge>


# Get properties (fastigheter) owned by a company
Source: https://docs.tic.io/api-lens/companies/get-properties-fastigheter-owned-by-a-company

get /companies/{id}/properties
Returns the Lantmäteriet ownership records (ägande) for properties belonging to the company.

<Badge>Pro+ tier</Badge>


# Get PRV trademarks for a company
Source: https://docs.tic.io/api-lens/companies/get-prv-trademarks-for-a-company

get /companies/{id}/trademarks
Returns trademarks registered with PRV (the Swedish Patent and Registration Office) where the company is an applicant, together with classes, events, images, and representatives.

<Badge>Pro+ tier</Badge>


# Get public-sector sales (leveranser till kommuner)
Source: https://docs.tic.io/api-lens/companies/get-public-sector-sales-leveranser-till-kommuner

get /companies/{id}/public-sales
Returns statistics on the company's sales to Swedish municipalities, sourced from SCB municipality vendor statistics.

<Badge>Pro+ tier</Badge>


# Get registered offices (säten) for a company
Source: https://docs.tic.io/api-lens/companies/get-registered-offices-säten-for-a-company

get /companies/{id}/registered-offices
Returns the company's registered office history (säte) resolved against the municipality and county dictionaries.

<Badge>Pro+ tier</Badge>


# Get registered purposes (verksamhetsföremål)
Source: https://docs.tic.io/api-lens/companies/get-registered-purposes-verksamhetsföremål

get /companies/{id}/purposes
Returns the company's registered purposes/business objects (verksamhetsföremål) from Bolagsverket.

<Badge>Pro+ tier</Badge>


# Get reorganization records for a company
Source: https://docs.tic.io/api-lens/companies/get-reorganization-records-for-a-company

get /companies/{id}/reorganization
Returns the company's corporate reorganization (företagsrekonstruktion) history.

<Badge>Pro+ tier</Badge>


# Get serving permits held by a company
Source: https://docs.tic.io/api-lens/companies/get-serving-permits-held-by-a-company

get /companies/{id}/serving-permits
Returns Swedish serving permits (alkoholtillstånd) held by the company, from Folkhälsomyndigheten.

<Badge>Pro+ tier</Badge>


# Get share capital and share classes
Source: https://docs.tic.io/api-lens/companies/get-share-capital-and-share-classes

get /companies/{id}/share-capital
Returns the company's registered share capital over time plus the set of share classes (A/B/C etc.) as sourced from Bolagsverket (Quark).

<Badge>Pro+ tier</Badge>


# Get share issues for a company
Source: https://docs.tic.io/api-lens/companies/get-share-issues-for-a-company

get /companies/{id}/share-issue
Returns the company's historical share issues (nyemissioner).

<Badge>Pro+ tier</Badge>


# Get an AI analysis of a company's signatory rules
Source: https://docs.tic.io/api-lens/companies/get-signatory-analysis-for-a-company

get /companies/{id}/signatory/analysis
Reads the company's current signatory rule (firmateckning) from Bolagsverket, interprets it, and matches it against the company's active board members and officers. Returns a plain-language summary, the individual signing rules, and the persons eligible to sign. The result is cached per signatory record: if an analysis already exists for the current signatory text it is returned immediately, otherwise a new one is generated.

<Badge>Enterprise+ tier</Badge>


# Get signatory rules for a company
Source: https://docs.tic.io/api-lens/companies/get-signatory-rules-for-a-company

get /companies/{id}/signatory
Returns the company's signatory rules (firmateckning) as sourced from Bolagsverket (Quark).

<Badge>Pro+ tier</Badge>


# Get SNI industry codes for a company
Source: https://docs.tic.io/api-lens/companies/get-sni-industry-codes-for-a-company

get /companies/{id}/industries
Returns the company's ranked SNI industry codes (Tensor-sourced), resolved against both SNI 2007 and SNI 2025 dictionaries.

<Badge>Pro+ tier</Badge>


# Get temporary tax-payment respite (TF-ANST)
Source: https://docs.tic.io/api-lens/companies/get-temporary-tax-payment-respite-tf-anst

get /companies/{id}/temporary-tax-payment-respite
Returns Skatteverket TF-ANST records — temporary deferrals of tax payments granted to the company.

<Badge>Max+ tier</Badge>


# Get vehicles owned or used by a company
Source: https://docs.tic.io/api-lens/companies/get-vehicles-owned-or-used-by-a-company

get /companies/{id}/vehicles
Returns vehicles registered to the company at Transportstyrelsen — either as owner (ägare) or primary user (brukare).

<Badge>Pro+ tier</Badge>


# Get workplaces (arbetsställen) for a company
Source: https://docs.tic.io/api-lens/companies/get-workplaces-arbetsställen-for-a-company

get /companies/{id}/workplaces
Returns every workplace (arbetsställe) operated by the company — fully populated with addresses, industry codes, workplace categories, phone numbers, statuses, and historical block and unit records.

<Badge>Pro+ tier</Badge>


# List documents for a company
Source: https://docs.tic.io/api-lens/companies/list-documents-for-a-company

get /companies/{id}/documents
Returns every document we hold for the company: filed annual reports (with files, signatures, dividends, mentions), Bolagsverket filings, terminated/shortage reports, and any related intelligence flags.

<Badge>Pro+ tier</Badge>


# Order a PEP,sanction and adverse media screening
Source: https://docs.tic.io/api-lens/companies/order-a-pepsanction-and-adverse-media-screening

post /companies/{id}/order-trapets-screening
Places an order with Trapets for PEP, sanction and adverse media screening the company. Returns an `OrderConfirmation_Dto` with the DocumentOrderGuid so the caller can poll order status.

<Badge>Pro+ tier</Badge>


# Order a Swedish registration letter (Bolagsverket)
Source: https://docs.tic.io/api-lens/companies/order-a-swedish-registration-letter-bolagsverket

post /companies/{id}/registration-letter-swedish
Places an order with Bolagsverket for a Swedish-language registration letter (registreringsbevis) for the company. Returns an `OrderConfirmation_Dto` with the DocumentOrderGuid so the caller can poll order status.

<Badge>Pro+ tier</Badge>


# Order an English registration letter (Bolagsverket)
Source: https://docs.tic.io/api-lens/companies/order-an-english-registration-letter-bolagsverket

post /companies/{id}/registration-letter-english
Places an order with Bolagsverket for an English-language registration letter (registreringsbevis på engelska) for the company. Returns an `OrderConfirmation_Dto` with the DocumentOrderGuid so the caller can poll order status.

<Badge>Pro+ tier</Badge>


# Download a document file by prefixed ID
Source: https://docs.tic.io/api-lens/documents/download-a-document-file-by-prefixed-id

get /documents/{id}
Returns the document file bytes for a given prefixed ID. Supported prefixes: `FRF_` (Financial Report File), `BDF_` (Bolagsverket Document File). For PDFs the `inline` query parameter controls whether the browser displays the file inline or forces a download.

<Badge>Pro+ tier</Badge>


# Get flight images at a point in Sweden
Source: https://docs.tic.io/api-lens/flightimages/get-flight-images-at-a-point-in-sweden

get /flight-images/se/by-point
Returns flight images/orthophotos intersecting a circular buffer around the given WGS84 point. Useful when the caller has a coordinate but no property UUID.

<Badge>Enterprise+ tier</Badge>


# Get flight images at a point in Sweden (with metadata)
Source: https://docs.tic.io/api-lens/flightimages/get-flight-images-at-a-point-in-sweden-with-metadata

get /flight-images/se/by-point/with-metadata
Same as `GetFlightImagesBySePoint` but returns the full upstream response including processing metadata and error codes, instead of just the image list.

<Badge>Enterprise+ tier</Badge>


# Get flight images for a Swedish property (with metadata)
Source: https://docs.tic.io/api-lens/flightimages/get-flight-images-for-a-swedish-property-with-metadata

get /flight-images/se/{uuid}/with-metadata
Same as `GetFlightImagesBySe` but returns the full upstream response including processing metadata and error codes, instead of just the image list.

<Badge>Enterprise+ tier</Badge>


# Get flight images (orthophotos) for a Swedish property
Source: https://docs.tic.io/api-lens/flightimages/get-flight-images-orthophotos-for-a-swedish-property

get /flight-images/se/{uuid}
Returns a list of orthophotos/flight images for a property identified by its Lantmäteriet UUID. Supports filtering to only the most recent image or a specific year (1949 onwards).

<Badge>Enterprise+ tier</Badge>


# Health check
Source: https://docs.tic.io/api-lens/free

Free anonymous health endpoint for the LENS API. Returns service status, upcoming SLA windows, and - when authenticated - your current rate-limit state.

The LENS API exposes a single unauthenticated health endpoint. Use it to verify the API and its upstream services are reachable, surface upcoming service windows, and (when you authenticate) inspect your current rate-limit state - all without spending a request against your quota.

```
GET https://lens-api.tic.io/free/health
```

<Info>
  This endpoint is anonymous and rate-limiting is disabled. You do not need an API key. Providing one is optional - it unlocks the `limits` block in the response.
</Info>

## What it checks

The endpoint independently probes every critical upstream service:

| Service     | What "ok" means                                  |
| ----------- | ------------------------------------------------ |
| `typesense` | Search index is reachable and reports `ok: true` |
| `redis`     | Cache / rate-limit store responds to `PING`      |
| `database`  | SQL database accepts a connection                |

If any service fails, the response returns **HTTP 503 Service Unavailable** with `ok: false` and per-service error detail in the `services` object. When all services are healthy, the response is **HTTP 200 OK** with `ok: true`.

## Response

```json theme={null}
{
  "ok": true,
  "version": "v2",
  "serverTimeUtc": "2026-04-18T09:12:34.567Z",
  "services": {
    "typesense": { "ok": true },
    "redis": { "ok": true },
    "database": { "ok": true }
  },
  "upcomingServiceWindows": [
    {
      "startDateUtc": "2026-05-02T06:00:00",
      "endDateUtc": "2026-05-02T06:05:00",
      "notes": "Planned Typesense index maintenance",
      "lastUpdatedAtUtc": "2026-04-10T08:52:43"
    }
  ],
  "limits": {
    "rateLimitReset": 2435948,
    "rateLimit": 3000,
    "rateLimitRemaining": 2965,
    "rateLimitMinute": 60,
    "rateLimitIP": 20
  }
}
```

### Fields

| Field                    | Type     | Description                                                                |
| ------------------------ | -------- | -------------------------------------------------------------------------- |
| `ok`                     | bool     | `true` when all critical services are healthy; `false` triggers a 503.     |
| `version`                | string   | API version identifier (`v2` for LENS).                                    |
| `serverTimeUtc`          | datetime | Current server time in UTC. Useful for detecting clock skew on the client. |
| `services`               | object   | Per-service status map. Each entry has `ok` and, on failure, `error`.      |
| `upcomingServiceWindows` | array    | Scheduled maintenance windows with an end time still in the future.        |
| `limits`                 | object   | Present only when the request includes a valid API key. See below.         |

### Rate-limit state (authenticated only)

When you pass `x-api-key`, the response also includes your current quota state:

| Field                | Description                              |
| -------------------- | ---------------------------------------- |
| `rateLimitReset`     | Seconds until the monthly counter resets |
| `rateLimit`          | Monthly quota                            |
| `rateLimitRemaining` | Requests remaining this month            |
| `rateLimitMinute`    | Per-minute quota                         |
| `rateLimitIP`        | Maximum unique source IPs per month      |

These values mirror the `X-RateLimit-*` headers documented in [Rate limits](/api-lens/rate-limits). Calling `/free/health` lets you inspect them without making a rate-limited request.

## Examples

<Tabs>
  <Tab title="Anonymous">
    ```bash theme={null}
    curl https://lens-api.tic.io/free/health
    ```
  </Tab>

  <Tab title="With API key">
    ```bash theme={null}
    curl -H "x-api-key: YOUR_API_KEY" \
      https://lens-api.tic.io/free/health
    ```
  </Tab>
</Tabs>

## Use cases

* **Uptime monitoring** - point your monitoring tool at `/free/health` and alert on non-200 responses or `ok: false`.
* **Pre-deploy gate** - block deploys while a service window is active by checking `upcomingServiceWindows`.
* **Clock-skew debugging** - compare `serverTimeUtc` against your local clock to rule out time-related auth failures.
* **Quota dashboards** - authenticated calls return your current usage without consuming quota themselves.


# Health
Source: https://docs.tic.io/api-lens/free/health

https://lens-api.tic.io/docs/v1/swagger.json GET /free/health
Aggregate health of the LENS API and its upstream services (Typesense, Redis, database). Returns 200 when all critical services are reachable and 503 when any is not. Anonymous callers receive service status and upcoming SLA windows; authenticated callers additionally receive their current rate-limit state.



# Identifiers
Source: https://docs.tic.io/api-lens/identifiers

How the LENS API identifies companies, persons, addresses, properties, vehicles, watchlists, and orders - internal IDs, registration numbers, external UUIDs, and GUIDs.

The API uses several types of identifiers to reference entities. Understanding how they relate is key to navigating between endpoints.

## Internal IDs

Every entity has a numeric internal ID that is stable and unique within its type.

| Entity    | ID field             | Type | Example   |
| --------- | -------------------- | ---- | --------- |
| Company   | `companyId`          | int  | `3508351` |
| Person    | `personId`           | int  | `2954253` |
| Address   | `addressId`          | int  | `12345`   |
| Vehicle   | `vehicleId`          | int  | `789012`  |
| Property  | `propertyId`         | int  | `456789`  |
| Workplace | `companyWorkplaceId` | int  | `234567`  |

These IDs are used across all API endpoints:

```
GET /companies/3508351
GET /companies/3508351/representatives
GET /companies/3508351/documents
GET /persons/2954253
GET /vehicles/789012
```

## Registration numbers

Companies can also be looked up by their local registration number (e.g. Swedish organisationsnummer). The registration number is available as a field in search results and company details.

| Field                    | Description                        | Example           |
| ------------------------ | ---------------------------------- | ----------------- |
| `registrationNumber`     | Local registration number          | `5565199493`      |
| `personalIdentityNumber` | Personal identity number (persons) | Varies by country |

To find a company by registration number, use the search API:

```bash theme={null}
curl -H "x-api-key: YOUR_API_KEY" \
  "https://lens-api.tic.io/search-public/companies?q=5565199493&query_by=registrationNumber"
```

The `companyId` from the search result can then be used with all `/companies/{id}/...` endpoints.

## External UUIDs (Sweden)

Swedish properties and addresses from Lantmäteriet have external UUIDs. These can be used as an alternative lookup:

```
GET /properties/se/{uuid}
GET /properties/se/{uuid}/summary
GET /addresses/se/{uuid}
```

## Watchlist IDs

Watchlists and their sub-resources use GUIDs:

| Entity           | Type | Example             |
| ---------------- | ---- | ------------------- |
| Watchlist        | Guid | `a1b2c3d4-e5f6-...` |
| Watchlist member | Guid | `f6e5d4c3-b2a1-...` |
| Notification     | Guid | `12345678-abcd-...` |
| Subscription     | Guid | `abcdef01-2345-...` |

See [Watchlists](/api-lens/watchlists) for how these are used.

## Order IDs

Document orders are identified by GUIDs:

```
GET /orders/{orderGuid}
GET /orders/{orderGuid}/content
GET /orders/{orderGuid}/file
```

## Connecting the dots

<Steps>
  <Step title="Search">
    Search for a company by name or registration number to get `companyId`.
  </Step>

  <Step title="Fetch details">
    Use `GET /companies/{companyId}` to get the full company record.
  </Step>

  <Step title="Drill into sub-resources">
    Use `GET /companies/{companyId}/representatives` to get `personId` values.
  </Step>

  <Step title="Follow connections">
    Use `GET /persons/{personId}` or `POST /persons/{personId}/companies` to see their other positions.
  </Step>

  <Step title="Monitor changes">
    Use `POST /watchlists/{watchlistGuid}/companies/{companyId}` to add the company to a watchlist.
  </Step>
</Steps>


# LENS API (v2)
Source: https://docs.tic.io/api-lens/introduction

TIC's LENS API (v2) - modern endpoints for real-time company, person, property, and vehicle intelligence across the Nordics.

The **v2 API** is TIC's next-generation API, designed to replace the legacy v1 API with a broader surface, richer data, and consistent conventions across all endpoints.
Internally - and in URLs - it's known as **Lens**.

## Base URL

```
https://lens-api.tic.io
```

## Authentication

The v2 API uses the same API key scheme as v1. Pass your key in the `x-api-key` request header:

```http theme={null}
GET /companies/{id} HTTP/1.1
Host: lens-api.tic.io
x-api-key: YOUR_API_KEY
```

See [Authentication](/authentication) for how to obtain a key.

## Feature tiers

Some endpoints require a specific subscription tier or add-on. The requirement is shown as a badge at the top of each endpoint page.

**Cumulative tiers** - each one unlocks everything from the tiers below it:

<Badge>Pro+ tier</Badge>  
<Badge>Max+ tier</Badge>  
<Badge>Enterprise+ tier</Badge>  
<Badge>Government+ tier</Badge>

**Add-ons** - purchased separately, independent of the tier above:

<Badge>Sentinel add-on</Badge>

Sentinel endpoints (document and image forensics) require the **Sentinel** add-on regardless of your main plan.

<Badge>BRF add-on</Badge>

BRF endpoints require the **BRF** add-on regardless of your main plan.

## Migrating from v1

The **v1 API** remains available and fully supported at its existing URLs - see the [v1 API Reference](/api-core/introduction) tab. Endpoints under v2 are the authoritative source going forward.

<Tip>
  If you're starting a new integration, use v2. If you have an existing v1 integration, you can continue using v1 while you plan a migration.
</Tip>


# IP Restrictions
Source: https://docs.tic.io/api-lens/ip-restrictions

LENS API enforces geographic and abuse-based IP restrictions before authentication. Requests are only accepted from SE, NO, DK, FI, DE.

The API enforces geographic IP restrictions to protect against unauthorized access. These checks run **before** authentication and rate limiting.

## Allowed countries

Requests are only accepted from the following countries:

| Country | Code |
| ------- | ---- |
| Sweden  | `SE` |
| Norway  | `NO` |
| Denmark | `DK` |
| Finland | `FI` |
| Germany | `DE` |

Requests originating from other countries receive `403 Forbidden`.

## Abuse detection

Each IP address is checked against an abuse database. If the IP has a positive abuse-confidence score, the request is blocked with `403 Forbidden`.

Abuse check results are cached for **7 days** per IP to minimize lookup overhead.

## Error responses

Blocked requests return `403 Forbidden` with one of the following messages:

| Message                                         | Cause                                    |
| ----------------------------------------------- | ---------------------------------------- |
| `Forbidden IP-address, contact support@tic.io.` | IP flagged for abuse                     |
| `Forbidden country, contact support@tic.io.`    | IP originates from a non-allowed country |

## Need access from another country?

If you need API access from a country not in the allowed list, contact [support@tic.io](mailto:support@tic.io) to discuss your requirements.


# Download the raw document file for an order
Source: https://docs.tic.io/api-lens/orders/download-the-raw-document-file-for-an-order

get /orders/{orderGuid}/file
Returns the raw file bytes produced by the order (typically a PDF or XML, depending on the source). The response `Content-Type` reflects the file's MIME type.

<Badge>Pro+ tier</Badge>


# Get metadata for a single document order
Source: https://docs.tic.io/api-lens/orders/get-metadata-for-a-single-document-order

get /orders/{orderGuid}
Returns the core metadata of a document order identified by its GUID — type, source, status, dates, and identifying fields. Does not return the order content (see /{orderGuid}/content).

<Badge>Pro+ tier</Badge>


# Get structured content of a document order
Source: https://docs.tic.io/api-lens/orders/get-structured-content-of-a-document-order

get /orders/{orderGuid}/content
Returns the structured (parsed) content of the document order — e.g. deserialized Bolagsverket XML, ActaPublica case data, etc. Content shape depends on the order type.

<Badge>Pro+ tier</Badge>


# List document orders placed by the team
Source: https://docs.tic.io/api-lens/orders/list-document-orders-placed-by-the-team

post /orders
Returns a paged, sortable, filterable list of document orders (TeamDocumentOrder) placed by the current team across all supported document sources (Bolagsverket, ActaPublica, Lantmäteriet, etc.). Supports AG Grid server-side model.

<Badge>Pro+ tier</Badge>


# Download the binary content of an order
Source: https://docs.tic.io/api-lens/ordersexports/download-the-binary-content-of-an-order

get /orders/exports/{orderGuid}/download
Streams the latest TeamDocumentOrderContent row for the given order. Content-Type and filename extension reflect TeamDocumentContentType (zip/pdf/json/xml). Response uses Content-Disposition: attachment so browsers/clients save rather than render. The order must belong to the caller's team.

<Badge>Pro+ tier</Badge>


# List the team's document orders (cursor-paginated)
Source: https://docs.tic.io/api-lens/ordersexports/list-the-teams-document-orders-cursor-paginated

get /orders/exports
Returns the team's TeamDocumentOrder rows in TeamDocumentOrderId order. Pass the largest TeamDocumentOrderId from the previous page as `lastItemId` to fetch the next page. Intended for machine clients (cron, integrations) — the Vue portal uses /orders/list (AG Grid) instead.

<Badge>Pro+ tier</Badge>


# Pagination
Source: https://docs.tic.io/api-lens/pagination

How to paginate, sort, and filter LENS API (v2) endpoints that return tabular data using the offset-based AG-Grid request model.

The LENS API uses two pagination patterns depending on the endpoint type:

* **Offset-based (AG-Grid model)** - used by POST endpoints that return tabular data. Covered in detail on this page.
* **Typesense page/per\_page** - used by the `/search-public/*` endpoints. See the [Public Search](/api-lens/publicsearch/search-companies-get) group for query-string parameters.

## Offset-based pagination

Tabular endpoints (companies at an address, watchlist members, person companies, etc.) accept a POST request whose JSON body specifies the row range, sort order, and filters.

### Request body

```json theme={null}
{
  "startRow": 0,
  "endRow": 50,
  "sortModel": [
    { "colId": "companyName", "sort": "asc" }
  ],
  "filterModel": {}
}
```

| Field         | Type   | Description                                                    |
| ------------- | ------ | -------------------------------------------------------------- |
| `startRow`    | int    | Zero-based index of the first row to return                    |
| `endRow`      | int    | Zero-based index of the row **after** the last row (exclusive) |
| `sortModel`   | array  | Optional. Sorting instructions - see [Sorting](#sorting)       |
| `filterModel` | object | Optional. Server-side filters - see [Filtering](#filtering)    |

The page size is `endRow - startRow`. For example, `startRow: 0, endRow: 50` returns the first 50 rows.

### Response

```json theme={null}
{
  "success": true,
  "rows": [ ... ],
  "lastrow": -1
}
```

| Field     | Type  | Description                                                      |
| --------- | ----- | ---------------------------------------------------------------- |
| `success` | bool  | Whether the request succeeded                                    |
| `rows`    | array | The data rows for the requested range                            |
| `lastrow` | int   | Index of the last row in the dataset, or `-1` if more rows exist |

### How to paginate

Use `lastrow` to determine if there are more pages:

* `lastrow == -1` - more rows available, request the next page
* `lastrow >= 0` - this is the last page, `lastrow` is the total row count

Example - fetch all rows in pages of 100:

```bash theme={null}
# Page 1
curl -X POST "https://lens-api.tic.io/addresses/12345/companies" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "startRow": 0, "endRow": 100 }'
# → lastrow: -1 (more rows exist)

# Page 2
curl -X POST "https://lens-api.tic.io/addresses/12345/companies" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "startRow": 100, "endRow": 200 }'
# → lastrow: 142 (last page, 142 total rows)
```

## Sorting

Add a `sortModel` array to sort by one or more columns:

```json theme={null}
{
  "startRow": 0,
  "endRow": 50,
  "sortModel": [
    { "colId": "companyName", "sort": "asc" }
  ]
}
```

| Field   | Type   | Values                 |
| ------- | ------ | ---------------------- |
| `colId` | string | Column name to sort by |
| `sort`  | string | `asc` or `desc`        |

## Filtering

Add a `filterModel` object to filter results server-side. Each key is a column name; the value describes the filter.

### Text filter

```json theme={null}
{
  "filterModel": {
    "companyName": {
      "type": "contains",
      "filter": "Volvo",
      "filterType": "text"
    }
  }
}
```

### Number filter

```json theme={null}
{
  "filterModel": {
    "numberOfEmployees": {
      "type": "greaterThan",
      "filter": 100,
      "filterType": "number"
    }
  }
}
```

### Date range filter

```json theme={null}
{
  "filterModel": {
    "registrationDate": {
      "type": "inRange",
      "dateFrom": "2024-01-01",
      "dateTo": "2024-12-31",
      "filterType": "date"
    }
  }
}
```

### Set filter (match any of the values)

```json theme={null}
{
  "filterModel": {
    "localCompanyCode": {
      "filterType": "set",
      "values": ["AB", "HB"]
    }
  }
}
```

### Multiple conditions on the same column

```json theme={null}
{
  "filterModel": {
    "numberOfEmployees": {
      "operator": "AND",
      "filterType": "number",
      "conditions": [
        { "type": "greaterThan", "filter": 10, "filterType": "number" },
        { "type": "lessThan", "filter": 500, "filterType": "number" }
      ]
    }
  }
}
```

### Supported filter operators

| Operator      | Types        | Description                                 |
| ------------- | ------------ | ------------------------------------------- |
| `equals`      | text, number | Exact match                                 |
| `notEqual`    | text, number | Not equal                                   |
| `contains`    | text         | Substring match                             |
| `startsWith`  | text         | Starts with                                 |
| `endsWith`    | text         | Ends with                                   |
| `greaterThan` | number, date | Greater than                                |
| `lessThan`    | number, date | Less than                                   |
| `inRange`     | date         | Between `dateFrom` and `dateTo` (inclusive) |
| `blank`       | all          | Value is null                               |
| `notBlank`    | all          | Value is not null                           |

### Combining conditions

Use the `operator` field with `"AND"` or `"OR"` to combine multiple conditions on the same column.

## Endpoints using this pattern

These POST endpoints accept the pagination request body described above:

| Endpoint                                | Description                                |
| --------------------------------------- | ------------------------------------------ |
| `POST /addresses/{id}/companies`        | Companies at an address                    |
| `POST /addresses/{id}/workplaces`       | Workplaces at an address                   |
| `POST /addresses/{id}/persons`          | Persons at an address                      |
| `POST /properties/se/{uuid}/companies`  | Companies at a property                    |
| `POST /properties/se/{uuid}/workplaces` | Workplaces at a property                   |
| `POST /persons/{id}/companies`          | Companies where person is a representative |
| `POST /persons/{id}/beneficial-owners`  | Beneficial ownership positions             |
| `POST /watchlists/{id}/companies`       | Company members of a watchlist             |
| `POST /watchlists/{id}/persons`         | Person members of a watchlist              |
| `POST /watchlists/{id}/addresses`       | Address members of a watchlist             |
| `POST /watchlists/{id}/properties`      | Property members of a watchlist            |
| `POST /watchlists/{id}/vehicles`        | Vehicle members of a watchlist             |
| `POST /watchlists/{id}/events`          | Watchlist events                           |
| `POST /orders`                          | Your document orders                       |
| `POST /team/orders`                     | Team document orders                       |
| `POST /team/exports`                    | Team exports                               |


# Get a single parsed payment control header
Source: https://docs.tic.io/api-lens/paymentcontrol/get-a-single-parsed-payment-control-header

get /payment-controls/{id}
Returns the header for one parsed payment control: initiating party, message id, transaction count, source file metadata and import status. Intents are NOT included — call POST /payment-controls/{id}/intents for the paginated grid.

<Badge>Enterprise+ tier</Badge>


# List parsed payment controls for the team (AG Grid)
Source: https://docs.tic.io/api-lens/paymentcontrol/list-parsed-payment-controls-for-the-team-ag-grid

post /payment-controls
Returns a paginated AG Grid view of every ISO 20022 pain.001 file that has been parsed for the caller's team. Each row joins the source `TeamFileImport` so import status (`ImportStatus`) and aggregate counts are available for filter/sort. Intents are NOT included — call POST /payment-controls/{id}/intents for the full breakdown.

<Badge>Enterprise+ tier</Badge>


# List payment intents for a parsed payment control (AG Grid)
Source: https://docs.tic.io/api-lens/paymentcontrol/list-payment-intents-for-a-parsed-payment-control-ag-grid

post /payment-controls/{id}/intents
Returns a paginated AG Grid view of intents within a parsed payment control. Each row joins `CompanySummary` for the legal name and registration number, and exposes a precomputed `HasIntelligenceWarning` flag (true when the matched company is on the Swedish commerce warning list). Bankgiro lookup, OCR validation and Levenshtein-distance fields are exposed as flat columns for sorting and filtering.

<Badge>Enterprise+ tier</Badge>


# Delete a pending payment-control import
Source: https://docs.tic.io/api-lens/paymentcontrolimport/delete-a-pending-payment-control-import

delete /payment-controls/imports/{id}
Removes an upload that has not yet been processed. Only imports in `Submitted` status are eligible — once processing has started, deletion must go through a different flow.

<Badge>Enterprise+ tier</Badge>


# Download the original uploaded XML
Source: https://docs.tic.io/api-lens/paymentcontrolimport/download-the-original-uploaded-xml

get /payment-controls/imports/{id}/download
Streams the bytes that were uploaded, preserving original filename and content type. Useful for audit and re-processing.

<Badge>Enterprise+ tier</Badge>


# Get a single payment-control import
Source: https://docs.tic.io/api-lens/paymentcontrolimport/get-a-single-payment-control-import

get /payment-controls/imports/{id}
Returns the details for one upload, including any per-row warnings produced during parsing.

<Badge>Enterprise+ tier</Badge>


# List payment-control imports for the team (AG Grid)
Source: https://docs.tic.io/api-lens/paymentcontrolimport/list-payment-control-imports-for-the-team-ag-grid

post /payment-controls/imports
Returns a paginated AG Grid view of ISO 20022 (pain.001) uploads for the caller's team. The request body follows the AG Grid server-side row model (filter/sort/pagination). Each row carries import status, aggregate counts (total intents, imported, warnings) and the id of the parsed `TeamPaymentControl` once processing has produced one.

<Badge>Enterprise+ tier</Badge>


# Queue uploaded payment-control imports for processing
Source: https://docs.tic.io/api-lens/paymentcontrolimport/queue-uploaded-payment-control-imports-for-processing

post /payment-controls/imports/process
Publishes a RabbitMQ command for each import that is still in `Submitted` status. Status delivery on completion has two mutually exclusive modes:

1. **SignalR (default for the Lens UI):** supply `correlationId`. The import service posts a callback to the internal Lens webhook, which broadcasts to the caller via the `LensPaymentControlImportStatus` event.

2. **Webhook (for API integrators):** supply `webhookUrl` (HTTPS recommended) and an optional `webhookSecret`. The import service POSTs a signed JSON envelope (`PaymentControlImportStatus_Request` shape) to your URL on terminal status. Verify `X-TIC-Signature` (HMAC-SHA256 of the body with your secret).

Imports already past Submitted are silently skipped. When both modes are supplied, `webhookUrl` wins and no SignalR broadcast occurs for that import.

<Badge>Enterprise+ tier</Badge>


# Upload ISO 20022 pain.001 files
Source: https://docs.tic.io/api-lens/paymentcontrolimport/upload-iso-20022-pain001-files

post /payment-controls/imports/upload
Accepts one or more multipart files. Each file must have content type `text/xml` and declare the ISO 20022 pain.001 namespace. Files are deduplicated by SHA256 within the team. Successfully accepted files are stored and become callable via the process endpoint. Per-file errors are returned in the response body rather than as a 4xx — partial success is normal.

<Badge>Enterprise+ tier</Badge>


# Export person's beneficial-owner holdings as CSV
Source: https://docs.tic.io/api-lens/persons/export-persons-beneficial-owner-holdings-as-csv

get /persons/{id}/beneficial-owners/export
Returns a CSV of every company where this person is a registered beneficial owner. The response is UTF-8 CSV with a `Content-Disposition` header.

<Badge>Enterprise+ tier</Badge>


# Export person's companies as CSV
Source: https://docs.tic.io/api-lens/persons/export-persons-companies-as-csv

get /persons/{id}/companies/export
Returns a CSV of every company where this person holds or held a role. The response is UTF-8 CSV with a `Content-Disposition` header.

<Badge>Enterprise+ tier</Badge>


# Get addresses for a person
Source: https://docs.tic.io/api-lens/persons/get-addresses-for-a-person

get /persons/{id}/addresses
Returns all known addresses linked to the person. For max/enterprise/government tiers each address is enriched with active AddressIntelligence signals.

<Badge>Enterprise+ tier</Badge>


# Get ownership/role graph for a person
Source: https://docs.tic.io/api-lens/persons/get-ownershiprole-graph-for-a-person

get /persons/{id}/graph
Returns a progressive ORB (Ownership, Roles, Beneficial owners) graph centred on the person. Optionally includes beneficial-owner edges and caps the number of companies per role expansion.

<Badge>Enterprise+ tier</Badge>


# Get person details
Source: https://docs.tic.io/api-lens/persons/get-person-details

get /persons/{id}
Returns rich details for a Swedish natural person, including SPAR-based population-register facts, historical identity numbers, events, address intelligence (max/enterprise/government tiers only) and any non-Swedish beneficial-owner citizenship.

<Badge>Max+ tier</Badge>


# Get persons vehicles
Source: https://docs.tic.io/api-lens/persons/get-persons-vehicles

get /persons/{id}/vehicles

<Badge>Max+ tier</Badge>


# List companies where a person has a role (AG Grid)
Source: https://docs.tic.io/api-lens/persons/list-companies-where-a-person-has-a-role-ag-grid

post /persons/{id}/companies
Returns a paginated list of companies where this person holds (or held) a role — board member, CEO, auditor, etc. The request body follows the AG Grid server-side row model.

<Badge>Pro+ tier</Badge>


# List companies where a person is a beneficial owner (AG Grid)
Source: https://docs.tic.io/api-lens/persons/list-companies-where-a-person-is-a-beneficial-owner-ag-grid

post /persons/{id}/beneficial-owners
Returns a paginated list of companies where this person is a registered beneficial owner, with the effective extent, govern codes, and any intermediary company in the ownership chain. Rows are aggregated per target company + extent + period. The request body follows the AG Grid server-side row model.

<Badge>Enterprise+ tier</Badge>


# Order a PEP,sanction and adverse media screening
Source: https://docs.tic.io/api-lens/persons/order-a-pepsanction-and-adverse-media-screening

post /persons/{id}/order-trapets-screening
Places an order with Trapets for PEP, sanction and adverse media screening the person. Returns an `OrderConfirmation_Dto` with the DocumentOrderGuid so the caller can poll order status.

<Badge>Enterprise+ tier</Badge>


# Export companies on a property as CSV
Source: https://docs.tic.io/api-lens/properties/export-companies-on-a-property-as-csv

post /properties/se/{externalId}/companies/export
Returns a CSV of every company registered at an address on this property (by Lantmäteriet UUID). The response is UTF-8 CSV with a `Content-Disposition` header.

<Badge>Enterprise+ tier</Badge>


# Export workplaces on a property as CSV
Source: https://docs.tic.io/api-lens/properties/export-workplaces-on-a-property-as-csv

post /properties/se/{externalId}/workplaces/export
Returns a CSV of every workplace (arbetsställe) located on this property (by Lantmäteriet UUID). The response is UTF-8 CSV with a `Content-Disposition` header.

<Badge>Enterprise+ tier</Badge>


# Get Boverket energy declarations for a property
Source: https://docs.tic.io/api-lens/properties/get-boverket-energy-declarations-for-a-property

get /properties/se/{externalId}/energy-declarations
Returns the energy declarations (energideklarationer) Boverket holds for the property identified by its Lantmäteriet `fastighet` UUID. The kommun and fastighetsbeteckning are resolved from the cadastral record and sent to Boverket's public API. Results are cached locally for 30 days; pass `refresh=true` to force a live re-fetch.

<Badge>Pro+ tier</Badge>


# Get Lantmäteriet property summary by UUID
Source: https://docs.tic.io/api-lens/properties/get-lantmäteriet-property-summary-by-uuid

get /properties/se/{externalId}/summary
Returns only the Lantmäteriet `fastighet` snapshot for the given UUID (no internal Ormeo wrapper). Use this when you only need upstream Lantmäteriet data.

<Badge>Pro+ tier</Badge>


# Get property by easting and northing (SWEREF99 TM)
Source: https://docs.tic.io/api-lens/properties/get-property-by-easting-and-northing-sweref99-tm

get /properties/by-location-sweref99
Gets the property (fastighet) containing the given SWEREF99 TM position (SRID 3006).

<Badge>Pro+ tier</Badge>


# Get property by internal ID
Source: https://docs.tic.io/api-lens/properties/get-property-by-internal-id

get /properties/{id}
Returns property core details enriched with a Lantmäteriet `fastighet` snapshot. Depth of the Lantmäteriet payload scales with the team's tier — max/enterprise/government receive the full payload; pro receives a slimmer view. Historical owner and `fång` data is omitted — use `/ownership-timeline` instead.

<Badge>Pro+ tier</Badge>


# Get property by latitude and longitude (WGS84)
Source: https://docs.tic.io/api-lens/properties/get-property-by-latitude-and-longitude-wgs84

get /properties/by-location
Gets the property (fastighet) containing the given WGS84 position.

<Badge>Pro+ tier</Badge>


# Get property by Swedish Lantmäteriet UUID
Source: https://docs.tic.io/api-lens/properties/get-property-by-swedish-lantmäteriet-uuid

get /properties/se/{externalId}
Looks up a property by its Lantmäteriet `fastighet` UUID and returns core details plus the Lantmäteriet snapshot. If a matching internal property row exists, its metadata is merged into the response.

<Badge>Pro+ tier</Badge>


# List companies registered on a property (AG Grid)
Source: https://docs.tic.io/api-lens/properties/list-companies-registered-on-a-property-ag-grid

post /properties/se/{externalId}/companies
Returns a paginated list of companies whose registered addresses fall on this property (by Lantmäteriet UUID). The request body follows the AG Grid server-side row model.

<Badge>Enterprise+ tier</Badge>


# List workplaces on a property (AG Grid)
Source: https://docs.tic.io/api-lens/properties/list-workplaces-on-a-property-ag-grid

post /properties/se/{externalId}/workplaces
Returns a paginated list of company workplaces (arbetsställen) located on this property (by Lantmäteriet UUID). The request body follows the AG Grid server-side row model.

<Badge>Enterprise+ tier</Badge>


# Search companies (GET)
Source: https://docs.tic.io/api-lens/publicsearch/search-companies-get

get /search-public/companies
Proxies a search to the Typesense `companies` collection using standard query-string parameters (`q`, `query_by`, `filter_by`, `sort_by`, `per_page`, `page`). `per_page` is capped at 50. Pro tier: certain legal entity types and ceased companies are filtered out server-side. Max/Enterprise: unfiltered.

<Badge>Pro+ tier</Badge>


# Search companies (POST)
Source: https://docs.tic.io/api-lens/publicsearch/search-companies-post

post /search-public/companies
Multi-search body equivalent of the GET endpoint. Proxies to the Typesense `companies` collection. `per_page` is capped at 50. Pro tier: certain legal entity types and ceased companies are filtered out server-side. Max/Enterprise: unfiltered.

<Badge>Pro+ tier</Badge>


# Search persons (GET)
Source: https://docs.tic.io/api-lens/publicsearch/search-persons-get

get /search-public/persons
Proxies a search to the Typesense `person` collection using standard query-string parameters. `per_page` is capped at 2 on this endpoint.

<Badge>Enterprise+ tier</Badge>


# Search persons (POST)
Source: https://docs.tic.io/api-lens/publicsearch/search-persons-post

post /search-public/persons
Multi-search body equivalent of the GET endpoint. Proxies to the Typesense `person` collection. `per_page` is capped at 5 on this endpoint.

<Badge>Enterprise+ tier</Badge>


# Search Swedish annual reports (GET)
Source: https://docs.tic.io/api-lens/publicsearch/search-swedish-annual-reports-get

get /search-public/reports
Proxies a search to the Typesense `reports_se` collection using standard query-string parameters. `per_page` is capped at 50.

<Badge>Enterprise+ tier</Badge>


# Search Swedish annual reports (POST)
Source: https://docs.tic.io/api-lens/publicsearch/search-swedish-annual-reports-post

post /search-public/reports
Multi-search body equivalent of the GET endpoint. Proxies to the Typesense `reports_se` collection. `per_page` is capped at 50.

<Badge>Enterprise+ tier</Badge>


# Search Swedish company bankruptcies (GET)
Source: https://docs.tic.io/api-lens/publicsearch/search-swedish-company-bankruptcies-get

get /search-public/bankruptcies
Proxies a search to the Typesense `bankruptcies_se` collection using standard query-string parameters. `per_page` is capped at 50.

<Badge>Max+ tier</Badge>


# Search Swedish company bankruptcies (POST)
Source: https://docs.tic.io/api-lens/publicsearch/search-swedish-company-bankruptcies-post

post /search-public/bankruptcies
Multi-search body equivalent of the GET endpoint. Proxies to the Typesense `bankruptcies_se` collection. `per_page` is capped at 50.

<Badge>Max+ tier</Badge>


# Search Swedish properties (GET)
Source: https://docs.tic.io/api-lens/publicsearch/search-swedish-properties-get

get /search-public/properties
Proxies a search to the Typesense `properties_se` collection using standard query-string parameters. `per_page` is capped at 50.

<Badge>Max+ tier</Badge>


# Search Swedish properties (POST)
Source: https://docs.tic.io/api-lens/publicsearch/search-swedish-properties-post

post /search-public/properties
Multi-search body equivalent of the GET endpoint. Proxies to the Typesense `properties_se` collection. `per_page` is capped at 50.

<Badge>Max+ tier</Badge>


# Search vehicles (GET)
Source: https://docs.tic.io/api-lens/publicsearch/search-vehicles-get

get /search-public/vehicles
Proxies a search to the Typesense `transportstyrelsen` collection using standard query-string parameters. `per_page` is capped at 50.

<Badge>Pro+ tier</Badge>


# Search vehicles (POST)
Source: https://docs.tic.io/api-lens/publicsearch/search-vehicles-post

post /search-public/vehicles
Multi-search body equivalent of the GET endpoint. Proxies to the Typesense `transportstyrelsen` collection. `per_page` is capped at 50.

<Badge>Pro+ tier</Badge>


# Search workplaces (GET)
Source: https://docs.tic.io/api-lens/publicsearch/search-workplaces-get

get /search-public/workplaces
Proxies a search to the Typesense `workplaces` collection using standard query-string parameters. `per_page` is capped at 50.

<Badge>Max+ tier</Badge>


# Search workplaces (POST)
Source: https://docs.tic.io/api-lens/publicsearch/search-workplaces-post

post /search-public/workplaces
Multi-search body equivalent of the GET endpoint. Proxies to the Typesense `workplaces` collection. `per_page` is capped at 50.

<Badge>Max+ tier</Badge>


# Rate Limits
Source: https://docs.tic.io/api-lens/rate-limits

LENS API rate limits - sliding-window counters at both the IP and API-key level. Per-minute and per-month quotas, with response headers for proactive throttling.

The API enforces rate limits at two levels: **per IP address** (all requests) and **per API key** (authenticated requests). Both use a sliding-window counter backed by Redis.

## IP-based rate limiting

Every request is rate-limited by source IP, regardless of authentication.

| Scope      | Limit           |
| ---------- | --------------- |
| Per minute | 600 requests    |
| Per day    | 15,000 requests |

These limits apply per IP address. If multiple API keys share the same IP (e.g. corporate NAT), they share this budget.

## API key rate limiting

Authenticated requests are additionally rate-limited per API key. These limits are configured per key and depend on your plan.

| Scope      | Default        | Description                                     |
| ---------- | -------------- | ----------------------------------------------- |
| Per minute | 60 requests    | Sliding 60-second window                        |
| Per month  | 3,000 requests | Resets monthly                                  |
| Unique IPs | 20             | Maximum distinct IP addresses per key per month |

Your actual limits may differ from the defaults above depending on your plan.

## Response headers

Every response includes rate-limit headers so you can track your usage:

| Header                         | Description                              |
| ------------------------------ | ---------------------------------------- |
| `X-RateLimit-Limit`            | Total requests allowed for the period    |
| `X-RateLimit-Remaining`        | Requests remaining in the period         |
| `X-RateLimit-Reset`            | Seconds until the period counter resets  |
| `X-RateLimit-Limit-Minute`     | Requests allowed per minute              |
| `X-RateLimit-Remaining-Minute` | Requests remaining in the current minute |
| `X-RateLimit-Limit-IP`         | Maximum unique IPs allowed for the key   |
| `X-RateLimit-Remaining-IP`     | Unique IPs remaining                     |

## Error responses

When a rate limit is exceeded, the API returns `429 Too Many Requests` with a JSON body:

```json theme={null}
{
  "error": "rate_limit_exceeded",
  "message": "Too many requests per minute. Check X-RateLimit-Limit-Minute and X-RateLimit-Remaining-Minute headers.",
  "retry_after_seconds": 60
}
```

The `Retry-After` header is also set, indicating how many seconds to wait before retrying.

### Possible rate-limit errors

| Cause                     | Message hint                                    | Retry after                |
| ------------------------- | ----------------------------------------------- | -------------------------- |
| Per-minute limit exceeded | `Too many requests per minute`                  | 60 seconds                 |
| Monthly limit exceeded    | `Monthly request limit exceeded`                | Seconds until period reset |
| Too many unique IPs       | `Too many requests from different IP addresses` | Seconds until period reset |

## Best practices

Monitor `X-RateLimit-Remaining` and `X-RateLimit-Remaining-Minute` headers to proactively throttle before hitting limits.

* **Use exponential backoff** - when you receive a `429`, wait for the `Retry-After` duration before retrying.
* **Consolidate IPs** - if you run distributed workers, be aware of the unique IP limit per key.
* **Use POST multi-search** - combine multiple queries into a single request where possible.


# Screening
Source: https://docs.tic.io/api-lens/screening/introduction

PEP, sanctions and adverse media screening through the LENS API - screen people and organisations by name and identity number, and understand how matching and hit ratings work.

<Badge>Enterprise+ tier</Badge>

Screening checks people and organisations against politically exposed person (PEP) lists, sanctions lists and adverse media, in a single call, without first creating them as person or company records in the platform. You supply a name and/or an identity number for each subject and get back the list entries that matched, with enough data on each hit to decide whether it is the same person or organisation.

|                   |                                                                                        |
| ----------------- | -------------------------------------------------------------------------------------- |
| Endpoint          | [`POST /screening/search`](/api-lens/screening/search)                                 |
| Authentication    | `x-api-key` header, see [Authentication](/api-lens/authentication)                     |
| Subjects per call | 1 to 50                                                                                |
| Billing           | Every call places an order. [Test mode](/api-lens/screening/test-mode) calls are free. |

These pages cover what the endpoint reference cannot: [how matching works](#how-matching-works), [what a result contains](/api-lens/screening/results), [which lists are screened](/api-lens/screening/lists), and [how to test](/api-lens/screening/test-mode).

## Quick start

```bash theme={null}
curl -X POST https://lens-api.tic.io/screening/search \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "testMode": true,
    "subjects": [
      { "reference": "cust-1001", "name": "Anna Exempelsson", "birthDate": "1975-04-12", "countries": ["SWE"] },
      { "reference": "cust-1002", "identityNumber": "5560000000" }
    ]
  }'
```

The response contains one entry per subject under `results`, each with its own list of `hits`. A subject with no hits is still returned, with `hitCount` 0. See [Results](/api-lens/screening/results) for the full data model and an example response.

## Request essentials

The full request schema is on the [endpoint page](/api-lens/screening/search). The properties that shape the outcome are:

| Property                    | Description                                                                                                                                                                                            |
| --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `subjects[].name`           | The name to match. At most 8 name parts. Required unless `identityNumber` is set.                                                                                                                      |
| `subjects[].identityNumber` | Personnummer or samordningsnummer (10 or 12 digits) for a person, organisationsnummer (10 digits) for an organisation. Matched exactly. Required unless `name` is set.                                 |
| `subjects[].birthDate`      | `yyyy-MM-dd`, `yyyy-MM` or `yyyy`. Filters hits by birth date.                                                                                                                                         |
| `subjects[].countries`      | ISO 3166-1 alpha-3 codes, for example `["SWE", "NOR"]`. Filters hits by country.                                                                                                                       |
| `subjects[].reference`      | Your own reference, echoed back on the result and used in warning and error messages.                                                                                                                  |
| `serviceScope`              | Which lists to screen: a group (`SANCTION`, `PEP`, `INFO`), a single list name, or a comma-separated combination. Omit for every list enabled on your account. See [Lists](/api-lens/screening/lists). |
| `nameMatching`              | `Regular` (default) or `Phonetic`.                                                                                                                                                                     |
| `minimumNameMatchScore`     | 0.6 to 0.99. Required with phonetic matching, ignored otherwise.                                                                                                                                       |
| `fuzzyBirthDateMatching`    | Accept near matches on the birth date.                                                                                                                                                                 |
| `testMode`                  | Run against the test environment. See [Test mode](/api-lens/screening/test-mode).                                                                                                                      |

## How matching works

Understanding the matching rules is the key to useful results and few false positives.

**Name or identity number.** A subject with both a `name` and an `identityNumber` returns entries that match either one, not only entries that match both. An exact match on the identity number is the strongest possible match and outranks everything else.

**Identity number.** Matched exactly against the identifiers registered on the list entry. Some PEP list entries carry a country prefix on the identity number, for example `SE198202029878`. A prefix is not required to get an exact match, but if you include one you will only be matched against entries with the same prefix. Use a prefix only when screening specifically against the `PEP_Edge` list.

**Birth date.** Supplying `birthDate` filters out entries whose birth date does not match. Entries with no known birth date are always returned, since they cannot be ruled out. Use `fuzzyBirthDateMatching` to accept near matches.

**Countries.** Supplying `countries` filters out entries registered to other countries. Entries with no country data at all are always returned. Country data on PEP lists is generally reliable, country data on sanctions lists less so, so a country filter cuts false positives but can also exclude a true hit whose list entry has poor country data.

**Regular versus phonetic name matching.** Regular matching compares the name against the exact aliases stored on each entry. Phonetic matching also matches names that sound alike and is the right choice when spelling is uncertain, for example transliterated names. It must be combined with `minimumNameMatchScore`, and a low score combined with phonetic matching produces a very large number of hits. Start at 0.85 and adjust.

### Hit rating

Every hit has a `hitRating` from 1 to 5 that states what the entry matched on. The higher the rating, the more certain the match.

| `hitRating` | Person matched on   | Organisation matched on |
| ----------- | ------------------- | ----------------------- |
| 5           | Identity number     | Organisation number     |
| 4           | Name and birth date | not used                |
| 2           | Name and country    | Name and country        |
| 1           | Name only           | Name only               |

A rating of 1 means only the name matched. Whether that is the same person needs to be established from the other data on the hit: birth date, countries, roles and aliases.

### Name match score

`nameMatchScore` is a value between 0 and 1 that states how closely the subject's name matched the best alias on the entry, where 1.0 is an exact match. It is only populated when `minimumNameMatchScore` was set on the request.

## Recommendations

* **Screen in batches.** Up to 50 subjects can be screened in one call. When screening a customer base, fill each call rather than sending one subject per call.
* **Always send a `reference`.** It is the only reliable way to pair results with subjects when you screen several at once, and it is what warning and error messages refer to.
* **Prefer identity numbers.** An identity number gives a `hitRating` of 5 and removes name ambiguity entirely. Send the name as well when you have it, since some lists lack identity numbers.
* **Narrow with birth date and countries.** They remove most false positives on common names. Remember that entries lacking that data still match.
* **Treat rating 1 hits as candidates, not confirmations.** Use the birth date, countries, aliases and roles on the hit to decide.
* **Keep the phonetic threshold high.** Start at 0.85 and lower it only if true hits are being missed.
* **Check `errors` and `servicesQueried`.** A subject that was not screened, or a list that was not queried, looks like a clean result if you only count hits.
* **Store `externalId`.** It identifies a list entry over time, which lets you tell a new hit from one you have already reviewed.


# Screening lists
Source: https://docs.tic.io/api-lens/screening/lists

The sanctions, PEP and information lists a LENS API screening runs against, how they are grouped, and how to restrict a screening with serviceScope.

Screening runs against the lists enabled for your account. `summary.servicesQueried` in every response shows exactly which lists were used. Use the same spelling when restricting a call with `serviceScope`.

`serviceScope` accepts a list group, a single list name, or a comma-separated combination:

```json theme={null}
{ "serviceScope": "SANCTION" }
{ "serviceScope": "PEP_Edge" }
{ "serviceScope": "SANCTION, PEP_Edge" }
```

Each list belongs to one of three groups, returned as `listType` on every hit.

## SANCTION

Sanctions designations by governments and international bodies, plus consolidated commercial compilations.

| List name              | Content                                                                                                                                                                             |
| ---------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `EU_GLOBAL`            | European Union consolidated list of persons, groups and entities subject to EU financial sanctions, maintained by the European Commission.                                          |
| `Instant_EU_Sanctions` | The same EU designations taken directly from the Official Journal, available without the delay of the consolidated list.                                                            |
| `UN_CONSOLIDATED`      | United Nations Security Council consolidated sanctions list.                                                                                                                        |
| `OFAC`                 | US Treasury Specially Designated Nationals (SDN) list.                                                                                                                              |
| `OFAC_CS`              | US Treasury consolidated non-SDN sanctions lists. OFAC screening normally includes both `OFAC` and `OFAC_CS`.                                                                       |
| `UK_Sanction`          | The UK Sanctions List published by the Foreign, Commonwealth and Development Office. From 28 January 2026 the only source of UK designations.                                       |
| `HMTreasury`           | UK OFSI consolidated list of asset freeze targets. Being retired in favour of `UK_Sanction`.                                                                                        |
| `Swiss`                | Swiss sanctions list.                                                                                                                                                               |
| `Finnish_CKP`          | Finnish police list of frozen assets.                                                                                                                                               |
| `BelgianFPSF`          | Belgian national financial sanctions list.                                                                                                                                          |
| `NetherlandsNTS`       | Netherlands national terrorism sanctions list.                                                                                                                                      |
| `Acuris_Sanction`      | Curated consolidated compilation of sanctions lists from around the world.                                                                                                          |
| `DowJones SCO`         | Companies owned or controlled by parties sanctioned by the US, EU or UK, which are sanctioned by extension under ownership and control rules.                                       |
| `FSA_Warnings`         | Warning lists from financial supervisory authorities about firms operating without authorisation. A warning list rather than a sanctions list, grouped here for screening purposes. |

## PEP

Politically exposed persons, their family members and close associates. Hits carry `roles`, and often `relationships` and `tier`.

| List name                     | Content                                                                                                                               |
| ----------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
| `PEP_Edge`                    | Nordic PEP list with identity numbers. Entries may carry a country prefix on the identity number, such as `SE` followed by 12 digits. |
| `Acuris_PEP`, `Acuris_PEP_NN` | Global PEP database with seniority tiers. The `NN` variant covers non-Nordic persons.                                                 |
| `DowJonesPEP`, `Dow_Jones`    | Global PEP list and a filtered variant of it.                                                                                         |

## INFO

Company registers and adverse media. Hits from these lists describe ownership and representation or reputational risk rather than a designation.

| List name                                      | Content                                                              |
| ---------------------------------------------- | -------------------------------------------------------------------- |
| `OwnAndRep`, `CompanyInfo_SE`                  | Owners and representatives of Swedish companies.                     |
| `BVBeneficialOwners`                           | The Swedish beneficial ownership register at Bolagsverket.           |
| `OwnAndRep_NO`                                 | Owners and representatives of Norwegian companies.                   |
| `OwnAndRep_FI`, `OwnAndRep_FIBO`               | Owners and representatives, and company data, for Finnish companies. |
| `CompanyInfo_DK`                               | Owners and representatives of Danish companies.                      |
| `UKCompaniesHouse`                             | UK Companies House register.                                         |
| `ION_AdverseMedia_RRE`, `ION_AdverseMedia_REL` | Adverse media coverage of persons and organisations.                 |

<Note>
  Customer-specific lists can be added to an account and appear under whichever group they are configured as. Contact [support](mailto:support@tic.io) to have a list enabled or added.
</Note>


# Screening results
Source: https://docs.tic.io/api-lens/screening/results

The data model of a LENS API screening result - subjects, hits, roles, relationships, hit ratings, warnings and errors, with reference values for role types, legal forms and operational status.

A screening response has one entry per subject, and each entry carries the list entries that matched it. This page describes every property so hits can be interpreted correctly. Property names are camelCase and properties with a `null` value are omitted.

## Top level

| Property         | Type                   | Description                                                                                                 |
| ---------------- | ---------------------- | ----------------------------------------------------------------------------------------------------------- |
| `requestedAtUtc` | date-time              | When the screening was performed.                                                                           |
| `source`         | string                 | Fixed identifier of the list data source.                                                                   |
| `testMode`       | boolean                | `true` when the screening ran against the test environment. See [Test mode](/api-lens/screening/test-mode). |
| `order`          | Order                  | The order this screening was placed as.                                                                     |
| `summary`        | Summary                | Counts and the lists that were actually screened.                                                           |
| `results`        | array of SubjectResult | One entry per subject, in the order submitted.                                                              |
| `warnings`       | array of string        | Warnings from the list provider, if any. Absent when there are none.                                        |
| `errors`         | array of string        | Errors from the list provider for individual subjects, if any. Absent when there are none.                  |

### Order

| Property            | Type      | Description                                                                                                                  |
| ------------------- | --------- | ---------------------------------------------------------------------------------------------------------------------------- |
| `documentOrderGuid` | guid      | Use this to look the screening up again through the [orders API](/api-lens/orders/get-metadata-for-a-single-document-order). |
| `orderedAtUtc`      | date-time | When the order was placed.                                                                                                   |
| `price`             | number    | Price of the screening according to your agreement. `0` in test mode.                                                        |
| `currency`          | string    | Always `SEK`.                                                                                                                |

### Summary

| Property             | Type            | Description                                                                                                                                             |
| -------------------- | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `subjectCount`       | integer         | Number of subjects in the request.                                                                                                                      |
| `individualHitCount` | integer         | Number of person entries returned across all subjects.                                                                                                  |
| `entityHitCount`     | integer         | Number of organisation entries returned across all subjects.                                                                                            |
| `totalHitCount`      | integer         | `individualHitCount` plus `entityHitCount`.                                                                                                             |
| `servicesQueried`    | array of string | The lists that were screened against. Compare this with what you expect; a misspelled `serviceScope` or a list missing from your account shows up here. |

### SubjectResult

| Property         | Type         | Description                                             |
| ---------------- | ------------ | ------------------------------------------------------- |
| `reference`      | string       | The `reference` you supplied for the subject.           |
| `name`           | string       | The `name` you supplied.                                |
| `identityNumber` | string       | The `identityNumber` you supplied.                      |
| `hitCount`       | integer      | Number of hits for this subject.                        |
| `hits`           | array of Hit | The matching list entries, strongest `hitRating` first. |

## Hit

One list entry that matched a subject. A person entry and an organisation entry share the same shape; properties that only apply to one of them are marked.

| Property               | Type                  | Description                                                                                                                                                                                                                                                                                            |
| ---------------------- | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `type`                 | string                | `individual` for a person, `entity` for an organisation.                                                                                                                                                                                                                                               |
| `name`                 | string                | The name of the list entry.                                                                                                                                                                                                                                                                            |
| `identityNumber`       | string                | Personnummer of a person or organisationsnummer of an organisation, when the list holds one. Always absent when `isProtectedIdentity` is true.                                                                                                                                                         |
| `birthDate`            | string                | Person only. `yyyy-MM-dd`, `yyyy-MM` or `yyyy`. If the list reports more than one birth date this is a comma-separated list, for example `1957-01-01, 1956-12-31`. If the source only has an approximate year, such as "circa 1966", the list holds every year in a span of plus or minus three years. |
| `hitRating`            | integer               | What the entry matched on, 1 to 5. See [Hit rating](/api-lens/screening/introduction#hit-rating).                                                                                                                                                                                                      |
| `hitRatingDescription` | string                | The hit rating in words, in Swedish.                                                                                                                                                                                                                                                                   |
| `nameMatchScore`       | number                | Name similarity between 0 and 1. Only present when `minimumNameMatchScore` was set.                                                                                                                                                                                                                    |
| `listType`             | string                | The group the list belongs to: `SANCTION`, `PEP` or `INFO`.                                                                                                                                                                                                                                            |
| `listItemDataType`     | string                | `Individual` or `Entity`, as reported by the list.                                                                                                                                                                                                                                                     |
| `sourceName`           | string                | The list that produced the hit, for example `EU_GLOBAL`. See [Lists](/api-lens/screening/lists).                                                                                                                                                                                                       |
| `externalId`           | string                | The list's own identifier for the entry. Stable across screenings and useful for de-duplicating hits over time.                                                                                                                                                                                        |
| `lastUpdatedUtc`       | date-time             | When the entry was last updated on the list.                                                                                                                                                                                                                                                           |
| `tier`                 | integer               | Person only. PEP seniority tier where 1 is the most senior. Only populated by the global PEP list.                                                                                                                                                                                                     |
| `isProtectedIdentity`  | boolean               | Person only. The person has a protected identity. The identity number is then never returned.                                                                                                                                                                                                          |
| `isMale`               | boolean               | Person only. Absent when the sex is not known.                                                                                                                                                                                                                                                         |
| `title`                | string                | Person only. Title of the person.                                                                                                                                                                                                                                                                      |
| `comment`              | string                | Free-text comment from the list, when there is one.                                                                                                                                                                                                                                                    |
| `legalForm`            | string                | Organisation only. See [Legal forms](#legal-forms).                                                                                                                                                                                                                                                    |
| `operationalStatus`    | string                | Organisation only. See [Operational status](#operational-status).                                                                                                                                                                                                                                      |
| `countries`            | array of string       | Every country registered to the entry, as ISO 3166-1 alpha-3 codes. Includes citizenship, residence, jurisdiction and registration countries, and countries taken from roles and addresses.                                                                                                            |
| `citizenships`         | array of string       | Person only. The subset of `countries` registered as citizenships.                                                                                                                                                                                                                                     |
| `aliases`              | array of string       | Every name the entry is known by. For organisations this is usually just the name.                                                                                                                                                                                                                     |
| `externalUrls`         | array of string       | Links to source documents, when the list provides them.                                                                                                                                                                                                                                                |
| `roles`                | array of Role         | Person only. Political or public roles. This is what makes a person a PEP.                                                                                                                                                                                                                             |
| `engagements`          | array of Engagement   | Reserved for company engagements such as board positions and ownership. Not populated by the lists today.                                                                                                                                                                                              |
| `relationships`        | array of Relationship | Family members and close associates, mainly on PEP entries.                                                                                                                                                                                                                                            |

### Role

A public or political function held by a person. Present on PEP entries.

| Property              | Type   | Description                                                                                                        |
| --------------------- | ------ | ------------------------------------------------------------------------------------------------------------------ |
| `roleType`            | string | Category of the role. See [Role types](#role-types).                                                               |
| `roleTypeDescription` | string | The role type in words, in Swedish.                                                                                |
| `title`               | string | Title of the role, for example the position held.                                                                  |
| `organization`        | string | The organisation the role belongs to, when known.                                                                  |
| `countryCode`         | string | ISO 3166-1 alpha-3 country the role applies to. Usually absent, since the relevant country is on the entry itself. |
| `from`                | string | Date the role became active, as `yyyyMMdd`.                                                                        |
| `to`                  | string | Date the role ended, as `yyyyMMdd`. Absent while the role is active.                                               |
| `comment`             | string | Description of the role.                                                                                           |

### Relationship

A connection between the list entry and another person or organisation.

| Property           | Type   | Description                                                                                          |
| ------------------ | ------ | ---------------------------------------------------------------------------------------------------- |
| `name`             | string | Name of the related person or organisation.                                                          |
| `relationshipType` | string | `Child`, `ChildsSpouse`, `CloseAssociate`, `FamilyMember`, `Parent`, `Sibling`, `Spouse` or `Other`. |
| `title`            | string | The nature of the connection.                                                                        |
| `comment`          | string | Description of the relationship.                                                                     |

### Engagement

Reserved for a role or ownership in a company. The lists do not populate this data today, so the array is empty or absent.

| Property         | Type      | Description                                            |
| ---------------- | --------- | ------------------------------------------------------ |
| `engagementType` | string    | See [Engagement types](#engagement-types).             |
| `name`           | string    | Name of the engagement holder.                         |
| `corporateId`    | string    | Organisation number of the company.                    |
| `ownershipStake` | number    | Ownership share in percent, for ownership engagements. |
| `from`           | date-time | Date the engagement was registered.                    |
| `to`             | date-time | Date the engagement ended, if it is no longer active.  |

## Example response

Two subjects were screened. The first produced one PEP hit, the second produced nothing.

```json theme={null}
{
  "requestedAtUtc": "2026-09-03T09:14:22.318Z",
  "testMode": false,
  "order": {
    "documentOrderGuid": "3f1c9b2e-7d44-4a1b-9c0e-2b6f0a8d5e71",
    "orderedAtUtc": "2026-09-03T09:14:22.301Z",
    "price": 5.00,
    "currency": "SEK"
  },
  "summary": {
    "subjectCount": 2,
    "individualHitCount": 1,
    "entityHitCount": 0,
    "totalHitCount": 1,
    "servicesQueried": ["EU_GLOBAL", "UN_CONSOLIDATED", "OFAC", "PEP_Edge"]
  },
  "results": [
    {
      "reference": "cust-1001",
      "name": "Anna Exempelsson",
      "hitCount": 1,
      "hits": [
        {
          "type": "individual",
          "name": "Anna Exempelsson",
          "birthDate": "1975-04-12",
          "hitRating": 4,
          "hitRatingDescription": "Träff på namn och födelseår eller födelsedatum",
          "listType": "PEP",
          "listItemDataType": "Individual",
          "sourceName": "PEP_Edge",
          "externalId": "SE-113942",
          "lastUpdatedUtc": "2026-08-30T02:15:07",
          "isMale": false,
          "countries": ["SWE"],
          "citizenships": ["SWE"],
          "aliases": ["Anna Exempelsson", "Anna Maria Exempelsson"],
          "roles": [
            {
              "roleType": "NationalLegislature",
              "roleTypeDescription": "Nationalförsamling",
              "title": "Riksdagsledamot",
              "organization": "Sveriges riksdag",
              "from": "20220926"
            }
          ],
          "relationships": [
            {
              "name": "Karl Exempelsson",
              "relationshipType": "Spouse"
            }
          ]
        }
      ]
    },
    {
      "reference": "cust-1002",
      "identityNumber": "5560000000",
      "hitCount": 0,
      "hits": []
    }
  ]
}
```

## Warnings and errors

A `200 OK` response can still carry warnings and errors from the list provider. Both are arrays of strings. Each message starts with the subject's `reference` (or its name or identity number if no reference was given) so it can be tied back to a subject.

* **Warning** - the subject was screened, but part of its data was ignored. An invalid country code such as `SWD` produces a warning and the code is disregarded.
* **Error** - the subject was not screened. The other subjects in the call were.

<Warning>
  Always check `errors` before treating a subject with zero hits as cleared.
</Warning>

### HTTP status codes

| Status                  | Meaning                                                                                                                                         |
| ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
| `200 OK`                | The screening ran. Check `warnings` and `errors`.                                                                                               |
| `400 Bad Request`       | The request failed validation. The `code` property of the problem document is `no_subjects`, `too_many_subjects` or `subject_not_identifiable`. |
| `401 Unauthorized`      | Missing or invalid API key.                                                                                                                     |
| `403 Forbidden`         | The API key's plan does not include screening.                                                                                                  |
| `429 Too Many Requests` | Rate limit exceeded. See [Rate limits](/api-lens/rate-limits).                                                                                  |

## Reference values

### Role types

Values of `roleType` on a Role. `roleTypeDescription` carries the Swedish wording.

| `roleType`            | Description                         |
| --------------------- | ----------------------------------- |
| `Government`          | Government or ministry              |
| `NationalLegislature` | National parliament                 |
| `CivilServant`        | Senior civil servant                |
| `EmbassyAndConsular`  | Diplomatic or consular post         |
| `ArmedForces`         | Armed forces                        |
| `Judiciary`           | Courts and judiciary                |
| `StateCorporation`    | State-owned company                 |
| `StateAgency`         | State agency                        |
| `Political`           | Political office                    |
| `PoliticalParty`      | Political party                     |
| `Organization`        | International or other organisation |
| `Other`               | Other                               |

### Legal forms

Values of `legalForm` on an organisation hit.

`LimitedCompany`, `PrivateBusinessGovCtrl`, `ForeignCompany`, `Bank`, `SoleProprietorship`, `GeneralPartnership`, `Society`, `Foundation`, `HousingCompany`, `StateCountyCompany`, `ReligiousOrganization`, `InsuranceCompany`, `Collaborations`

### Operational status

Values of `operationalStatus` on an organisation hit.

`Active`, `InactiveSleeping`, `UnderLiquidation`, `Liquidated`, `UnderBankruptcy`, `Bankrupt`, `Dissolved`, `Merged`, `Unregistered`, `Unknown`, `Dissolving`, `DissolvingByForce`, `DissolvedByForce`, `UnderReconstruction`, `CompanyDataOutOfDate`

### Engagement types

Values of `engagementType` on an Engagement, for when the lists start populating engagements.

`Accountant`, `AssistantStatistician`, `Associate`, `Bearer`, `BeneficialOwner`, `BoardMember`, `CEO`, `Chairman`, `Commissioner`, `CompanyStructureOwner`, `Deputy`, `DeputyAccountant`, `DeputyBoardMember`, `DeputyCEO`, `DeputyChairman`, `DeputyCommissioner`, `DeputyLaymanAccountant`, `DeputyLiquidator`, `EmployeeRepresentative`, `ExternalCEO`, `ExternalCompanySignatory`, `ExternalDeputyCEO`, `GeneralPartner`, `InsuranceRepresentative`, `KeyPerson`, `LaymanAccountant`, `LiableAccountant`, `LimitedPartner`, `Liquidator`, `Manager`, `ManagingClerk`, `NotificationRecipient`, `NotKnown`, `Owner`, `Procurator`

### Country types

The `countries` array on a hit merges every country registered to the entry. The underlying registrations are typed as `Citizenship`, `Jurisdiction`, `Registration`, `Residential` or `Other`. Only the `Citizenship` type is broken out separately, as `citizenships`.

## Data not returned

The list entries hold more data than the API returns today. The following is available on the underlying entries but not exposed: postal addresses, additional identity documents such as passport numbers, images, the original list an entry was consolidated from, adverse media evidence records, and for organisations the registered owners, representatives, beneficial owners, industry codes, foundation date and signatory rules. Contact [support](mailto:support@tic.io) if your use case needs any of it.


# Search PEP, sanctions and adverse media lists
Source: https://docs.tic.io/api-lens/screening/search

post /screening/search
Screens one or more people or organisations by name and/or identity number, without requiring them to exist as a person or company record. Several subjects can be screened in one call and each is returned separately. Every call places a billable order and returns its DocumentOrderGuid, so the screening can be retrieved again later through the orders API.

<Badge>Enterprise+ tier</Badge>

Screens people and organisations against PEP, sanctions and adverse media lists. Unlike the
screening endpoints on [companies](/api-lens/companies/order-a-pepsanction-and-adverse-media-screening)
and [persons](/api-lens/persons/order-a-pepsanction-and-adverse-media-screening), the subject does
not need to exist as a record in the platform - you supply the name and/or identity number yourself.

The [Screening overview](/api-lens/screening/introduction) explains how matching and hit ratings work,
[Results](/api-lens/screening/results) describes every property of a hit, and
[Lists](/api-lens/screening/lists) covers which lists are screened.

### Subjects

Up to **50 subjects** can be screened in one call. Each is returned separately, in the order it was
submitted, and each needs a name, an identity number, or both.

* `identityNumber` - personnummer or samordningsnummer (10 or 12 digits), or organisationsnummer
  (10 digits). Matched exactly, and a match here outweighs the name.
* `name` - a subject carrying both a name and an identity number matches on **either one**, not both.
* `birthDate` - `yyyy-MM-dd`, `yyyy-MM` or `yyyy`. List entries with no known birth date always
  match, whatever you supply.
* `countries` - ISO 3166-1 alpha-3 codes, e.g. `["SWE", "NOR"]`. Narrowing by country cuts false
  positives, but can also drop true hits where the list entry has poor country data.
* `reference` - your own reference, echoed back on the matching result so you can pair them up.
  Generated for you if omitted.

### Matching

`nameMatching` defaults to `Regular`, which matches exact aliases. `Phonetic` also matches
similar-sounding names - it finds more true hits and considerably more false ones. Phonetic matching
requires `minimumNameMatchScore` (0.6 to 0.99) to trim the tail; a value between 0.75 and 0.9 is
recommended, and the score is ignored for regular matching.

`serviceScope` selects which lists to screen against, for example `SANCTION` or `PEP_Edge`, or a
comma-separated combination. Leave it empty to use every service enabled for your account.

### Test mode

Set `testMode` to `true` to run the screening against the test environment. The response has the
same shape, the order is placed free of charge, and hits come from test data rather than the live
lists. See [Test mode](/api-lens/screening/test-mode).

<Warning>
  **Every live call places a billable order**, including calls that return no hits. The response carries
  `order.documentOrderGuid`, which you can use to retrieve the same screening later through the
  [orders API](/api-lens/orders/get-metadata-for-a-single-document-order).

  Results are not reused between calls - each request screens the lists fresh, so repeating a
  search bills again rather than replaying a recent result.
</Warning>

### Partial failures

A screening can succeed overall while individual subjects fail. `warnings` reports subjects the
supplier ignored, and `errors` reports per-subject failures; the rest of the screening still runs.
Check both before treating a subject as clear.


# Screening test mode
Source: https://docs.tic.io/api-lens/screening/test-mode

Run LENS API screenings against the test environment while developing - same request and response shape, free of charge, with test data instead of the live lists.

Set `"testMode": true` on a [screening request](/api-lens/screening/search) to run it against the test environment instead of the live lists. Use it while developing and testing your integration.

```json theme={null}
{
  "testMode": true,
  "subjects": [
    { "reference": "test-1", "name": "Anna Exempelsson", "birthDate": "1975-04-12" }
  ]
}
```

## What changes in test mode

* The response has exactly the same shape as a live screening, with `testMode` set to `true`.
* The order is placed with `price` `0` and its title is prefixed with `[TEST]`, so test screenings are visible in your order history but never billed.
* Hits come from the test environment's data, not from the real lists. A person who is sanctioned in reality may return no hits in test mode, and test subjects may return hits that do not exist in reality.
* A test screening is never reused for a live call, and a live screening is never returned to a test call.

Everything else, including authentication, validation, feature tier and rate limits, works the same way in both modes.

<Note>
  Contact [support](mailto:support@tic.io) for the test subjects that are known to produce hits in the test environment.
</Note>

<Warning>
  `testMode` defaults to `false`. Make sure it is not left enabled in production code: a test screening returns test data and does not screen the live lists.
</Warning>


# Search
Source: https://docs.tic.io/api-lens/search

Typesense-backed search in LENS - search companies, persons, workplaces, vehicles, properties, bankruptcies, and financial reports with sub-100ms latency.

The TIC LENS search API is built on [Typesense](https://typesense.org), a lightning-fast search engine that stores its index in RAM. This makes it ideal for search-as-you-type, autocomplete, geo-search, and other latency-sensitive applications.

All features described in the [Typesense API (v29)](https://typesense.org/docs/29.0/api/) are available through our proxy endpoints.

## Collections

| Collection        | Endpoint                      | Minimum plan    |
| ----------------- | ----------------------------- | --------------- |
| Companies         | `/search-public/companies`    | **Pro+**        |
| Persons           | `/search-public/persons`      | **Enterprise+** |
| Workplaces        | `/search-public/workplaces`   | **Max+**        |
| Vehicles          | `/search-public/vehicles`     | **Pro+**        |
| Properties        | `/search-public/properties`   | **Max+**        |
| Bankruptcies      | `/search-public/bankruptcies` | **Max+**        |
| Financial reports | `/search-public/reports`      | **Enterprise+** |

## Parameters

| Parameter   | Type   | Description                                                                                                         |
| ----------- | ------ | ------------------------------------------------------------------------------------------------------------------- |
| `q`         | string | The search query. Use `*` to match all documents.                                                                   |
| `query_by`  | string | Comma-separated list of fields to search in.                                                                        |
| `filter_by` | string | Filter expression (see [Typesense filter docs](https://typesense.org/docs/29.0/api/search.html#filter-parameters)). |
| `sort_by`   | string | Comma-separated list of fields to sort by.                                                                          |
| `per_page`  | int    | Number of results per page (max 50; persons max 5).                                                                 |
| `page`      | int    | Page number (1-based).                                                                                              |

POST is recommended for complex queries. GET is convenient for quick lookups and search-as-you-type.

## Search by name

<Tabs>
  <Tab title="GET">
    ```bash theme={null}
    curl -H "x-api-key: YOUR_API_KEY" \
      "https://lens-api.tic.io/search-public/companies?q=Volvo&query_by=names.nameOrIdentifier"
    ```
  </Tab>

  <Tab title="POST">
    ```bash theme={null}
    curl -X POST "https://lens-api.tic.io/search-public/companies" \
      -H "x-api-key: YOUR_API_KEY" \
      -H "Content-Type: application/json" \
      -d '{
        "q": "Volvo",
        "query_by": "names.nameOrIdentifier",
        "per_page": 10,
        "page": 1
      }'
    ```
  </Tab>
</Tabs>

## Search by registration number

<Tabs>
  <Tab title="GET">
    ```bash theme={null}
    curl -H "x-api-key: YOUR_API_KEY" \
      "https://lens-api.tic.io/search-public/companies?q=5565199493&query_by=registrationNumber"
    ```
  </Tab>

  <Tab title="POST">
    ```bash theme={null}
    curl -X POST "https://lens-api.tic.io/search-public/companies" \
      -H "x-api-key: YOUR_API_KEY" \
      -H "Content-Type: application/json" \
      -d '{
        "q": "5565199493",
        "query_by": "registrationNumber",
        "per_page": 5,
        "page": 1
      }'
    ```
  </Tab>
</Tabs>

## Search by phone number (E.164)

```bash theme={null}
curl -H "x-api-key: YOUR_API_KEY" \
  "https://lens-api.tic.io/search-public/companies?q=+46850565800&query_by=phoneNumbers.e164PhoneNumber"
```

## Geo-search within a radius

```bash theme={null}
curl -H "x-api-key: YOUR_API_KEY" \
  "https://lens-api.tic.io/search-public/companies?q=*&query_by=mostRecentRegisteredAddress.streetAddress&filter_by=mostRecentRegisteredAddress.location:(57.6799,12.09162,0.300 km)&sort_by=mostRecentRegisteredAddress.location(57.6799,12.09162):asc"
```

Read more in the [Typesense geo-search docs](https://typesense.org/docs/29.0/api/geosearch.html).

## Filter by companyId

```bash theme={null}
curl -H "x-api-key: YOUR_API_KEY" \
  "https://lens-api.tic.io/search-public/companies?q=*&query_by=registrationNumber&filter_by=companyId:[3508351]"
```

## Search by SNI industry code

```bash theme={null}
curl -H "x-api-key: YOUR_API_KEY" \
  "https://lens-api.tic.io/search-public/companies?q=45111&query_by=sniCodes.sni_2007Code"
```

## Stock-listed companies

```bash theme={null}
curl -H "x-api-key: YOUR_API_KEY" \
  "https://lens-api.tic.io/search-public/companies?q=OMX+Stockholm&query_by=stock.marketExchangeName"
```

## Intelligence records

```bash theme={null}
curl -H "x-api-key: YOUR_API_KEY" \
  "https://lens-api.tic.io/search-public/companies?q=*&query_by=registrationNumber&filter_by=intelligence.companyIntelligenceSubType:['MISSING_AUDITOR']%26%26intelligence.score:>254"
```

## POST with complex filters

POST lets you send structured search requests in JSON with complex filter expressions:

```bash theme={null}
curl -X POST "https://lens-api.tic.io/search-public/companies" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "q": "*",
    "query_by": "registrationNumber",
    "filter_by": "mostRecentFinancialSummary.fn_NumberOfEmployees:>100 && mostRecentRegisteredAddress.city:Stockholm",
    "sort_by": "mostRecentFinancialSummary.rs_NetSalesK:desc",
    "per_page": 20,
    "page": 1
  }'
```

## Pro tier filtering

On the **Pro** plan, company search automatically excludes certain legal entity types and ceased companies. **Max** and **Enterprise** plans have unfiltered access to all records.

## Redacted properties

Depending on your plan, certain properties may be excluded from search results. The response includes a `redacted` array listing the omitted fields:

```json theme={null}
{
  "redacted": ["mostRecentDebtorSummary", "currentBeneficialOwners"]
}
```

## Date handling

All date fields are in **Unix epoch seconds** (seconds since 1970-01-01 00:00:00 UTC). Companies registered before 1970 will have negative values. Typesense only supports Unix timestamps.

## SNI codes - 2007 and 2025

Since December 2024, Statistics Sweden (SCB) has been migrating from SNI 2007 to SNI 2025. We recommend searching on both `sniCodes.sni_2007Code` and `sniCodes.sni_2025Code` during the transition. Search results include both code systems.

## Intelligence types

Intelligence records flag discrepancies found in company data. Each record has a `score` between `0` (informational) and `255` (severe).

When filtering by `intelligence.companyIntelligenceType`, use the numeric value:

| Value | Type                           | Description                               |
| ----- | ------------------------------ | ----------------------------------------- |
| 0     | `CreatedAsShelfCompany`        | Company was created as a shelf company    |
| 1     | `SuspectedForQuickLiquidation` | Suspected quick liquidation               |
| 3     | `AffiliatedWithArticle`        | Affiliated with one or more articles      |
| 5     | `SuspectedAddress`             | Address has been flagged                  |
| 7     | `PresentOnWarningList`         | Present on certain warning lists          |
| 8     | `AnnualReportDiscrepancies`    | Annual report contains discrepancies      |
| 9     | `AuditorResignation`           | Auditor has resigned                      |
| 10    | `Registration`                 | Issues with registration                  |
| 11    | `RegisterChanges`              | Registry change triggered a policy        |
| 12    | `PenaltyFees`                  | Penalized by a fee                        |
| 13    | `BeneficialOwner`              | Issues with beneficial owner registration |
| 14    | `Claims`                       | Claims from government agencies           |

## Intelligence subtypes

Filter by `intelligence.companyIntelligenceSubType` using the string value:

| Subtype                     | Description                                  |
| --------------------------- | -------------------------------------------- |
| `BS_MISMATCH`               | Balance sheet doesn't balance                |
| `AGM_TO_LATE`               | Annual general meeting held too late         |
| `AR_TO_LATE`                | Annual report submitted too late             |
| `MISSING_AUDITOR`           | Missing required auditor                     |
| `LIQUIDATION_REQUIRED`      | Subject to liquidation requirements          |
| `F_TAX_REVOKED`             | F-tax registration revoked                   |
| `AUDITOR_DISCOURGES`        | Auditor discourages the balance/result sheet |
| `AUDITOR_ACCOUNTING_ISSUES` | Auditor mentions accounting issues           |
| `AUDITOR_EARLY_RESIGNATION` | Auditor made an early resignation            |
| `NEGATIVE_SHARECAPITAL`     | Negative share capital in balance sheet      |
| `FORBIDDEN_LOAN`            | Management report mentions a forbidden loan  |

See the full list of subtypes in the API reference.

## Category fields

Fields starting with `c` (e.g. `cTurnoverInterval`, `cNbrEmployeesInterval`) are statistical category fields compiled weekly by Statistics Sweden across all legal entity types. Each contains:

* `categoryCode` - numeric code
* `categoryCodeDescription` - human-readable description

These are useful for filtering across company types that don't submit annual reports.


# Autocomplete companies
Source: https://docs.tic.io/api-lens/searchautocomplete/autocomplete-companies

post /search-autocomplete/companies
Searches the Typesense `companies` collection by name and registration number. Returns slim Typesense_CompanyAutocomplete_Dto projections. Requires the `integrator-search-companies` subscription feature.



# Autocomplete persons
Source: https://docs.tic.io/api-lens/searchautocomplete/autocomplete-persons

post /search-autocomplete/persons
Searches the Typesense `person` collection by full name and personal identity number. Returns slim Typesense_PersonAutocomplete_Dto projections. Requires the `integrator-search-persons` subscription feature.

This endpoint has stricter throttling, currentley maximum 120 requests per minute. Also it requires minimum 8 characters to be entered.


# Autocomplete Swedish addresses
Source: https://docs.tic.io/api-lens/searchautocomplete/autocomplete-swedish-addresses

post /search-autocomplete/addresses
Searches the Typesense `addresses_se` collection (Lantmäteriet belägenhetsadresser) by full address, street name and city. Returns slim Typesense_AddressAutocomplete_Dto projections. Requires the `integrator-search-addresses` subscription feature.



# Autocomplete Swedish properties
Source: https://docs.tic.io/api-lens/searchautocomplete/autocomplete-swedish-properties

post /search-autocomplete/properties
Searches the Typesense `properties_se` collection (Lantmäteriet fastigheter) by property designation. Returns slim Typesense_PropertyAutocomplete_Dto projections. Requires the `integrator-search-properties` subscription feature.



# Autocomplete vehicles
Source: https://docs.tic.io/api-lens/searchautocomplete/autocomplete-vehicles

post /search-autocomplete/vehicles
Searches the Typesense `transportstyrelsen` collection by licence plate, VIN, name, vehicle name, and trade name. Returns slim Typesense_VehicleAutocomplete_Dto projections. Requires the `integrator-search-vehicles` subscription feature.



# Cancel pending webhook deliveries for a job
Source: https://docs.tic.io/api-lens/sentinel/cancel-pending-webhook-deliveries-for-a-job

delete /sentinel/jobs/{guid}/webhook
Marks any pending or in-flight webhook deliveries for the job as disabled so the worker skips them. Already-delivered or already-failed deliveries are unaffected. Returns the number of deliveries cancelled.

<Badge>Sentinel add-on</Badge>


# Delete a Sentinel job
Source: https://docs.tic.io/api-lens/sentinel/delete-a-sentinel-job

delete /sentinel/jobs/{guid}
Soft-deletes the job locally and sends a best-effort delete to the Sentinel backend. Returns 204 on success.

<Badge>Sentinel add-on</Badge>


# Download a forensic annotation image
Source: https://docs.tic.io/api-lens/sentinel/download-a-forensic-annotation-image

get /sentinel/jobs/{guid}/annotations/{type}
Proxies a PNG annotation image from the Sentinel backend for a completed job.

<Badge>Sentinel add-on</Badge>


# Download PDF forensic report
Source: https://docs.tic.io/api-lens/sentinel/download-pdf-forensic-report

get /sentinel/jobs/{guid}/report.pdf
Generates and returns a PDF forensic report for a completed job, including the original image, forensic explanation, findings, annotations, and metadata. Annotation fetches run in parallel so report generation is not serialised on upstream latency.

<Badge>Sentinel add-on</Badge>


# Get Sentinel backend capabilities
Source: https://docs.tic.io/api-lens/sentinel/get-sentinel-backend-capabilities

get /sentinel/capabilities
Returns the Sentinel backend's advertised capabilities — available analyzers, GPU/ML/VLM status, supported file formats, and the max upload size.

<Badge>Sentinel add-on</Badge>


# Get Sentinel job status and report
Source: https://docs.tic.io/api-lens/sentinel/get-sentinel-job-status-and-report

get /sentinel/jobs/{guid}
Returns full job details including the analysis report when completed. If the job is still processing, the backend is polled and the local status is refreshed before returning.

<Badge>Sentinel add-on</Badge>


# List Sentinel jobs for the current team
Source: https://docs.tic.io/api-lens/sentinel/list-sentinel-jobs-for-the-current-team

get /sentinel/jobs
Returns a paginated list of forensic analysis jobs for the caller's team, ordered by creation date descending. Optionally filter by status.

<Badge>Sentinel add-on</Badge>


# Retry the webhook delivery for a job
Source: https://docs.tic.io/api-lens/sentinel/retry-the-webhook-delivery-for-a-job

post /sentinel/jobs/{guid}/webhook/retry
Requeues the most recent webhook delivery for the job. Use this when your endpoint was temporarily down and the automatic retry budget has been exhausted (delivery status = "failed").

<Badge>Sentinel add-on</Badge>


# Submit a file for forensic analysis
Source: https://docs.tic.io/api-lens/sentinel/submit-a-file-for-forensic-analysis

post /sentinel/analyze
Submits an image or PDF for forensic analysis. Supported formats: JPEG, PNG, HEIC, TIFF, WebP, GIF, BMP, PDF. Max file size: 100 MB. The file is forwarded to the Sentinel backend, a job is created, and the response is returned immediately with status 202 — poll `GET /sentinel/jobs/{guid}` or wire up a `webhookUrl` to be notified when analysis completes.

<Badge>Sentinel add-on</Badge>


# Get serving permit details by restaurant number
Source: https://docs.tic.io/api-lens/servingpermits/get-serving-permit-details-by-restaurant-number

get /serving-permits/{id}
Returns Swedish serving-permit (alkoholtillstånd) records for a given restaurant, including the company owning the permit.

<Badge>Enterprise+ tier</Badge>


# Get a team export by ID
Source: https://docs.tic.io/api-lens/team/get-a-team-export-by-id

get /team/exports/{id}
Returns a single previously generated export belonging to the caller's team, including the user who ran it.



# Get current team details
Source: https://docs.tic.io/api-lens/team/get-current-team-details

get /team
Returns the caller's team, including its members, integrations, and the currently active Lens subscription plan.



# Get document pricing for the current team
Source: https://docs.tic.io/api-lens/team/get-document-pricing-for-the-current-team

get /team/document-pricing
Returns the team-specific pricing for each orderable document type (e.g. Bolagsverket filings, UC reports).



# Get export quota for the current team
Source: https://docs.tic.io/api-lens/team/get-export-quota-for-the-current-team

get /team/exports/quota
Returns the team's monthly company-export quota: the configured limit from the active subscription plan, the amount used in the current calendar month (UTC), and the period boundaries.



# List document orders for the current team (AG Grid)
Source: https://docs.tic.io/api-lens/team/list-document-orders-for-the-current-team-ag-grid

post /team/orders
Returns a paginated list of document orders (Bolagsverket, UC, etc.) placed by the team. The request body follows the AG Grid server-side row model — start/end row, sort, and filter model. Requires team admin privileges.



# List exports for the current team (AG Grid)
Source: https://docs.tic.io/api-lens/team/list-exports-for-the-current-team-ag-grid

post /team/exports
Returns a paginated list of previously generated exports for the team. The request body follows the AG Grid server-side row model — start/end row, sort, and filter model. Requires team admin privileges.



# List users in the current team
Source: https://docs.tic.io/api-lens/team/list-users-in-the-current-team

get /team/users
Returns all users who are members of the caller's team. Requires team admin privileges.



# List teams the caller belongs to
Source: https://docs.tic.io/api-lens/teams/list-teams-the-caller-belongs-to

get /teams
Returns all teams the authenticated user is a member of, including each team's current Lens subscription plan (if any).



# Get vehicle summary by internal ID
Source: https://docs.tic.io/api-lens/vehicles/get-vehicle-summary-by-internal-id

get /vehicles/{id}
Returns full vehicle summary details for a Swedish Transportstyrelsen vehicle, including owner links, technical details, registered mileage, inspections (besiktningar) and historical events.

<Badge>Pro+ tier</Badge>


# Acknowledge a single event
Source: https://docs.tic.io/api-lens/watchlist/acknowledge-a-single-event

post /watchlists/{id}/events/{eventId}/acknowledge
Marks a single event as acknowledged by the caller with an optional note. Idempotent — re-acknowledging updates the note and the acknowledging user.

<Badge>Pro+ tier</Badge>


# Acknowledge all unacknowledged events
Source: https://docs.tic.io/api-lens/watchlist/acknowledge-all-unacknowledged-events

post /watchlists/{id}/events/acknowledge-all
Acknowledges every currently-unacknowledged event for the watchlist, optionally with a single note. Use `ExcludeEventIds` for 'select all except these' flows in the UI. Returns the number of events acknowledged.

<Badge>Pro+ tier</Badge>


# Add a company to a watchlist
Source: https://docs.tic.io/api-lens/watchlist/add-a-company-to-a-watchlist

post /watchlists/{id}/companies/{companyId}
Adds the company to the watchlist. Returns 409 if the company is already a member.

<Badge>Pro+ tier</Badge>


# Add a person to a watchlist
Source: https://docs.tic.io/api-lens/watchlist/add-a-person-to-a-watchlist

post /watchlists/{id}/persons/{personId}
Adds the person to the watchlist. Returns 409 if the person is already a member.

<Badge>Max+ tier</Badge>


# Add a property to a watchlist
Source: https://docs.tic.io/api-lens/watchlist/add-a-property-to-a-watchlist

post /watchlists/{id}/properties/{propertyId}
Adds the property to the watchlist. Returns 409 if the property is already a member.

<Badge>Enterprise+ tier</Badge>


# Add a vehicle to a watchlist
Source: https://docs.tic.io/api-lens/watchlist/add-a-vehicle-to-a-watchlist

post /watchlists/{id}/vehicles/{vehicleId}
Adds the vehicle to the watchlist. Returns 409 if the vehicle is already a member.

<Badge>Pro+ tier</Badge>


# Add an address to a watchlist
Source: https://docs.tic.io/api-lens/watchlist/add-an-address-to-a-watchlist

post /watchlists/{id}/addresses/{addressId}
Adds the address to the watchlist. Returns 409 if the address is already a member.

<Badge>Enterprise+ tier</Badge>


# Bulk-acknowledge selected events
Source: https://docs.tic.io/api-lens/watchlist/bulk-acknowledge-selected-events

post /watchlists/{id}/events/acknowledge
Acknowledges a set of events identified by `EventIds`, all scoped to this watchlist, with a single optional note. Returns the number of events acknowledged.

<Badge>Pro+ tier</Badge>


# Bulk-unacknowledge selected events
Source: https://docs.tic.io/api-lens/watchlist/bulk-unacknowledge-selected-events

delete /watchlists/{id}/events/acknowledge
Clears the acknowledgement state of a set of events identified by `EventIds`. Returns the number of events un-acknowledged.

<Badge>Pro+ tier</Badge>


# Check watchlist memberships for an entity
Source: https://docs.tic.io/api-lens/watchlist/check-watchlist-memberships-for-an-entity

get /watchlists/membership
Returns every watchlist the given entity belongs to. Specify exactly one of `companyId`, `personId`, `addressId`, `propertyId`, or `vehicleId`. Useful for UI badges showing 'this record is on N watchlists'.

<Badge>Pro+ tier</Badge>


# Create a notification trigger
Source: https://docs.tic.io/api-lens/watchlist/create-a-notification-trigger

post /watchlists/{id}/notifications
Adds a new notification trigger (Email, Webhook, or SMS) to the watchlist. Email destinations receive a confirmation email and must be validated before notifications are delivered. Webhooks are considered validated on creation. SMS destinations must be an E.164 mobile number.

<Badge>Pro+ tier</Badge>


# Create a watchlist
Source: https://docs.tic.io/api-lens/watchlist/create-a-watchlist

https://lens-api.tic.io/docs/v1/swagger.json POST /watchlists
Creates a new empty watchlist for the caller's team. Returns 201 with the created list and a URL pointing to it.

<Badge>Pro+ tier</Badge>


# Delete a notification trigger
Source: https://docs.tic.io/api-lens/watchlist/delete-a-notification-trigger

delete /watchlists/{id}/notifications/{notificationId}
Removes a notification trigger from the watchlist.

<Badge>Pro+ tier</Badge>


# Delete a watchlist
Source: https://docs.tic.io/api-lens/watchlist/delete-a-watchlist

delete /watchlists/{id}
Deletes a watchlist together with all its members, triggers, subscriptions, and event history. This operation is irreversible.

<Badge>Pro+ tier</Badge>


# Delete an event-type subscription
Source: https://docs.tic.io/api-lens/watchlist/delete-an-event-type-subscription

delete /watchlists/{id}/subscriptions/{subscriptionId}
Removes a single event-type subscription from the watchlist.

<Badge>Pro+ tier</Badge>


# Export address members of a watchlist as CSV
Source: https://docs.tic.io/api-lens/watchlist/export-address-members-of-a-watchlist-as-csv

get /watchlists/{id}/addresses/export
Returns a CSV of every address in the watchlist.

<Badge>Enterprise+ tier</Badge>


# Export company members of a watchlist as CSV
Source: https://docs.tic.io/api-lens/watchlist/export-company-members-of-a-watchlist-as-csv

get /watchlists/{id}/companies/export
Returns a CSV of every company in the watchlist. The response is UTF-8 CSV with a `Content-Disposition` header.

<Badge>Pro+ tier</Badge>


# Export person members of a watchlist as CSV
Source: https://docs.tic.io/api-lens/watchlist/export-person-members-of-a-watchlist-as-csv

get /watchlists/{id}/persons/export
Returns a CSV of every person in the watchlist. The response is UTF-8 CSV with a `Content-Disposition` header.

<Badge>Max+ tier</Badge>


# Export property members of a watchlist as CSV
Source: https://docs.tic.io/api-lens/watchlist/export-property-members-of-a-watchlist-as-csv

get /watchlists/{id}/properties/export
Returns a CSV of every property in the watchlist.

<Badge>Enterprise+ tier</Badge>


# Export vehicle members of a watchlist as CSV
Source: https://docs.tic.io/api-lens/watchlist/export-vehicle-members-of-a-watchlist-as-csv

get /watchlists/{id}/vehicles/export
Returns a CSV of every vehicle in the watchlist.

<Badge>Pro+ tier</Badge>


# Export watchlist events as CSV
Source: https://docs.tic.io/api-lens/watchlist/export-watchlist-events-as-csv

get /watchlists/{id}/events/export
Returns a CSV of every event for the watchlist (most recent first).

<Badge>Pro+ tier</Badge>


# Get watchlist dashboard
Source: https://docs.tic.io/api-lens/watchlist/get-watchlist-dashboard

get /watchlists/{id}/dashboard
Returns a bundled dashboard for a single watchlist: event breakdown by entity type, total/unacknowledged event counts, latest event timestamp, and the most recent events with entity details. Avoids several round-trips the UI would otherwise need.

<Badge>Pro+ tier</Badge>


# List address members of a watchlist (AG Grid)
Source: https://docs.tic.io/api-lens/watchlist/list-address-members-of-a-watchlist-ag-grid

post /watchlists/{id}/addresses
Returns a paginated AG Grid view of addresses in the watchlist.

<Badge>Enterprise+ tier</Badge>


# List company members of a watchlist (AG Grid)
Source: https://docs.tic.io/api-lens/watchlist/list-company-members-of-a-watchlist-ag-grid

post /watchlists/{id}/companies
Returns a paginated AG Grid view of companies in the watchlist. The request body follows the AG Grid server-side row model.

<Badge>Pro+ tier</Badge>


# List event subscriptions for a watchlist
Source: https://docs.tic.io/api-lens/watchlist/list-event-subscriptions-for-a-watchlist

get /watchlists/{id}/subscriptions
Returns the set of event types the watchlist currently subscribes to. Events of unsubscribed types are not delivered through notification triggers.

<Badge>Pro+ tier</Badge>


# List member events (AG Grid)
Source: https://docs.tic.io/api-lens/watchlist/list-member-events-ag-grid

post /watchlists/{id}/events
Returns a paginated AG Grid view of events fired for any member of the watchlist, with the entity each event refers to. The request body follows the AG Grid server-side row model.

<Badge>Pro+ tier</Badge>


# List notification triggers for a watchlist
Source: https://docs.tic.io/api-lens/watchlist/list-notification-triggers-for-a-watchlist

get /watchlists/{id}/notifications
Returns every notification trigger (email/webhook/SMS destination) configured for the watchlist.

<Badge>Pro+ tier</Badge>


# List person members of a watchlist (AG Grid)
Source: https://docs.tic.io/api-lens/watchlist/list-person-members-of-a-watchlist-ag-grid

post /watchlists/{id}/persons
Returns a paginated AG Grid view of persons in the watchlist.

<Badge>Max+ tier</Badge>


# List property members of a watchlist (AG Grid)
Source: https://docs.tic.io/api-lens/watchlist/list-property-members-of-a-watchlist-ag-grid

post /watchlists/{id}/properties
Returns a paginated AG Grid view of properties (fastigheter) in the watchlist.

<Badge>Enterprise+ tier</Badge>


# List vehicle members of a watchlist (AG Grid)
Source: https://docs.tic.io/api-lens/watchlist/list-vehicle-members-of-a-watchlist-ag-grid

post /watchlists/{id}/vehicles
Returns a paginated AG Grid view of vehicles in the watchlist.

<Badge>Pro+ tier</Badge>


# List watchlists for the team
Source: https://docs.tic.io/api-lens/watchlist/list-watchlists-for-the-team

https://lens-api.tic.io/docs/v1/swagger.json GET /watchlists
Returns every watchlist owned by the caller's team, each with counts of companies/persons/addresses/properties/vehicles and timestamps of the most recent event.

<Badge>Pro+ tier</Badge>


# Move a single member to another watchlist
Source: https://docs.tic.io/api-lens/watchlist/move-a-single-member-to-another-watchlist

post /watchlists/{id}/members/{memberGuid}/move
Moves a member from the source watchlist to the target watchlist within the same team. Returns 409 if the same entity already exists in the target.

<Badge>Pro+ tier</Badge>


# Move multiple members to another watchlist
Source: https://docs.tic.io/api-lens/watchlist/move-multiple-members-to-another-watchlist

post /watchlists/{id}/members/move
Bulk-moves the listed members from the source watchlist to the target watchlist. Duplicates in the target are skipped, not failed, and reported in `SkippedDuplicates`.

<Badge>Pro+ tier</Badge>


# Remove a member from a watchlist
Source: https://docs.tic.io/api-lens/watchlist/remove-a-member-from-a-watchlist

delete /watchlists/{id}/members/{memberGuid}
Removes a member (any entity type) from the watchlist together with its event history.

<Badge>Pro+ tier</Badge>


# Subscribe a watchlist to event types
Source: https://docs.tic.io/api-lens/watchlist/subscribe-a-watchlist-to-event-types

post /watchlists/{id}/subscriptions
Subscribes the watchlist to a single `EventType` or, when `SubscribeToAll` is true, to every non-deprecated event type. Existing subscriptions are not duplicated.

<Badge>Pro+ tier</Badge>


# Unacknowledge a single event
Source: https://docs.tic.io/api-lens/watchlist/unacknowledge-a-single-event

delete /watchlists/{id}/events/{eventId}/acknowledge
Reverses an acknowledgement, clearing the acknowledger, note, and timestamp.

<Badge>Pro+ tier</Badge>


# Update a watchlist
Source: https://docs.tic.io/api-lens/watchlist/update-a-watchlist

put /watchlists/{id}
Updates the name and description of a watchlist. Returns the updated list with refreshed member/trigger/subscription counts.

<Badge>Pro+ tier</Badge>


# Watchlists
Source: https://docs.tic.io/api-lens/watchlists

Monitor companies, persons, addresses, properties, and vehicles with LENS watchlists. Receive events via webhook, email, or SMS when subscribed changes occur.

Watchlists let you group companies, persons, addresses, properties, and vehicles into named lists and receive notifications when monitored entities change.

## Overview

| Concept           | Meaning                                                                                 |
| ----------------- | --------------------------------------------------------------------------------------- |
| **Watchlist**     | A named container for members you want to monitor.                                      |
| **Members**       | Entities (companies, persons, addresses, properties, vehicles) added to a watchlist.    |
| **Subscriptions** | Event types the watchlist is tracking - without a subscription, no events are recorded. |
| **Notifications** | Destinations (webhook / email / SMS) that receive events for a watchlist.               |
| **Events**        | Changes detected on members, delivered to every enabled notification.                   |

## Minimum plan

| Member type | Minimum plan    |
| ----------- | --------------- |
| Companies   | **Pro+**        |
| Vehicles    | **Pro+**        |
| Persons     | **Max+**        |
| Addresses   | **Enterprise+** |
| Properties  | **Enterprise+** |

Watchlist management, notifications, subscriptions, and events are available on **Pro+**.

## Watchlist CRUD

### List watchlists

```bash theme={null}
curl -H "x-api-key: YOUR_API_KEY" \
  "https://lens-api.tic.io/watchlists?sortBy=name"
```

Query parameters:

| Parameter | Type   | Default | Description         |
| --------- | ------ | ------- | ------------------- |
| `sortBy`  | string | `name`  | `name` or `created` |

Response - array of watchlist objects:

```json theme={null}
[
  {
    "watchListGuid": "a1b2c3d4-e5f6-...",
    "watchListName": "My companies",
    "watchListDescription": "Portfolio monitoring",
    "numberOfCompanies": 42,
    "numberOfPersons": 0,
    "numberOfNotifications": 2,
    "numberOfSubscriptions": 5,
    "numberOfUnacknowledgedEvents": 3
  }
]
```

### Create a watchlist

```bash theme={null}
curl -X POST "https://lens-api.tic.io/watchlists" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "watchListName": "My companies", "watchListDescription": "Portfolio monitoring" }'
```

| Field                  | Type   | Required | Constraints         |
| ---------------------- | ------ | -------- | ------------------- |
| `watchListName`        | string | Yes      | 1–200 characters    |
| `watchListDescription` | string | No       | Max 1000 characters |

Returns `201 Created` with the full watchlist object and a `Location` header.

### Update a watchlist

```
PUT /watchlists/{watchlistGuid}
```

Same request body as create. Returns the updated watchlist.

### Delete a watchlist

```
DELETE /watchlists/{watchlistGuid}
```

Returns `204 No Content`. Deleting a watchlist removes all members, events, notifications, and subscriptions.

## Members

Each member type has the same three operations: **list** (paginated), **add**, and **remove**.

### Adding a member

```bash theme={null}
# Add a company
curl -X POST "https://lens-api.tic.io/watchlists/{watchlistGuid}/companies/3508351" \
  -H "x-api-key: YOUR_API_KEY"
```

Replace `companies/3508351` with the entity type and ID:

| Entity   | Route                      | ID field     |
| -------- | -------------------------- | ------------ |
| Company  | `/companies/{companyId}`   | `companyId`  |
| Person   | `/persons/{personId}`      | `personId`   |
| Address  | `/addresses/{addressId}`   | `addressId`  |
| Property | `/properties/{propertyId}` | `propertyId` |
| Vehicle  | `/vehicles/{vehicleId}`    | `vehicleId`  |

Returns `201 Created` with the member GUID:

```json theme={null}
{
  "watchListMemberGuid": "f6e5d4c3-b2a1-...",
  "companyId": 3508351
}
```

Returns `409 Conflict` if the entity is already a member.

### Listing members (paginated)

Member lists use the same offset-based pagination as other table endpoints. See [Pagination](/api-lens/pagination) for the full reference.

```bash theme={null}
curl -X POST "https://lens-api.tic.io/watchlists/{watchlistGuid}/companies" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "startRow": 0, "endRow": 50 }'
```

Paginated member endpoints:

| Endpoint                           | Description      |
| ---------------------------------- | ---------------- |
| `POST /watchlists/{id}/companies`  | Company members  |
| `POST /watchlists/{id}/persons`    | Person members   |
| `POST /watchlists/{id}/addresses`  | Address members  |
| `POST /watchlists/{id}/properties` | Property members |
| `POST /watchlists/{id}/vehicles`   | Vehicle members  |

### Exporting members

Each member type can be exported as CSV:

```
GET /watchlists/{watchlistGuid}/companies/export
GET /watchlists/{watchlistGuid}/persons/export
GET /watchlists/{watchlistGuid}/addresses/export
GET /watchlists/{watchlistGuid}/properties/export
GET /watchlists/{watchlistGuid}/vehicles/export
```

### Removing a member

```
DELETE /watchlists/{watchlistGuid}/members/{memberGuid}
```

Returns `204 No Content`. Associated events are also deleted.

### Moving members

Move a single member to another watchlist:

```bash theme={null}
curl -X POST "https://lens-api.tic.io/watchlists/{watchlistGuid}/members/{memberGuid}/move" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "targetWatchListGuid": "b2c3d4e5-f6a7-..." }'
```

Move multiple members at once:

```bash theme={null}
curl -X POST "https://lens-api.tic.io/watchlists/{watchlistGuid}/members/move" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "targetWatchListGuid": "b2c3d4e5-f6a7-...",
    "memberGuids": ["f6e5d4c3-b2a1-...", "a1b2c3d4-e5f6-..."]
  }'
```

Returns `409` for members that already exist in the target watchlist. Bulk move reports skipped duplicates:

```json theme={null}
{
  "movedCount": 8,
  "skippedDuplicates": ["f6e5d4c3-b2a1-..."],
  "targetWatchListGuid": "b2c3d4e5-f6a7-..."
}
```

### Check membership

Find which watchlists an entity belongs to:

```bash theme={null}
curl -H "x-api-key: YOUR_API_KEY" \
  "https://lens-api.tic.io/watchlists/membership?companyId=3508351"
```

Pass exactly one query parameter: `companyId`, `personId`, `addressId`, `propertyId`, or `vehicleId`.

## Event subscriptions

Subscriptions control **which event types** generate events for a watchlist. Without subscriptions, no events are recorded.

### List subscriptions

```bash theme={null}
curl -H "x-api-key: YOUR_API_KEY" \
  "https://lens-api.tic.io/watchlists/{watchlistGuid}/subscriptions"
```

Response:

```json theme={null}
[
  {
    "subscriptionId": "abcdef01-2345-...",
    "eventType": 1,
    "eventTypeName": "CompanyAddress",
    "lastUpdatedAtUtc": "2025-03-15T10:30:00Z"
  }
]
```

### Subscribe to event types

Subscribe to a single event type:

```bash theme={null}
curl -X POST "https://lens-api.tic.io/watchlists/{watchlistGuid}/subscriptions" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "eventType": 1 }'
```

Subscribe to all event types at once:

```bash theme={null}
curl -X POST "https://lens-api.tic.io/watchlists/{watchlistGuid}/subscriptions" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "subscribeToAll": true }'
```

### Unsubscribe

```
DELETE /watchlists/{watchlistGuid}/subscriptions/{subscriptionId}
```

### Event types

| Value | Name                         | Entity   |
| ----- | ---------------------------- | -------- |
| 1     | `CompanyAddress`             | Company  |
| 2     | `CompanyName`                | Company  |
| 3     | `CompanyStatus`              | Company  |
| 4     | `CompanyRegistration`        | Company  |
| 5     | `CompanyIntelligence`        | Company  |
| 6     | `CompanyBeneficialOwner`     | Company  |
| 7     | `CompanyDocument`            | Company  |
| 8     | `CompanyWorkplace`           | Company  |
| 9     | `CompanyPerson`              | Company  |
| 10    | `CompanyRegisteredOffice`    | Company  |
| 11    | `CompanyShareCapital`        | Company  |
| 12    | `CompanyPurpose`             | Company  |
| 13    | `CompanyDebtBalance`         | Company  |
| 14    | `CompanyOrderToPayCase`      | Company  |
| 15    | `CompanyFinancialDocument`   | Company  |
| 16    | `CompanyCase`                | Company  |
| 17    | `CompanyWorkplaceAddress`    | Company  |
| 25    | `PersonAddress`              | Person   |
| 26    | `PersonName`                 | Person   |
| 27    | `PersonIntelligence`         | Person   |
| 28    | `PersonStatus`               | Person   |
| 29    | `PersonCompany`              | Person   |
| 40    | `PropertyOwnershipChange`    | Property |
| 41    | `PropertyMortgageDeedChange` | Property |
| 47    | `VehicleOwnerChange`         | Vehicle  |
| 48    | `VehicleUserChange`          | Vehicle  |
| 49    | `VehicleStatusChange`        | Vehicle  |
| 50    | `VehicleInspection`          | Vehicle  |
| 51    | `VehicleStolen`              | Vehicle  |

## Notifications

Notifications define **where** events are delivered. Each watchlist can have multiple notification destinations.

### List notifications

```bash theme={null}
curl -H "x-api-key: YOUR_API_KEY" \
  "https://lens-api.tic.io/watchlists/{watchlistGuid}/notifications"
```

Response:

```json theme={null}
[
  {
    "notificationId": "12345678-abcd-...",
    "destination": "https://example.com/webhook",
    "destinationType": 0,
    "destinationTypeDescription": "Webhook",
    "hasBeenValidated": true,
    "lastUpdatedAtUtc": "2025-03-15T10:30:00Z"
  }
]
```

### Create a notification

| Field             | Type   | Description                                       |
| ----------------- | ------ | ------------------------------------------------- |
| `destination`     | string | Email address, webhook URL, or E.164 phone number |
| `destinationType` | int    | `0` = Webhook, `1` = Email, `2` = SMS             |

<Tabs>
  <Tab title="Webhook">
    ```bash theme={null}
    curl -X POST "https://lens-api.tic.io/watchlists/{watchlistGuid}/notifications" \
      -H "x-api-key: YOUR_API_KEY" \
      -H "Content-Type: application/json" \
      -d '{ "destination": "https://example.com/webhook", "destinationType": 0 }'
    ```

    Destination must be a valid `https://` URL.
  </Tab>

  <Tab title="Email">
    ```bash theme={null}
    curl -X POST "https://lens-api.tic.io/watchlists/{watchlistGuid}/notifications" \
      -H "x-api-key: YOUR_API_KEY" \
      -H "Content-Type: application/json" \
      -d '{ "destination": "alerts@example.com", "destinationType": 1 }'
    ```

    Destination must be a valid email address.
  </Tab>

  <Tab title="SMS">
    ```bash theme={null}
    curl -X POST "https://lens-api.tic.io/watchlists/{watchlistGuid}/notifications" \
      -H "x-api-key: YOUR_API_KEY" \
      -H "Content-Type: application/json" \
      -d '{ "destination": "+46701234567", "destinationType": 2 }'
    ```

    Destination must be a valid E.164 mobile phone number.
  </Tab>
</Tabs>

Returns `409 Conflict` if the destination already exists on the watchlist.

### Delete a notification

```
DELETE /watchlists/{watchlistGuid}/notifications/{notificationId}
```

## Events

When a subscribed change is detected on a member, an event is recorded. Events persist until the member is removed.

### List events (paginated)

```bash theme={null}
curl -X POST "https://lens-api.tic.io/watchlists/{watchlistGuid}/events" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "startRow": 0, "endRow": 50 }'
```

Uses offset-based pagination. See [Pagination](/api-lens/pagination).

Each event contains:

| Field                                                               | Type     | Description                             |
| ------------------------------------------------------------------- | -------- | --------------------------------------- |
| `eventId`                                                           | int      | Unique event identifier                 |
| `watchListMemberGuid`                                               | Guid     | The member that changed                 |
| `eventType`                                                         | int      | Event type (see table above)            |
| `subType`                                                           | string   | Additional detail about the change      |
| `eventDate`                                                         | datetime | When the change was detected            |
| `isAcknowledged`                                                    | bool     | Whether the event has been acknowledged |
| `acknowledgedNote`                                                  | string   | Note added during acknowledgement       |
| `companyId` / `personId` / `addressId` / `propertyId` / `vehicleId` | int      | The entity that changed (one is set)    |

### Export events

```
GET /watchlists/{watchlistGuid}/events/export
```

Returns a CSV file.

### Acknowledge a single event

```bash theme={null}
curl -X POST "https://lens-api.tic.io/watchlists/{watchlistGuid}/events/42/acknowledge" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "note": "Reviewed, no action needed" }'
```

The `note` field is optional.

### Unacknowledge a single event

```
DELETE /watchlists/{watchlistGuid}/events/{eventId}/acknowledge
```

### Bulk acknowledge

Acknowledge multiple events at once:

```bash theme={null}
curl -X POST "https://lens-api.tic.io/watchlists/{watchlistGuid}/events/acknowledge" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "eventIds": [42, 43, 44], "note": "Batch reviewed" }'
```

### Bulk unacknowledge

```bash theme={null}
curl -X DELETE "https://lens-api.tic.io/watchlists/{watchlistGuid}/events/acknowledge" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "eventIds": [42, 43, 44] }'
```

### Acknowledge all

Acknowledge every unacknowledged event on a watchlist:

```bash theme={null}
curl -X POST "https://lens-api.tic.io/watchlists/{watchlistGuid}/events/acknowledge-all" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "note": "End-of-week review" }'
```

Optionally exclude specific events:

```json theme={null}
{
  "note": "End-of-week review",
  "excludeEventIds": [99, 100]
}
```

## Dashboard

Get a summary of a watchlist including recent events and event counts per entity type:

```bash theme={null}
curl -H "x-api-key: YOUR_API_KEY" \
  "https://lens-api.tic.io/watchlists/{watchlistGuid}/dashboard?recentEventCount=10"
```

| Parameter          | Type | Default | Max |
| ------------------ | ---- | ------- | --- |
| `recentEventCount` | int  | 10      | 25  |

Response:

```json theme={null}
{
  "watchListGuid": "a1b2c3d4-e5f6-...",
  "watchListName": "My companies",
  "totalMembers": 42,
  "unacknowledgedEventCount": 3,
  "lastEventAtUtc": "2025-03-15T10:30:00Z",
  "eventBreakdown": {
    "companyEvents": 12,
    "personEvents": 0,
    "addressEvents": 0,
    "propertyEvents": 0,
    "vehicleEvents": 0,
    "totalEvents": 12
  },
  "recentEvents": [
    {
      "eventId": 42,
      "memberGuid": "f6e5d4c3-b2a1-...",
      "eventType": 2,
      "subType": "Name changed",
      "eventDate": "2025-03-15T10:30:00Z",
      "isAcknowledged": false,
      "entityType": "Company",
      "entityName": "Volvo AB",
      "entityId": 3508351
    }
  ]
}
```

## Typical workflow

<Steps>
  <Step title="Create a watchlist">
    `POST /watchlists` with a name and optional description.
  </Step>

  <Step title="Add members">
    Add companies, persons, addresses, properties, or vehicles to your watchlist.
  </Step>

  <Step title="Subscribe to event types">
    Choose specific event types or use `subscribeToAll` to monitor everything.
  </Step>

  <Step title="Add notifications">
    Set up webhook for real-time delivery, email for digests, or SMS for alerts.
  </Step>

  <Step title="Poll or receive events">
    Events are recorded as members change. Poll the events endpoint or receive notifications.
  </Step>

  <Step title="Acknowledge events">
    Mark events as reviewed - individually, in bulk, or all at once.
  </Step>
</Steps>

## Error reference

| Status | Cause                                          |
| ------ | ---------------------------------------------- |
| `201`  | Member or resource created                     |
| `204`  | Delete successful                              |
| `400`  | Invalid request body or missing required field |
| `404`  | Watchlist or member not found                  |
| `409`  | Duplicate member or notification               |


# Create customer
Source: https://docs.tic.io/api-reseller/reseller-create-customers

post /reseller/customers
Creates a new customer for reseller

Allows you to create a customer if you represent a reseller. Use isTest=true to avoid creating
actual accounts during testing.


# Get customers
Source: https://docs.tic.io/api-reseller/reseller-customers

get /reseller/customers
Get the resellers customers

Allows you to get a list of customers associated with your reseller account. If you an API
key that has an active reseller account with us to use this endpoint.


# Search companies free
Source: https://docs.tic.io/api-reseller/reseller-search-companies-free

get /search/companies/free
Search companies in our lightning-fast memory database

This endpoint can be used by reseller created accounts for free usages. It contains a
limited number of fields.

Check our extensive examples and description [here](/api-core/search).

<Tip>
  You can add <code>\&view=html</code> to your querystring and we will render an
  html page with explanations.
</Tip>


# Search companies multi free
Source: https://docs.tic.io/api-reseller/reseller-search-companies-free-multi

post /search/companies/free
Multi search enables to carry out multiple search requests in a single request

This endpoint can be used by reseller created accounts for free usages. It contains a
limited number of fields.


# Bolagsverket Financial Reports Daily
Source: https://docs.tic.io/api-statistics/bolagsverket/financial-reports-daily

get /statistics/se/bolagsverket/financial-reports/daily
Get statistics of registered financial reports per day at Bolagsverket

### Details

This endpoint delivers daily statistics about registered financial reports (annual and interim reports)
at Bolagsverket (The Swedish companies registration office). Updates occur after 00:00 each day in the
week.

### Response Model (Jagged Arrays)

The response model is compact to deliver ultra low response times. Data is only stored in RAM memory. Therefore
the data is supplied in what's called jagged array's. A jagged array is sometimes called an "array of arrays."

#### eReports

This contains the registered electronic financial reports. The format is an array of arrays with the type \[Int32,Int32]
with the first representing YYMMDD (e.g year, month and day note that year is only given in two digits eg. 2024 = 24, 2025 = 25). The second
represent the number of reports registered for the date.

#### pReports

This contains the number of registered paper (scanned) financial reports. Each element in the array is of type \[Int32,Int32]
with the first representing YYMMDD (e.g year, month and day note that year is only given in two digits eg. 2024 = 24, 2025 = 25). The second
represent the number of reports registered for the date.

#### softwareEnum

This is a dictionary of all given listed software used in the statistics of electronic registered financial reports. The
key in the dictionary is used in the softwareUsed property.

#### softwareUsed

This contains software used for electronic financial reports per day. The format is an array of arrays with the type
\[Int32, Int32, Int32]. with the first representing YYMMDD (e.g year, month and day note that year is only given in two digits eg. 2024 = 24, 2025 = 25).
The second the key fo the dictionary for the softwareEnum. The third part represents the number of reports of reports
registered for the date.

### intelligence

This contains the number of discrepancies we are finding in the registered financial reports for the same day.
The format is an array of arrays with the type \[Float,Float,Float] with the first representing YYMMDD
(e.g year, month and day note that year is only given in two digits eg. 2024 = 24, 2025 = 25). The second represent the number of discrepancies
found for the same date as the registered financial report. The second represent the number of discrepancies
found for the same date as the registered financial report. The third represents the percentage of found
discrepancies compared to the same days registered financial reports.

## softwareYTD

This is a dictionary with the key holding the software vendor and the value represents registered financial reports for year to date. The year
represents the year the request is being made.


# Bolagsverket Financial Reports Discrepancies
Source: https://docs.tic.io/api-statistics/bolagsverket/financial-reports-discrepancies

get /statistics/se/bolagsverket/financial-reports/discrepancies
Get statistics of registered financial reports and discrepancies per software year to date



# Bolagsverket Financial Reports Monthly
Source: https://docs.tic.io/api-statistics/bolagsverket/financial-reports-monthly

get /statistics/se/bolagsverket/financial-reports/monthly
Get statistics of registered financial reports per month at Bolagsverket

### Details

This endpoint delivers monthly statistics about registered financial reports (annual and interim reports)
at Bolagsverket (The Swedish companies registration office). Updates occur after 00:00 each day in the
week.

### Response Model (Jagged Arrays)

The response model is compact to deliver ultra low response times. Data is only stored in RAM memory. Therefore
the data is supplied in what's called jagged arrays. A jagged array is sometimes called an "array of arrays."

#### eReports

This contains the registered electronic financial reports. The format is an array of arrays with the type \[Int32,Int32]
with the first representing YYMDD (e.g year and month note that year is only given in two digits eg. 2024 = 24, 2025 = 25). The second
represent the number of reports registered for the date.

#### pReports

This contains the number of registered paper (scanned) financial reports. Each element in the array is of type \[Int32,Int32]
with the first representing YYMM (e.g year and month note that year is only given in two digits eg. 2024 = 24, 2025 = 25). The second
represent the number of reports registered for the date.

#### softwareEnum

This is a dictionary of all given listed software used in the statistics of electronic registered financial reports. The
key in the dictionary is used in the softwareUsed property.

#### softwareUsed

This contains software used for electronic financial reports per day. The format is an array of arrays with the type
\[Int32, Int32, Int32]. with the first representing YYMM (e.g year and month note that year is only given in two digits eg. 2024 = 24, 2025 = 25).
The second the key fo the dictionary for the softwareEnum. The third part represents the number of reports of reports
registered for the date.

### intelligence

This contains the number of discrepancies we are finding in the registered financial reports for the same day.
The format is an array of arrays with the type \[Float,Float,Float] with the first representing YYMM
(e.g year and month note that year is only given in two digits eg. 2024 = 24, 2025 = 25). The second represent the number of discrepancies
found for the same date as the registered financial report. The third represents the percentage of found
discrepancies compared to the same days registered financial reports.

## softwareYTD

This is a dictionary with the key holding the software vendor and the value represents registered financial reports for year to date. The year
represents the year the request is being made.


# Statistics
Source: https://docs.tic.io/api-statistics/introduction

How to use our statistics



# Authentication
Source: https://docs.tic.io/authentication

How to authenticate with the TIC API using API keys or JWT. The same auth model works for the LENS API (v2) and the legacy v1 API.

<Info>
  This page covers the authentication flows shared by both APIs. For **LENS (v2)** specifics - detailed error codes, feature gating, and brute-force protection - see [Authentication in the v2 API](/api-lens/authentication).
</Info>

TIC uses a single authentication model for both the **LENS API (v2)** (`https://lens-api.tic.io`) and the **legacy v1 API** (`https://api.tic.io`). Pick whichever method fits your use case.

| Method                                                  | When to use                                                                                                      |
| ------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
| [API key in querystring](#querystring-authentication)   | Quick experiments and shared snippets. Exposes the key in URLs - **avoid in production**.                        |
| [API key in header](#request-header-authentication)     | The standard for server-to-server integrations.                                                                  |
| [JWT via OTP login](#login-user-and-retrieve-jwt-token) | End-user applications where the call is made on behalf of a logged-in user. Restricted to approved applications. |

## Querystring authentication

Append `key=your_api_key` to the URL.

<Warning>
  The key is visible in browser history, server logs, and proxy logs. Only use this for throwaway experiments.
</Warning>

```bash cURL theme={null}
# LENS API (v2)
curl "https://lens-api.tic.io/search-public/companies?q=the+intelligence+company&query_by=names&key=your_api_key"

# Legacy v1 API
curl "https://api.tic.io/search/companies?q=the+intelligence+company&query_by=names&key=your_api_key"
```

## Request header authentication

Pass the key in the `x-api-key` header. This is the recommended method.

```bash cURL theme={null}
# LENS API (v2)
curl -H "x-api-key: your_api_key" "https://lens-api.tic.io/companies/12345"

# Legacy v1 API
curl -H "x-api-key: your_api_key" "https://api.tic.io/datasets/companies/12345"
```

## Login user and retrieve JWT token

Use this when your application calls the API on behalf of an end user and needs a user-scoped token. This flow is only available to approved applications.

```mermaid theme={null}
flowchart LR
    A[1. POST /login-otp] -- 2. User receives OTP --> B(3. POST /login-otp-validate)
    B --> C{Code valid?}
    C -- Yes --> D[4. JWT token returned]
    C -- No --> F[Retry]
```

### 1. Request a one-time password

POST to `login-otp` with the user's mobile phone (E.164) or email address.

```bash cURL theme={null}
curl https://api.tic.io/ask_for_approval/login-otp \
  -d '{
    "e164MobilePhoneNumber": "+461234567",
    "email": "user-email@domain.tld"
  }'
```

```json Response theme={null}
{
  "userGuid": "DAE48E21-E457-44AB-8DB1-8859E3424179",
  "validationCodeValidUntilUtc": "2024-06-18T12:01:24"
}
```

### 2. User receives the OTP

The code is sent to the user's phone or email and is valid for a short window.

### 3. Validate the OTP

POST the `userGuid` and the code the user received.

```bash cURL theme={null}
curl https://api.tic.io/ask_for_approval/login-otp-validate \
  -d '{
    "userGuid": "DAE48E21-E457-44AB-8DB1-8859E3424179",
    "validationCode": "<received by the user>"
  }'
```

```json Response theme={null}
{
  "userGuid": "DAE48E21-E457-44AB-8DB1-8859E3424179",
  "token": "<JWT Token>",
  "tokenExpiresAtUtc": "2024-07-18T12:02:10"
}
```

### 4. Use the JWT

Send the token as a `Bearer` credential in the `Authorization` header. Works against both APIs.

```bash cURL theme={null}
# LENS API (v2)
curl -H "Authorization: Bearer <JWT Token>" "https://lens-api.tic.io/companies/12345"

# Legacy v1 API
curl -H "Authorization: Bearer <JWT Token>" "https://api.tic.io/datasets/companies/12345"
```


# Companies
Source: https://docs.tic.io/datasets/companies

Core TIC dataset for Swedish and Nordic companies - financials, ownership, representatives, addresses, filings, and more.

Our core datasets constitutes our core as a credit reference agency. We gather and process information
continuously every second. Industry datasets are combined with our core datasets to enrich data
and offer much better tools for credit scoring, vendor and customer evaluation, prospecting and statistical data analysis.

This dataset includes all companies of all types across the following countries:

* Sweden
* Norway (BETA)
* Isle of Man (BETA)
* Malta (BETA)
* Cyprus (BETA)
* Switzerland (all cantons) (BETA)

Totalling about 2,5 millon companies and increasing daily. Both current and former
companies are tracked.

## What's included

The number of datapoints are large and this is just a few examples of what we track.

* Addresses
* Status
* Submitted documents to registry authorities
* Annual reports
* Financial statements
* Email Addresses
* Phone numbers
* Domains
* Hyperlinks
* Social profile
* Tax decisions
* Payroll
* Bank accounts
* Share register
* Ownership in other businesses
* Relationships parent and subsidaries
* Participants
* Board members
* Auditor remarks

## How to gain access

To access this dataset the user must have claims including user.

## Documentation

You will find the [full documentation and reference to the API here](/api-core/search).


# European Commission
Source: https://docs.tic.io/datasets/europeancommission

Industry dataset surfacing European Commission participants, projects, and funding - searchable via the TIC API.

[European Commission](https://commission.europa.eu/index_en) has a large amount
of various information sources.

This dataset serves the purpose to simplify data access and aggregation.

## What's included

The dataset covers daily updates of:

* Participant register (EU Funding & Tenders)
* CORDIS containing Horizon Europe, Horizon H2020 and FP7 projects

## How to gain access

To access this dataset the user must have claims including both ica and ica-catalog.


# Finansinspektionen
Source: https://docs.tic.io/datasets/finansinspektionen

Industry dataset for Finansinspektionen - Swedish financial regulator notifications, insider trading, and supervisory data.

[Finansinspektionen](https://www.fi.se/en/) is Sweden's government authority tasked with monitoring the financial market.

This dataset has been tracking data from Finansinspektionen since 2016.

## What's included

This dataset covers daily and second updates of:

* Notifications / Flagging regulatory events for listed companies
* Insider trading with easy to use summary of the instruments
* Public registry information about listed companies
* Fund holdings quarterly updates

## How to gain access

To access this dataset the user must have claims including finansinspektionen.


# ICA
Source: https://docs.tic.io/datasets/ica

Industry dataset covering ICA Sweden - stores, catalogs, notes, and statistics for Sweden's largest grocery retailer.

With some 1,300 stores and a market share of approximately 36%, [ICA Sweden](https://www.icagruppen.se/en/about-ica-gruppen/our-business/our-companies/ica-sweden) is the leading grocery retailer in Sweden. Easy store
is run as a separate entity, business, and it has been hard to track the performance for each store earlier since the store
name typically is very different from the marketed name.

This dataset has been tracking the ICA stores since 2000. An example how the data can be used is demonstrated on [https://ica.jensnylander.com](https://ica.jensnylander.com/)

## What's included

The datasets covers daily updates of:

* Store and store profile (e.g Maxi, Kvantum, Supermarket, Nära)
* Legal information about the business
* Contact information to store manager
* Financial data
* Financial key metrics (example gross margin, operating margin, profit margin)
* Notes about change of ownership
* Extra dividends
* Pricing of selected articles tracked on daily basis
* Simple to use statistics endpoints
* Article catalogue (\~18 000 items) including manufacturer information

## How to gain access

To access this dataset the user must have claims including both ica and ica-catalog.


# Persons
Source: https://docs.tic.io/datasets/persons

Core TIC dataset for individuals - roles, addresses, beneficial ownership, and company involvement across Sweden and the Nordics.

Our core datasets constitutes our core as a credit reference agency. We gather and process information
continuously every second. Industry datasets are combined with our core datasets to enrich data
and offer much better tools for credit scoring, vendor and customer evaluation, prospecting and statistical data analysis.

## What's included

During the period until our application for being registered as credit reference agency we only supply
anonymized records. Following a granted licence we will offer daily updates of:

* Everyone registered in Sweden over the age of 15
* Involvement in businesses of all types

## How to gain access

To access this dataset the user must have claims including user.

## Documentation

You will find the [full documentation and reference to the API here](/api-core/persons/search).


# Search bankruptcies
Source: https://docs.tic.io/datasets/search-bankruptcies-se

Search Swedish company bankruptcies, liquidations, and reorganizations by company, date, and status.

With our search for bankruptcies you can search by text and data within bankruptcies and visualize bankruptcies over geographic
areas and industries.

We provide an easy to use search API based on [Typesense](https://typesense.org) lightning-fast search database.
That means that all features described in [Typesense API version 29](https://typesense.org/docs/29.0/api/) is available in our API.
Data is continuously reindexed as new data arrives.

Search index is stored on RAM memory meaning requests to our search serves very fast and you can use it for search-as-you-type,
autocomplete and other applications.

We today provide six rich search collections:

* **Bankruptcies (you are here)**
* [Company search](/search)
* [Workplace search](/datasets/search-workplaces)
* [Financial reports search](/datasets/search-reports-se)
* [Vehicles](/datasets/search-vehicles)
* [Properties](/datasets/search-properties-se)

## Bankruptcies search

With our search you can query (query\_by) based on a number fields listed in the next chapter.

Examples on what you can query on:

* Bankruptcies per day, week, month, year
* Bankruptcies per sector, industry type per SNI code
* Trustee
* Status

The response model (schema) depends on your query and if you use faceting. If you
do plain search we have added to our OpenAPI Schema the default response
model.

<Card title="OpenAPI Schema" icon="link" href="https://api.tic.io/docs/v1/swagger.json">
  Look for the model name TypesenseCompanyBankruptcyDocument in the schema
  definition.
</Card>

## Bankruptcy status codes

<Note>
  Please note that filed applications have bankruptcyStatusCode 255. If a
  bankruptcy is commenced the status code would change to 20 (from 255). If the
  status code keeps being 255 it means that the application could have been
  withdrawn, still pending court decision or that the bankruptcy is not
  monitored by Swedish companies registration office. Therefore 255 doesn't not
  mean that the proceedings have commenced.
</Note>

These are the status codes that could appear in bankruptcyStatusCode:

| Code | Swedish text                   | English text                       | Property for event date |
| ---- | ------------------------------ | ---------------------------------- | ----------------------- |
| 20   | Konkurs inledd                 | Bankruptcy proceedings commenced   | initiatedDate           |
| 21   | Konkurs avslutad               | Bankruptcy proceedings terminated  | terminatedDate          |
| 22   | Konkurs avslutad med överskott | Bankruptcy terminated with surplus | terminatedDate          |
| 24   | Konkurs upphävd av rätt        | Bankruptcy repealed by court       | repealedDate            |
| 255  | Konkursansökan                 | Bankruptcy application filed       | initiatedDate           |

## Fields indexed

The following fields are currently indexed in memory. These can be used in the query\_by and filter\_by parameter.

<Note>
  initiatedDate contains the date when the bankruptcy was commenced (status code
  20\). But in the event that the bankruptcy has not started it will represented
  the filed date at the court (status code 255).
</Note>

| Field                                                     | Type     | Description                                                                |
| --------------------------------------------------------- | -------- | -------------------------------------------------------------------------- |
| companyId                                                 | Int32    | Our global internal company identifier                                     |
| companyName                                               | String   | The name in the financial report                                           |
| registrationNumber                                        | String   | The local registration number in Sweden                                    |
| legalEntityType                                           | String   | The legal entity type as appeared locally                                  |
| localCompanyCode                                          | String   | The local code for the legal entity type                                   |
| elfCode                                                   | String   | An ISO code for the legal entity type (ISO 20275: Entity Legal Forms Code) |
| registrationDate                                          | Int64    | Unix epoch                                                                 |
| mostRecentPurpose                                         | String   | The company's most recent purpose                                          |
| bankruptcyStatusCode                                      | String   | A status code for the bankruptcy                                           |
| sniCodes.sni\_2007Name                                    | String   | SNI 2007 name                                                              |
| sniCodes.sni\_2007Code                                    | String   | SNI 2007 code                                                              |
| courtCase                                                 | String   | The case number at the court                                               |
| courtName                                                 | String   | The name of the court                                                      |
| courtCode                                                 | String   | The code of the court                                                      |
| courtEmail                                                | String   | The email address to the court                                             |
| initiatedBy                                               | Int64    | Information and who applied to bankrupcty (from 2024 and onwards)          |
| initiatedDate                                             | Int64    | Unix epoch                                                                 |
| terminatedDate                                            | Int64    | Unix epoch when the bankruptcy was terminated                              |
| repealedDate                                              | Int64    | Unix epoch of the appeal date                                              |
| hasTrustee                                                | Bool     | Help flag if the trustee exists                                            |
| trusteeName                                               | String   | The email address to the court                                             |
| trusteeCO                                                 | String   | The C/O of the trustee                                                     |
| trusteeAddressStreet                                      | String   | The address to the trustee                                                 |
| trusteeAddressPostalCode                                  | String   | The postalcode to the trustee                                              |
| trusteeAdddressCity                                       | String   | The city to to the trustee                                                 |
| registeredOfficeMunicipality                              | String   | The municipality name of the registered office (säte)                      |
| registeredOfficeMunicipalityCode                          | String   | The municipality code (4 characters) as specified by SCB                   |
| registeredOfficeCounty                                    | String   | The county name (län)                                                      |
| registeredOfficeCountyCode                                | String   | The county code (2 characters) as specified by SCB                         |
| mostRecentRegisteredAddress.co                            | String   | C/O = care of address                                                      |
| mostRecentRegisteredAddress.street                        | String   | Street name                                                                |
| mostRecentRegisteredAddress.houseNumber                   | String   | The street number                                                          |
| mostRecentRegisteredAddress.city                          | String   | City                                                                       |
| mostRecentRegisteredAddress.postalCode                    | String   | Postal Code                                                                |
| mostRecentRegisteredAddress.location                      | GeoPoint | Allows geosearch                                                           |
| mostRecentRegisteredAddress.addressType                   | Int32    | 0 = mailAddress, 1 = visitingAddress, 2 = bothMailAndVisitingAddress       |
| mostRecentRegisteredAddress.countryCodeAlpha3             | String   | Country code 3 char alpha                                                  |
| mostRecentFinancialSummary.annualReportPeriod             | Int32    | The endpoint report of the annual report in YYYYMM as Int32                |
| mostRecentFinancialSummary.periodStart                    | Int64    | Start period epoch seconds                                                 |
| mostRecentFinancialSummary.periodEnd                      | Int64    | End period epoch seconds                                                   |
| mostRecentFinancialSummary.rs\_NetSalesK                  | Int32    | Net sales in K (thousands)                                                 |
| mostRecentFinancialSummary.rs\_OtherOperatingIncomeK      | Int32    | Other operating income in K (thousands)                                    |
| mostRecentFinancialSummary.rs\_OperatingProfitOrLossK     | Int32    | Operating profit or loss in K (thousands)                                  |
| mostRecentFinancialSummary.rs\_SumFinancialItemsK         | Int32    | Sum of financial items in K (thousands)                                    |
| mostRecentFinancialSummary.rs\_ProfitAfterFinancialItemsK | Int32    | Profit after financial items in K (thousands)                              |
| mostRecentFinancialSummary.bs\_TotalAssetsK               | Int32    | Total assets in balance sheet in K (thouands)                              |
| mostRecentFinancialSummary.fn\_NumberOfEmployees          | Float    | Number of employees with one decimal                                       |
| mostRecentFinancialSummary.km\_OperatingMargin            | Float    | Operating margin with four decimals                                        |
| mostRecentFinancialSummary.km\_NetProfitMargin            | Float    | Net profit margin with four decimals                                       |
| mostRecentFinancialSummary.km\_EquityAssetsRatio          | Float    | Equity asset ratio with four decimals                                      |
| mostRecentFinancialSummary.km\_GrossMargin                | Float    | Gross margin with four decimals                                            |
| mostRecentFinancialSummary.software                       | String   | Software used to generate the financial report (if known)                  |
| applicationIfAny                                          | String   | Link to the application (from january 2024 and onwards)                    |
| isPublicSectorVendor                                      | Bool     | If the company exists as a vendor to the public sector                     |
| approxInvoicedToPublicSector2022                          | Decimal  | Approx value invoices by the vendor to the public sector 2022              |
| approxInvoicedToPublicSector2023                          | Decimal  | Approx value invoices by the vendor to the public sector 2023              |

## Examples

We have put together a few example of how you can use search in financial reports to easy find data.

### Search for bankruptcies initiated from 2024-12-09 00:00:00 and forward

```bash cURL theme={null}
curl https://api.tic.io/search/companies/bankruptcies/se?q=*&query_by=registrationNumber&filter_by=initiatedDate:>=1733702400&key=your_api_key
{
    "facet_counts": [],
    "found": 61,
    "hits": [
        {
            "document": {
                "bankruptcyStatusCode": "20",
                "bankruptcyStatusDescriptionEn": "Bankruptcy proceedings commenced",
                "bankruptcyStatusDescriptionSv": "Konkurs inledd",
                "companyId": 3367569,
                "companyName": "Mix Ranch AB",
                "courtCase": "K 1651-24",
                "courtCode": "TGO",
                "courtEmail": "gotlands.tingsratt@dom.se",
                "courtName": "Gotlands tingsrätt",
                "elfCode": "XJHM",
                "hasTrustee": true,
                "id": "299652",
                "initiatedDate": 1733702400,
                "legalEntityType": "Aktiebolag",
                "localCompanyCode": "AB",
                "mostRecentFinancialSummary": {
                    "bs_TotalAssetsK": 773,
                    "isAudited": false,
                    "km_EquityAssetsRatio": 0.123,
                    "periodEnd": 1672444800,
                    "periodStart": 1640995200,
                    "rs_NetSalesK": 0,
                    "rs_OperatingProfitOrLossK": -9,
                    "rs_OtherOperatingIncomeK": 0,
                    "rs_ProfitAfterFinancialItemsK": -35,
                    "rs_SumFinancialItemsK": -26
                },
                "mostRecentPurpose": "Bolaget verksamhet skall bestå i bedrivande av nöjesanläggning, / restaurang, säkerhetsutbildningar, personskydd, MC- och / bilverkstad samt därmed förenlig verksamhet.",
                "mostRecentRegisteredAddress": {
                    "addressType": "mailAddress",
                    "city": "Tingstäde",
                    "co": "C/O Edmarg",
                    "countryCodeAlpha3": "SWE",
                    "houseNumber": "641",
                    "location": [
                        57.7984,
                        18.54896
                    ],
                    "postalCode": "62442",
                    "street": "Stenkyrka Broungs"
                },
                "registeredOfficeCounty": "Gotlands län",
                "registeredOfficeCountyCode": "09",
                "registeredOfficeMunicipality": "Gotland",
                "registeredOfficeMunicipalityCode": "0980",
                "registrationDate": 1124064000,
                "registrationNumber": "5566845250",
                "sniCodes": [
                    {
                        "sni_2007Code": "55202",
                        "sni_2007Name": "Stugbyverksamhet m.m."
                    },
                    {
                        "sni_2007Code": "55300",
                        "sni_2007Name": "Campingplatsverksamhet"
                    },
                    {
                        "sni_2007Code": "56100",
                        "sni_2007Name": "Restaurangverksamhet"
                    },
                    {
                        "sni_2007Code": "93290",
                        "sni_2007Name": "Övrig fritids- och nöjesverksamhet"
                    }
                ],
                "trusteeAdddressCity": "STOCKHOLM",
                "trusteeAddressPostalCode": "111 22",
                "trusteeAddressStreet": "Olof Palmes gata 23",
                "trusteeCO": "c/o Merino Advokatbyrå AB",
                "trusteeName": "XXX"
            },
            "highlight": {},
            "highlights": []
        }...
```

### Search for bankruptcies from 2024-10-09 00:00:00 and onwards with the trustee C/O Fylgia law firm

```bash cURL theme={null}
curl https://api.tic.io/search/companies/bankruptcies/se?q=*&query_by=registrationNumber&filter_by=initiatedDate:>=1733702400&key=your_api_key
{
    "facet_counts": [],
    "found": 2,
    "hits": [
        {
            "document": {
                "bankruptcyStatusCode": "20",
                "bankruptcyStatusDescriptionEn": "Bankruptcy proceedings commenced",
                "bankruptcyStatusDescriptionSv": "Konkurs inledd",
                "companyId": 3319268,
                "companyName": "Kemze Konsult AB",
                "courtCase": "K 11798-24",
                "courtCode": "TVA",
                "courtEmail": "varbergs.tingsratt@dom.se",
                "courtName": "Varbergs tingsrätt",
                "elfCode": "XJHM",
                "hasTrustee": true,
                "id": "299600",
                "initiatedDate": 1733702400,
                "legalEntityType": "Aktiebolag",
                "localCompanyCode": "AB",
                "mostRecentFinancialSummary": {
                    "bs_TotalAssetsK": 1,
                    "isAudited": false,
                    "km_EquityAssetsRatio": 1.0,
                    "periodEnd": 1688083200,
                    "periodStart": 1656633600,
                    "rs_NetSalesK": 0,
                    "rs_OperatingProfitOrLossK": -22,
                    "rs_OtherOperatingIncomeK": 0,
                    "rs_ProfitAfterFinancialItemsK": -22,
                    "rs_SumFinancialItemsK": 0,
                    "software": "BL Bokslut"
                },
                "mostRecentPurpose": "Föremålet för bolagets verksamhet är att tillhandahålla / assistenthjälp, bedriva konsultations- och föreläsnings/ verksamhet, äga och förvalta värdepapper och därmed / förenlig verksamhet.",
                "mostRecentRegisteredAddress": {
                    "addressType": "registeredAddress",
                    "city": "Hagalund",
                    "co": "C/O Ola Kemze",
                    "countryCodeAlpha3": "SWE",
                    "houseNumber": "14",
                    "location": [
                        59.36196,
                        18.00999
                    ],
                    "postalCode": "16963",
                    "street": "Hagalundsgatan"
                },
                "registeredOfficeCounty": "Stockholms län",
                "registeredOfficeCountyCode": "01",
                "registeredOfficeMunicipality": "Solna",
                "registeredOfficeMunicipalityCode": "0184",
                "registrationDate": 1274054400,
                "registrationNumber": "5568084767",
                "sniCodes": [
                    {
                        "sni_2007Code": "88102",
                        "sni_2007Name": "Öppna sociala insatser för personer med funktionshinder"
                    },
                    {
                        "sni_2007Code": "90010",
                        "sni_2007Name": "Artistisk verksamhet"
                    }
                ],
                "trusteeAdddressCity": "STOCKHOLM",
                "trusteeAddressPostalCode": "102 04",
                "trusteeAddressStreet": "Box 55555",
                "trusteeCO": "Advokatfirman Fylgia KB",
                "trusteeName": "XXX"
            }...
```


# Search properties
Source: https://docs.tic.io/datasets/search-properties-se

Search Swedish properties (fastigheter) by address, region, owner, and property classification - sourced from Lantmäteriet.

With our search for properties you can search for properties based on street, city, postalcode, municipality, county, area,
type of property and much more.

We provide an easy to use search API based on [Typesense](https://typesense.org) lightning-fast search database.
That means that all features described in [Typesense API version 29](https://typesense.org/docs/29.0/api/) is available in our API.
Data is continuously reindexed as new data arrives.

We today provide six rich search collections:

* **Properties search (you are here)**
* [Company search](/search)
* [Company workplaces search](/search-workplaces)
* [Financial reports search](/datasets/search-reports-se)
* [Bankruptcies](/datasets/search-bankruptcies-se)
* [Vehicles](/datasets/search-vehicles)

## Properties search

With our search for properties you can query (query\_by) based on a number fields listed in the next chapter.

Examples on what you can query on:

* Street
* City
* Postalcode
* Type of property

The response model (schema) depends on your query and if you use faceting. If you
do plain search we have added to our OpenAPI Schema the default response
model.

<Card title="OpenAPI Schema" icon="link" href="https://api.tic.io/docs/v1/swagger.json">
  Look for the model name TypesenseLantmaterietFastighetDocument in the schema
  definition.
</Card>

## Fields indexed

The following fields are currently indexed in memory. These can be used in the query\_by and filter\_by parameter.

| Field               | Type        | Description                                                         |
| ------------------- | ----------- | ------------------------------------------------------------------- |
| id                  | String      | Lantmäteriets unique identifier for the property (UUID)             |
| propertyDesignation | String      | Property designation (Swedish: Fastighetsbeteckning)                |
| propertyType        | String/Enum | Can be of enum types fastighet or samfallighet                      |
| statusType          | String/Enum | Can be of enum types levande or avregistrerad                       |
| buildingNames       | String\[]   | An array of strings containing known bulding names                  |
| buildingPurposes    | String\[]   | An array of string enums with the building purposes                 |
| buildingTypes       | String\[]   | An array of string enums with the building types                    |
| centroidArea1       | GeoPoint    | The center latitude and longitude of the first area in the property |
| streetAddress       | String      | The street adress to the property                                   |
| postalCode          | Int32       | Postalcode to the property                                          |
| city                | String      | The city where the property is located                              |
| countyCode          | Int32       | The country code where the property is located                      |
| municipalityCode    | String      | The municipality code where the property is located                 |
| numberOfAddresses   | Int32       | Number of addresses to the property                                 |
| numberOfAreas       | Int32       | Number of areas of the property                                     |
| numberOfBuildings   | Int32       | Number of buildings on the property                                 |
| taxationCode        | Int32       | The taxation code to the property                                   |
| taxationValue       | Int64       | The taxation value of the property in SEK                           |
| taxationYear        | Int32       | The decision year of the taxation                                   |
| totalArea           | Float       | The total area of the property                                      |
| landArea            | Float       | The landarea in square meters of the property                       |
| waterArea           | Float       | The water area of the property                                      |

## Examples

We have put together a few example of how you can use search for workplaces to easy find data.

### Search for properties with taxation code 220 (Swedish: Småhusenhet, bebyggd)

Shows an example searching for properties with taxation code 220, house (Swedish: Småhusenhet, bebyggd).

```bash cURL theme={null}
curl https://api.tic.io/search/properties/se?q=*&query_by=*&filter_by=taxationCode:=220&key=your_api_key
{
    "facet_counts": [],
    "found": 2257868,
    "hits": [
        {
            "document": {
                "buildingPurposes": [
                    "Smahuskedjehus"
                ],
                "buildingTypes": [
                    "Komplementbyggnad",
                    "Komplementbyggnad",
                    "Bostad"
                ],
                "centroidArea1": [
                    59.1234,
                    13.1234
                ],
                "city": "Hammarö",
                "countyCode": 17,
                "id": "000a6a6f-ea7e-90ec-e040-ed8f66444c13",
                "landArea": 578.0,
                "municipalityCode": 61,
                "numberOfAddresses": 1,
                "numberOfAreas": 1,
                "numberOfBuildings": 3,
                "postalCode": 66340,
                "propertyDesignation": "STADEN ÖN 1:123",
                "streetAddress": "Testvagen 1",
                "taxationCode": 220,
                "taxationValue": 3081000,
                "taxationYear": 2024,
                "totalArea": 578.0,
                "waterArea": 0.0
            },
            "highlight": {},
            "highlights": []
        }
	],
    "out_of": 5056630,
    "page": 1,
    "request_params": {
        "collection_name": "properties_se_20250531192417",
        "first_q": "*",
        "per_page": 10,
        "q": "*"
    },
    "search_cutoff": false,
    "search_time_ms": 73
}
```


# Search annual reports
Source: https://docs.tic.io/datasets/search-reports-se

Search Swedish company annual reports and financial filings by company, year, and key financial figures.

With our search in financial reports you can search by text and data within management reports, audit
reports, financial reports including comments, foot notes and much more.

We provide an easy to use search API based on [Typesense](https://typesense.org) lightning-fast search database.
That means that all features described in [Typesense API version 29](https://typesense.org/docs/29.0/api/) is available in our API.
Data is continuously reindexed as new data arrives.

We today provide six rich search collections:

* **Financial reports search (you are here)**
* [Company search](/search)
* [Workplace search](/datasets/search-workplaces)
* [Bankruptcies](/datasets/search-bankruptcies-se)
* [Vehicles](/datasets/search-vehicles)
* [Properties](/datasets/search-properties-se)

## Financial reports search

With our search in financial reports you can query (query\_by) based on a number fields listed in the next chapter.

Examples on what you can query on:

* Information entered by the company in the financial report
* Management report
* Footnotes in financial reports
* Audit report
* Audit company
* Software used to produce the annual report
* Software used by the auditor to produce the audit letters
* Comments and notes from the company in the financial report
* Deviations / discrepancies in annual reports

The response model (schema) depends on your query and if you use faceting. If you
do plain search we have added to our OpenAPI Schema the default response
model.

<Card title="OpenAPI Schema" icon="link" href="https://api.tic.io/docs/v1/swagger.json">
  Look for the model name TypesenseCompanyFinancialReportDocument in the schema
  definition.
</Card>

## Fields indexed

The following fields are currently indexed in memory. These can be used in the query\_by parameter.

<Note>
  Why are certain fields in Swedish ? While we interpret and index documents
  there are both scanned reports and digital reports being in the format of
  iXBRL. For digital reports we try to keep the local name of the element close
  to the actual XBRL taxonomy. This makes it simpler to interpret the meaning of
  the fields and give them metadata.
</Note>

| Field                                                                  | Type                                | Description                                                                                               |
| ---------------------------------------------------------------------- | ----------------------------------- | --------------------------------------------------------------------------------------------------------- |
| companyId                                                              | Int32                               | Our global internal company identifier                                                                    |
| companyName                                                            | String                              | The name in the financial report                                                                          |
| externalId                                                             | A id to the actual financial report |                                                                                                           |
| registrationNumber                                                     | Int64                               | The local registration number in Sweden in Int64 format                                                   |
| periodEnd                                                              | Int32                               | The ending period in YYYYMM for the financial report in In32                                              |
| ruleset                                                                | String                              | The rulset used e.g K2, K3, K4 according to local law                                                     |
| formatDescription                                                      | String                              | Description of the formatting of the financial report                                                     |
| caseNumber                                                             | Int32                               | Casenumber without year at Bolagsverket / Swedish Company Registration Office                             |
| caseYear                                                               | Int32                               | Year when the case was registered at Bolagsverket / Swedish Company Registration Office                   |
| netSalesK                                                              | Int32                               | Net sales in thousands of the currency in the financial report                                            |
| numberOfEmployees                                                      | Int32                               | Number of employees if available in the financial report                                                  |
| balanceSheetTotalK                                                     | Int32                               | Balance sheet total in thousands in the financial report                                                  |
| otherText                                                              | String                              | Text in reports that cannot be attributed to a specific section will be indexed in this field             |
| auditorOtherText                                                       | String                              | Text found in audit reports that cannot be attributed to a specific section will be indexed in this field |
| revisorNamn                                                            | String                              | Name of the auditor                                                                                       |
| revisionsbolag                                                         | String                              | Name of the audit company                                                                                 |
| allmantVerksamheten                                                    | String                              | General about the company as described in the financial report                                            |
| vasentligaHandelserRakenskapsaret                                      | String                              | Significats events during the period                                                                      |
| verksamhetenArtInriktning                                              | String                              | The nature described of the business                                                                      |
| viktigaForandringarVerksamheten                                        | String                              | Important changes of the business                                                                         |
| viktigaExternaFaktorerPaverkatForetagetStallningResultat               | String                              | Important changes that affects the result                                                                 |
| speciellaOmstandigheterBerorForetaget                                  | String                              | Certain changes affecting the company                                                                     |
| uppgiftAgareMerAnTioProcentAndelarRoster                               | String                              | Information owners more than 10% of the votes                                                             |
| komplementarKommanditbolag                                             | String                              | Typically used as extra information                                                                       |
| komplemeOvrigaViktigaForhallandenVasentligaHandelserntarKommanditbolag | String                              | Typically used as extra information                                                                       |
| kommentarFlerarsoversikt                                               | String                              | Comments multi-year overview                                                                              |
| forandringEgetKapitalKommentar                                         | String                              | Comments changes in equity                                                                                |
| avskrivningarMateriellaAnlaggningstillgangarKommentar                  | String                              | Comments depreciations                                                                                    |
| andelarKoncernforetagKommentar                                         | String                              | Comments group relationship                                                                               |
| dispositionerVinstForlustKommentar                                     | String                              | Disposition profit or loss                                                                                |
| foretagetsSate                                                         | String                              | Registered office, sometimes used for free-formatted information                                          |
| eventualForpliktelser                                                  | String                              | Obligations, check below has two different parts                                                          |
| uppgiftModerforetag                                                    | String                              | Information about group company                                                                           |
| harNot                                                                 | Bool                                | Has foot notes ?                                                                                          |
| not.eventualForpliktelse                                               | String                              | Obligations                                                                                               |
| not.langfristigaSkulder                                                | String                              | Long-term liabilities                                                                                     |
| not.stalldaSakerhete                                                   | String                              | Securities                                                                                                |
| not.tillgangarAvsattningarSkulder                                      | String                              | Assets / liabilities                                                                                      |
| not.ovrigaMateriellaAnlaggningstillgangar                              | String                              | NA                                                                                                        |
| not.andelarKoncernforetag                                              | String                              | NA                                                                                                        |
| not.byggnaderMark                                                      | String                              | NA                                                                                                        |
| not.inventarierVerktygInstallationer                                   | String                              | NA                                                                                                        |
| not.andelarIntresseforetagGemensamtStyrdaForetag                       | String                              | NA                                                                                                        |
| not.medelantaletAnstallda                                              | String                              | NA                                                                                                        |
| not.andraLangfristigaFordringar                                        | String                              | NA                                                                                                        |
| not.upplysningModerforetag                                             | String                              | NA                                                                                                        |
| not.andraLangfristigaVardepappersinnehav                               | String                              | NA                                                                                                        |
| not.vasentligaHandelserRakenskapsaretsSlut                             | String                              | NA                                                                                                        |
| not.checkrakningskreditKommentar                                       | String                              | NA                                                                                                        |
| harRevisor                                                             | bool                                | NA                                                                                                        |
| revisor.pateckningRevisionsberattelseEnligtStandardutformning          | String                              | NA                                                                                                        |
| revisor.andraKravLagForfattningAnmarkning                              | String                              | NA                                                                                                        |
| revisor.ovrigaUpplysningar                                             | String                              | NA                                                                                                        |
| revisor.andraKravLagForfattningRevisorAnsvar                           | String                              | NA                                                                                                        |
| revisor.grundUttalanden                                                | String                              | NA                                                                                                        |
| revisor.styrelsenVerkstallandeDirektorAnsvar                           | String                              | NA                                                                                                        |
| revisor.andraKravLagForfattningGrundUttalanden                         | String                              | NA                                                                                                        |
| revisor.andraKravLagForfattningStyrelseVerkstallandeDirektorAnsvar     | String                              | NA                                                                                                        |
| revisor.styrelsenAnsvar                                                | String                              | NA                                                                                                        |
| revisor.andraKravLagForfattningStyrelseAnsvar                          | String                              | NA                                                                                                        |
| revisor.underskriftRevisionsberattelse                                 | String                              | NA                                                                                                        |
| revisor.uttalanden                                                     | String                              | NA                                                                                                        |
| revisor.andraKravLagForfattningUttalanden                              | String                              | NA                                                                                                        |
| revisor.harPateckningRevisionsberattelseEnligtStandardutformning       | String                              | NA                                                                                                        |
| revisor.harAndraKravLagForfattningAnmarkning                           | String                              | NA                                                                                                        |
| revisor.harGrundUttalanden                                             | String                              | NA                                                                                                        |
| reportSoftwareMetaTag                                                  | String                              | NA                                                                                                        |
| reportSoftwareVersionMetaTag                                           | String                              | NA                                                                                                        |
| reportApplicationName                                                  | String                              | NA                                                                                                        |
| reportAuditReportHashMetaTag                                           | String                              | NA                                                                                                        |
| reportOriginatorMetaTag                                                | String                              | NA                                                                                                        |
| reportAuditorMetaTag                                                   | String                              | NA                                                                                                        |
| auditorSoftwareMetaTag                                                 | String                              | NA                                                                                                        |
| auditorSoftwareVersionMetaTag                                          | String                              | NA                                                                                                        |
| auditorApplicationName                                                 | String                              | NA                                                                                                        |
| auditorReportHashMetaTag                                               | String                              | NA                                                                                                        |
| auditorOriginatorMetaTag                                               | String                              | NA                                                                                                        |

## Examples

We have put together a few example of how you can use search in financial reports to easy find data.

### Search for financial reports audited by a specific audit company

```bash cURL theme={null}
curl https://api.tic.io/search/companies/reports/se?q=kmpg&query_by=revisionsbolag&key=your_api_key
{
    "facet_counts": [],
    "found": 1483,
    "hits": [
        {
            "document": {
                "id": "3559",
                "companyId": 2679149,
                "companyName": "Optopro Solutions AB",
                "externalId": 3559,
                "registrationNumber": 5590955042,
                "periodEnd": 202306,
                "ruleset": "K3",
                "formatDescription": "Årsredovisning med kostnadsslagsindelad resultaträkning och balansräkning",
                "caseNumber": 9003557,
                "caseYear": 2024,
                "netSalesK": 4557,
                "numberOfEmployees": 1,
                "balanceSheetTotalK": 3212,
                "revisionsbolag": "KPMG AB",
                "vasentligaHandelserRakenskapsaret": ....
```

### Search for financial reports produced by a specific Software

```bash cURL theme={null}
curl https://api.tic.io/search/companies/reports/seq=visma&query_by=reportSoftwareMetaTag&key=your_api_key
{
    "facet_counts": [],
    "found": 72749,
    "hits": [
        {
            "document": {
                "id": "93",
                "companyId": 3086937,
                "companyName": "Vimera Medical AB",
                "externalId": 93,
                "registrationNumber": 5591969018,
                "periodEnd": 202303,
                "ruleset": "K2",
                "formatDescription": "Årsredovisning med resultaträkning och balansräkning",
                "caseNumber": 9000113,
                "caseYear": 2024,
                "allmantVerksamheten": "Bolaget som bildades 2019 bedriver ingen egen verksamhet. Bolaget har under året köpt och sålt 75 st aktier i Ortopedi Skåne AB.",
                "reportSoftwareMetaTag": "Visma Bokslut",
                "reportSoftwareVersionMetaTag": "2023.11"...
              },
```

### Search for financial reports with remarks (first)

There are multiple ways to search for remarks. One way is looking at the field: "andraKravLagForfattningAnmarkning".
Second example will show another way.

```bash cURL theme={null}
curl https://api.tic.io/search/companies/reports/se?q=skatt&query_by=skatt&query_by=revisor.andraKravLagForfattningAnmarkning&key=your_api_key
{
    "facet_counts": [],
    "found": 72749,
    "hits": [
        {
            "document": {
                 "id": "710",
                "companyId": 2836374,
                "companyName": "Krokoms Grävtjänst AB",
                "externalId": 710,
                "registrationNumber": 5569903874,
                "periodEnd": 202306,
                "ruleset": "K2",
                "formatDescription": "Årsredovisning med resultaträkning och balansräkning",
                "caseNumber": 9709058,
                "caseYear": 2023,
                ...
                "harRevisor": true,
                "revisor": {
                    "pateckningRevisionsberattelseEnligtStandardutformning": "2023-12-18",
                    "harPateckningRevisionsberattelseEnligtStandardutformning": true,
                    "andraKravLagForfattningAnmarkning": "Vid flera tillfällen under året har avdragen skatt
                    och sociala avgifter betalts för sent. Styrelsen har därmed inte fullgjort sina skyldigheter
                    enligt 8 kap. 4 § aktiebolagslagen. Försummelsen har inte medfört någon skada för bolaget
                    utöver dröjsmålsräntor.",
                    "harAndraKravLagForfattningAnmarkning": true,
              },
```

### Search for financial reports with remarks (second)

There are multiple ways to search for remarks. This example look for words in the "grundUttalanden" containing
the statements from the auditor.

```bash cURL theme={null}
curl https://api.tic.io/search/companies/reports/se?q=felaktigt&query_by=revisor.grundUttalanden&key=your_api_key
{
    "facet_counts": [],
    "found": 2,
    "hits": [
        {
            "document": {
                "id": "457991",
                "companyId": 3395567,
                "companyName": "ONE CC AB",
                "externalId": 457991,
                "registrationNumber": 5565856407,
                "periodEnd": 202312,
                "ruleset": "K3",
                "formatDescription": "Årsredovisning med kostnadsslagsindelad resultaträkning och balansräkning",
                "caseNumber": 9517336,
                "caseYear": 2024,
                "netSalesK": 58128,
                "numberOfEmployees": 8,
                "balanceSheetTotalK": 21131,
                  "revisor": {
                    "harPateckningRevisionsberattelseEnligtStandardutformning": false,
                    "andraKravLagForfattningAnmarkning": "Som framgår av min Rapport om årsredovisningen tillstyrker jag inte värdet av
                    fordringar hos koncernföretag. Denna bedömning är av betydelse för styrelsens eventuella ansvar att upprätta en
                    kontrollbalansräkning enligt 25 kap. 13§ Aktiebolagslagen. Någon kontrollbalansräkning har inte upprättats vilket
                    föranleder anmärkning.",
                    "harAndraKravLagForfattningAnmarkning": true,
                    "ovrigaUpplysningar": "Revisionen av årsredovisningen för år 2022 har utförts av en annan revisor vars uppdrag upphörde
                     i förtid och som lämnat en revisionsberättelse daterad 30 juni 2023 med modifierade uttalanden i Rapport om årsredovisningen.
                     Revisorn har avstyrkt att balans och resultaträkningen fastställs.",
                    "grundUttalanden": "Fordringar hos koncernföretag avser fordringar på spanska dotterbolaget och
                    har upptagits till 16 128 865 kr. Några revisionsbevis som styrker betalningsförmågan hos dotterbolaget har inte erhållits
                    och felaktig­heten är väsentlig för årsredovisningen som helhet. Till följd av detta kan jag inte tillstyrka värdet av
                    fordringar hos koncernföretag. Jag har utfört revisionen enligt International Standards on Auditing (ISA) och god r
                    evisionssed i Sverige. Mitt ansvar enligt dessa standarder beskrivs närmare i avsnittet Revisorns ansvar.
                    Jag är oberoende i förhållande till ONE CC AB enligt god revisorssed i Sverige och har i övrigt fullgjort mitt
                    yrkesetiska ansvar enligt dessa krav.Jag anser att de revisionsbevis jag har inhämtat är tillräckliga och ändamålsenliga
                     som grund för mina uttalanden med avvikande mening.",
                    "harGrundUttalanden": true...
                "reportSoftwareMetaTag": "Wolters Kluwer Bokslut",
                "reportSoftwareVersionMetaTag": "2024.1.2"...
```


# Search vehicles
Source: https://docs.tic.io/datasets/search-vehicles

Search Swedish vehicles by registration, make, model, owner, and fleet attributes - sourced from Transportstyrelsen.

With our search for vehicles you can query by 197 fields relating to vehicles
in Sweden.

We provide an easy to use search API based on [Typesense](https://typesense.org) lightning-fast search database.
That means that all features described in [Typesense API version 29](https://typesense.org/docs/29.0/api/) is available in our API.
Data is continuously reindexed as new data arrives.

We today provide six rich search collections:

* **Vehicle search (you are here)**
* [Workplace search](/datasets/search-workplaces)
* [Company search](/search)
* [Financial reports search](/datasets/search-reports-se)
* [Bankruptcies](/datasets/search-bankruptcies-se)
* [Properties](/datasets/search-properties-se)

## Vehicles search

With our search for vehicles you can query (query\_by) based on a number fields listed in the next chapter.

Examples on what you can query on:

* Manufacturer
* Licence plate
* Model
* Type

The response model (schema) depends on your query and if you use faceting. If you
do plain search we have added to our OpenAPI Schema the default response
model.

<Card title="OpenAPI Schema" icon="link" href="https://api.tic.io/docs/v1/swagger.json">
  Look for the model name TypesenseTransportstyrelsenDocument in the schema
  definition.
</Card>

## Fields indexed

The following fields are currently indexed in memory. These can be used in the query\_by and filter\_by parameter.

| Field                                   | Type        | Description |
| --------------------------------------- | ----------- | ----------- |
| fabric                                  | StringArray | Fabric name |
| vehicleClassDescription                 | String      |             |
| vehicleTypeDescription                  | String      |             |
| fuelCombination                         | String      |             |
| colorHex                                | String      |             |
| color                                   | String      |             |
| vehicleClassAndDescription              | String      |             |
| enginePowerHkAll                        | StringArray |             |
| electricVehicleConfigurationDescription | String      |             |
| fuelCodeDescriptions                    | StringArray |             |
| areaOfUse                               | StringArray |             |
| couplings                               | StringArray |             |
| name                                    | String      |             |
| gearbox                                 | String      |             |
| manufacturingMonthDescription           | String      |             |
| licencePlate                            | String      |             |
| deregistered                            | Int64       |             |
| deregisteredText                        | String      |             |
| deregisteredCause                       | String      |             |
| vehicleType                             | String      |             |
| vehicleCategoryEU                       | String      |             |
| vehicleName                             | String      |             |
| tradeName                               | String      |             |
| modelYear                               | Int32       |             |
| vehicleYear                             | Int32       |             |
| vin                                     | String      |             |
| fabricCode                              | String      |             |
| modelNumber                             | String      |             |
| groupNumber                             | String      |             |
| manufacturingYearAndMonth               | Int32       |             |
| manufactured                            | Int64       |             |
| reuseLicencePlate                       | Bool        |             |
| registered                              | Int64       |             |
| vehicleClass                            | String      |             |
| doodlebug                               | Bool        |             |
| manufacturer                            | String      |             |
| manfacturerBasicVehicle                 | String      |             |
| numberOfOwners                          | Int32       |             |
| acquiredByOwner                         | Int64       |             |
| registrationType                        | String      |             |
| status                                  | String      |             |
| statusDate                              | Int64       |             |
| statusCause                             | String      |             |
| onLease                                 | Bool        |             |
| areaOfUse1                              | String      |             |
| areaOfUse2                              | String      |             |
| areaOfUse3                              | String      |             |
| areaOfUse4                              | String      |             |
| areaOfUse5                              | String      |             |
| insuranceType                           | String      |             |
| onCredit                                | Bool        |             |
| importer                                | String      |             |
| originCode                              | String      |             |
| originCause                             | String      |             |
| preregistered                           | Int64       |             |
| earlierRegistration                     | Int64       |             |
| directImport                            | Bool        |             |
| variety                                 | String      |             |
| version                                 | String      |             |
| type                                    | String      |             |
| bodyworkCode1                           | String      |             |
| bodyworkCode2                           | String      |             |
| bodyworkCodeAddition                    | String      |             |
| busClass                                | String      |             |
| numberOfPassengers                      | Int32       |             |
| numberOfSeats                           | Int32       |             |
| eeg                                     | String      |             |
| cylinderVolume                          | Int32       |             |
| gearbox                                 | String      |             |
| coupling1                               | String      |             |
| coupling2                               | String      |             |
| curbWeight                              | Int32       |             |
| weightInDrivingCondition                | Int32       |             |
| totalWeight                             | Int32       |             |
| fuelCode1                               | String      |             |
| fuelCode2                               | String      |             |
| fuelCode3                               | String      |             |
| enginePowerHk1                          | Int32       |             |
| enginePowerHk2                          | Int32       |             |
| enginePowerHk3                          | Int32       |             |
| enginePowerUnit1                        | String      |             |
| enginePowerUnit2                        | String      |             |
| enginePowerUnit3                        | String      |             |
| fuelCombination                         | String      |             |
| fuelTankSize1                           | Int32       |             |
| fuelTankSize2                           | Int32       |             |
| fuelTankSize3                           | Int32       |             |
| width                                   | Int32       |             |
| length                                  | Int32       |             |
| height                                  | Int32       |             |
| maxTrailerWeightKg                      | Int32       |             |
| maxTrailerWeightB                       | Int32       |             |
| maxTrailerWeightBExtB                   | Int32       |             |
| maxWeightTrailer                        | Int32       |             |
| maxWeightUnbreakedTrailer               | Int32       |             |
| maxTrailerSpeed                         | Float       |             |
| maxLoadWeight                           | Int32       |             |
| fourWheelDrive                          | Bool        |             |
| maximumPowerForElectricVehicle          | Float       |             |
| powerDuring30Minutes                    | Float       |             |
| powerDuring15Minutes                    | Float       |             |
| averagePayload                          | Float       |             |
| workVehicle                             | Bool        |             |
| environmentalClass                      | String      |             |
| environmentalVehicle                    | String      |             |
| environmentalClassEURO                  | String      |             |
| emissionClass                           | String      |             |
| superEnvironmentalVehicle               | Bool        |             |
| co2Driv1                                | Float       |             |
| co2Driv2                                | Float       |             |
| co2Driv3                                | Float       |             |
| consumption1                            | Float       |             |
| consumption2                            | Float       |             |
| consumption3                            | Float       |             |
| energyConsumption                       | Int32       |             |
| soundLevel1                             | Int32       |             |
| soundLevel2                             | Int32       |             |
| soundLevel3                             | Int32       |             |
| consumptionWeightedMixed                | Float       |             |
| co2WeightedMixed                        | Float       |             |
| wltp\_C02Low1                           | Int32       |             |
| wltp\_C02Low2                           | Int32       |             |
| wltp\_C02Low3                           | Int32       |             |
| wltp\_C02Med1                           | Int32       |             |
| wltp\_C02Med2                           | Int32       |             |
| wltp\_C02Med3                           | Int32       |             |
| wltp\_C02High1                          | Int32       |             |
| wltp\_C02High2                          | Int32       |             |
| wltp\_C02High3                          | Int32       |             |
| wltp\_C02ExtraHigh1                     | Int32       |             |
| wltp\_C02ExtraHigh2                     | Int32       |             |
| wltp\_C02ExtraHigh3                     | Int32       |             |
| wltp\_C02Mixed1                         | Int32       |             |
| wltp\_C02Mixed2                         | Int32       |             |
| wltp\_C02Mixed3                         | Int32       |             |
| wltp\_CO2Weighted1                      | Int32       |             |
| wltp\_CO2Weighted2                      | Int32       |             |
| wltp\_CO2Weighted3                      | Int32       |             |
| wltp\_FuelConsumptionLow1               | Float       |             |
| wltp\_FuelConsumptionLow2               | Float       |             |
| wltp\_FuelConsumptionLow3               | Float       |             |
| wltp\_FuelConsumptionMed1               | Float       |             |
| wltp\_FuelConsumptionMed2               | Float       |             |
| wltp\_FuelConsumptionMed3               | Float       |             |
| wltp\_FuelConsumptionHigh1              | Float       |             |
| wltp\_FuelConsumptionHigh2              | Float       |             |
| wltp\_FuelConsumptionHigh3              | Float       |             |
| wltp\_FuelConsumptionExtraHigh1         | Float       |             |
| wltp\_FuelConsumptionExtraHigh2         | Float       |             |
| wltp\_FuelConsumptionExtraHigh3         | Float       |             |
| wltp\_FuelConsumptionMixed1             | Float       |             |
| wltp\_FuelConsumptionMixed2             | Float       |             |
| wltp\_FuelConsumptionMixed3             | Float       |             |
| wltp\_FuelConsumptionWeighted1          | Float       |             |
| wltp\_FuelConsumptionWeighted2          | Float       |             |
| wltp\_FuelConsumptionWeighted3          | Float       |             |
| wltp\_EnergyConsumption1                | Int32       |             |
| wltp\_EnergyConsumption2                | Int32       |             |
| wltp\_EnergyConsumption3                | Int32       |             |
| wltp\_EnergyConsumptionWeighted1        | Int32       |             |
| wltp\_EnergyConsumptionWeighted2        | Int32       |             |
| wltp\_EnergyConsumptionWeighted3        | Int32       |             |
| wltp\_Range1                            | Int32       |             |
| wltp\_Range2                            | Int32       |             |
| wltp\_RangeCity1                        | Int32       |             |
| wltp\_RangeCity2                        | Int32       |             |
| wltp\_CO2TypI\_1                        | Float       |             |
| wltp\_CO2TypI\_2                        | Float       |             |
| wltp\_CO2TypI\_3                        | Float       |             |
| nedc\_FuelConsumptionCity1              | Float       |             |
| nedc\_FuelConsumptionCity2              | Float       |             |
| nedc\_FuelConsumptionCity3              | Float       |             |
| nedc\_FuelConsumptionCountryRoad1       | Float       |             |
| nedc\_FuelConsumptionCountryRoad2       | Float       |             |
| nedc\_FuelConsumptionCountryRoad3       | Float       |             |
| nedc\_Range                             | Int32       |             |
| eletricVehicleConfiguration             | String      |             |
| numberOfAxles                           | String      |             |
| wheelbase1                              | Int32       |             |
| wheelbase2                              | Int32       |             |
| wheelbase3                              | Int32       |             |
| tireDimensionFront                      | String      |             |
| tireDimensionRear                       | String      |             |
| rimDimensionFront                       | String      |             |
| rimDimensionRear                        | String      |             |
| doubleCommand                           | Bool        |             |
| passengerAirbag                         | Bool        |             |
| rallyVehicle                            | Bool        |             |
| equipment1                              | String      |             |
| equipment2                              | String      |             |
| equipment3                              | String      |             |
| wheelbase1Miminum                       | Int32       |             |
| wheelbase2Miminum                       | Int32       |             |
| wheelbase3Miminum                       | Int32       |             |
| maxSpeed                                | Float       |             |
| limitedSpeed                            | String      |             |
| advancedBreakingsystemMC                | String      |             |
| address                                 | String      |             |
| city                                    | String      |             |
| postalCode                              | String      |             |

## Types and mappings

### Status

Contains information about the status of the vehicle.

| Type    | Swedish       | English        |
| ------- | ------------- | -------------- |
| AVST    | Avställd      | Decommissioned |
| ITRAFIK | I trafik      | In traffic     |
| AVREG   | Avregistrerad | Deregistered   |

### Vehicle types

Contains information about the vehicle type (Swedish: fordonsslag).

| Type   | Swedish        | English                |
| ------ | -------------- | ---------------------- |
| PB     | Personbil      | Passenger vehicle      |
| LB     | Lastbil        | Truck                  |
| BUSS   | Buss           | Bus                    |
| SLÄP   | Släpvagn       | Trailer                |
| TR     | Traktor        | Tractor                |
| MC     | Motorcykel     | Motorcycle             |
| MOPED  | Moped klass I  | Moped class I          |
| MRED   | Motorredskap   | Motorised work machine |
| TGHJUL | Terränghjuling | ATV                    |
| TGSNÖ  | Snöskoter      | Snowmobile             |
| TGV    | Terrängvagn    | All-terrain vehicle    |
| TGSL   | Terrängsläp    | Terrain trailer        |
| TGSK   | Terrängsskoter | Terrain snowmobile     |

### Vehicle classes

Contains information about the vehicle class (Swedish: Fordonsslagsklass).

| Type  | Swedish          | English                |
| ----- | ---------------- | ---------------------- |
| a     | Traktor a        | Tractor a              |
| b     | Traktor b        | Tractor a              |
| I     | klass I          | class I                |
| II    | klass II, husbil | class II, camper       |
| LÄTT  | Lätt             | Light-duty             |
| TUNG  | Tung             | Heavy-duty             |
| MRED1 | Motorredskap     | Motorised work machine |

### Fuel codes

Contains a description of the fuel types the vehicle support.

| Code | Swedish   | English      |
| ---- | --------- | ------------ |
| 1    | Bensin    | Gasoline     |
| 2    | Diesel    | Diesel       |
| 3    | El        | Electricity  |
| 4    | Fotogen   | Kerosene     |
| 6    | Gengas    | Cell gas     |
| 7    | Etanol    | Ethanol      |
| 9    | Motorgas  | LPG          |
| 16   | Metangas  | Methane gas  |
| 17   | Vätgas    | Hydrogen gas |
| 18   | Annat     | Other        |
| 19   | Biodiesel | Biodiesel    |
| 20   | CNG       | CNG          |
| 21   | LNG       | LNG          |

### Fuel combination code

Contains a description of fuel combinations.

| Code | Swedish       | English   |
| ---- | ------------- | --------- |
| B    | Tvåbränsle    | Bi-fuel   |
| D    | Dubbelbränsle | Dual-fuel |
| F    | Flexbränsle   | Flex fuel |
| T    | Trebränsle    |           |

### Gearbox codes

Contains a description of the gearbox of the vehicle.

| Code | Swedish              | English              |
| ---- | -------------------- | -------------------- |
| M    | Manuell              | Manual               |
| A    | Automat              | Automatic            |
| T    | Manuell med tillsats | Manual with addon    |
| Z    | Automat med tillsats | Automatic with addon |
| V    | Variomatic           | Variomatic           |

### Coupling codes

Contains a description of the couplings available on the vehicle (Swedish: kopplingsanordning).

| Code | Swedish          | English      |
| ---- | ---------------- | ------------ |
| 1    | Kula             | Trailer ball |
| 2    | Krok             | Towing hook  |
| 3    | Bygel            |              |
| 4    | Övrig            |              |
| 5    | Pivå / vändskiva | Turntable    |
| 6    | Kulhandske       |              |
| 7    | Ögla             |              |
| 8    | Tapp             |              |
| 9    | Jordbruksdrag    |              |
| 10   | Demonterbar kula |              |
| 11   | Annan            |              |

### Area of use codes

Contains a description of the areas of usage of the vehicle.

| Code | Swedish                       | English                           |
| ---- | ----------------------------- | --------------------------------- |
| 11   | Godstrafik                    | Freight traffic                   |
| 12   | Taxitrafik                    | Taxi traffic                      |
| 13   | Busstrafik                    | Bus traffic                       |
| 14   | Linjetrafik                   | Regular traffic                   |
| 15   | Uthyrningsrörelse             | Vehicle rental                    |
| 17   | Utryckningsfordon             | Emergency vehicles                |
| 18   | Trafikskola                   | Driving school                    |
| 19   | Ej yrkesmässig skolskjuts     | School bus (non-professional)     |
| 20   | Särskilt beslut               | Per special decision              |
| 21   | Taxitrafik (taxameterdispens) | Taxi traffic (exempted for meter) |
| 27   | Rallybil                      | Rally car                         |

### Electric vehicle configuration

Contains a description of how the electric vehicle is configured.

| Code                   | Swedish                                                     | English |
| ---------------------- | ----------------------------------------------------------- | ------- |
| EL                     | Endast eldrift                                              |         |
| Elhybrid               | Hybridelfordon som inte är externt laddbara                 |         |
| Laddhybrid             | Hybridelfordon som är externt laddbara                      |         |
| Elhybrid bränslecell   | Hybridelfordon med bränslecell som inte är externt laddbara |         |
| Laddhybrid bränslecell | Hybridelfordon med bränslecell som är externt laddbara      |         |

## Examples

We have put together a few example of how you can use search for vehicles to easy find data. Please note the last
example were we show how you include company information.

### Search for a licence plate

Freetext search, for this case it may be better to use filter\_by=licencePlate:=YXD972 instead
of q=YXD972.

```bash cURL theme={null}
curl https://api.tic.io/search/vehicles/se?q=YXD972&query_by=licencePlate&key=your_api_key
{
    {
    "facet_counts": [],
    "found": 1,
    "hits": [
        {
            "document": {
                "acquiredByOwner": 1666562400,
                "co2Driv1": 147.0,
                "color": "WHITE",
                "colorHex": "#FFFFFF",
                "consumption1": 5.6,
                "coupling1": "11",
                "curbWeight": 1732,
                "currentOwnerCompanyId": 1914247,
                "currentUserCompanyId": 2693627,
                "address": "TESTVÄGEN 1",
                "city": "STOCKHOLM",
                "postalCode": "12345",
                "cylinderVolume": 1968,
                "directImport": false,
                "doubleCommand": false,
                "eeg": "e1*2007/46*0217*26",
                "emissionClass": "EURO 6",
                "enginePowerHk1": 150,
                "enginePowerUnit1": "EG",
                "environmentalClassEURO": "6",
                "fabric": [
                    "Volkswagen"
                ],
                "fabricCode": "VW",
                "fourWheelDrive": true,
                "fuelCode1": "2",
                "gearbox": "A",
                "groupNumber": "904216",
                "height": 1886,
                "id": "3067040",
                "importer": "5560840968",
                "insuranceType": "ENSK",
                "lastInspection": 1737673200,
                "lastMileageDate": 1737673200,
                "length": 4878,
                "licencePlate": "YXD972",
                "manufacturingYearAndMonth": 201710,
                "maxLoadWeight": 643,
                "maxSpeed": 189.0,
                "maxTrailerWeightB": 1125,
                "maxTrailerWeightBExtB": 1875,
                "maxTrailerWeightKg": 1450,
                "maxWeightUnbreakedTrailer": 750,
                "mileageKm": 114038,
                "name": "VOLKSWAGEN, VW CADDY",
                "nedc_FuelConsumptionCity1": 6.3,
                "nedc_FuelConsumptionCountryRoad1": 5.2,
                "numberOfAxles": 2,
                "numberOfOwners": 6,
                "numberOfPassengers": 1,
                "onLease": true,
                "originCode": "INFÖRT",
                "passengerAirbag": true,
                "preregistered": 1509490800,
                "rallyVehicle": false,
                "registered": 1513897200,
                "registrationType": "1",
                "reusedLicencePlate": false,
                "rimDimensionFront": "6Jx16 ET50",
                "rimDimensionRear": "6Jx16 ET50",
                "soundLevel1": 70,
                "status": "ITRAFIK",
                "statusDate": 1666562400,
                "superEnvironmentalVehicle": false,
                "tireDimensionFront": "205/55 R16 94H rf.",
                "tireDimensionRear": "205/55 R16 94H rf.",
                "totalWeight": 2375,
                "tradeName": "CADDY",
                "type": "2KN",
                "variety": "BBDFSBX1",
                "vehicleCategoryEU": "N1",
                "vehicleClass": "LÄTT",
                "vehicleName": "VOLKSWAGEN, VW",
                "vehicleType": "LB",
                "vehicleYear": 2017,
                "version": "L0J2AD6AD62E088N1SN2VR27MMG2PLL371",
                "vin": "WV1ZZZ2KZJX043887",
                "wanted": false,
                "weightInDrivingCondition": 1732,
                "wheelbase1": 3006,
                "width": 1793
            },
            "highlight": {
                "licencePlate": {
                    "matched_tokens": [
                        "YXD972"
                    ],
                    "snippet": "<mark>YXD972</mark>"
                }
            },
            "highlights": [
                {
                    "field": "licencePlate",
                    "matched_tokens": [
                        "YXD972"
                    ],
                    "snippet": "<mark>YXD972</mark>"
                }
            ],
            "text_match": 578730123365711993,
            "text_match_info": {
                "best_field_score": "1108091339008",
                "best_field_weight": 15,
                "fields_matched": 1,
                "num_tokens_dropped": 0,
                "score": "578730123365711993",
                "tokens_matched": 1,
                "typo_prefix_score": 0
            }
        }
    ],
    "out_of": 11317782,
    "page": 1,
    "request_params": {
        "collection_name": "transportstyrelsen_20250202160026",
        "first_q": "YXD972",
        "per_page": 10,
        "q": "YXD972"
    },
    "search_cutoff": false,
    "search_time_ms": 0
}
}
```

### Search for vin

Search for vin (vehicle identification number).

```bash cURL theme={null}
curl https://api.tic.io/search/vehicles/se?q=WV1ZZZ2KZJX043887&query_by=vin&key=your_api_key
{
    {
    "facet_counts": [],
    "found": 1,
    "hits": [
        {
            "document": {
                ...
}
}
```

### Search for fabric

Searches for fabric, Volkswagen.

```bash cURL theme={null}
curl https://api.tic.io/search/vehicles/se?q=Volkswagen&query_by=fabric&key=your_api_key
{
    "facet_counts": [],
    "found": 994542,
    "hits": [
        {
            "document": {
                ...
}
}
```


# Search workplaces
Source: https://docs.tic.io/datasets/search-workplaces

Search Swedish workplaces (arbetsställen) by name, SNI code, location, employee count, and more.

With our search for workplaces you can search for business workplaces by street, city, postalcode, area (municipality, county), name,
number of employees and it will deliver millions of records instantly. A workplace is a physical location were the business operate and
each business could operate one or many workplaces. Each workplace has it's own metadata and contains rich information about the
operation at the location.

We provide an easy to use search API based on [Typesense](https://typesense.org) lightning-fast search database.
That means that all features described in [Typesense API version 29](https://typesense.org/docs/29.0/api/) is available in our API.
Data is continuously reindexed as new data arrives.

We today provide six rich search collections:

* **Workplaces search (you are here)**
* [Company search](/search)
* [Financial reports search](/datasets/search-reports-se)
* [Bankruptcies](/datasets/search-bankruptcies-se)
* [Vehicles](/datasets/search-vehicles)
* [Properties](/datasets/search-properties-se)

## Workplaces search

With our search for workplaces you can query (query\_by) based on a number fields listed in the next chapter.

Examples on what you can query on:

* Name of the workplace
* Street, postalcode, city, municipality code, county code and much more
* Companies that has ownership over the workplace
* Industry codes relating to the workplace

The response model (schema) depends on your query and if you use faceting. If you
do plain search we have added to our OpenAPI Schema the default response
model.

<Card title="OpenAPI Schema" icon="link" href="https://api.tic.io/docs/v1/swagger.json">
  Look for the model name TypesenseCompanyWorkplaceDocument in the schema
  definition.
</Card>

## Fields indexed

The following fields are currently indexed in memory. These can be used in the query\_by and filter\_by parameter.

| Field                                      | Type     | Description                                                                                      |
| ------------------------------------------ | -------- | ------------------------------------------------------------------------------------------------ |
| companyWorkplaceId                         | Int32    | Our global internal workspace identifier                                                         |
| workplaceCode                              | Int32    | The local region workspace identifier, e.g in Sweden CFAR                                        |
| workplaceCompanies.companyId               | Int32    | Our global internal company identifier                                                           |
| workplaceCompanies.fromDate                | Int64    | If the workplace has been moved to company this will contain the Unix from time (epoch)          |
| workplaceCompanies.toDate                  | Int64    | If the workplace is longer present on the company this will contain the Unix to time (epoch)     |
| workplaceCompanies.registrationNumber      | String   | The registrationnumber of the business                                                           |
| workplaceCompanies.mostRecentName          | String   | The most recent legalname for the business                                                       |
| workplaceCompanies.legalEntityType         | String   | The legal entity type of the business                                                            |
| workplaceCompanies.localCompanyCode        | String   | The local market abbreviated code                                                                |
| workplaceCompanies.elfCode                 | String   | The ISO Entity Legal Form code (ELF)                                                             |
| workplaceCompanies.registrationDate        | String   | The registration date (epoch) of the business                                                    |
| workplaceCompanies.ceasedDate              | Int64    | The business has ceased operation (epoch)                                                        |
| workplaceCompanies.isCeased                | Bool     | Flag to indicate the business have ceased operation                                              |
| workplaceUnits.companyId                   | Int32    | Each workplace can contain one or multiple sub-units owned by businesses (Swedish: arbetsställe) |
| workplaceUnits.unitIdentifier              | Int32    | The identifier for the unit (Swedish: arbetsställenummer)                                        |
| workplaceUnits.firstSeenAt                 | Int64    | The timestamp when we located the unit (epoch)                                                   |
| workplaceUnits.lastSeenAt                  | Int64    | The timestamp when we located that the unit has disappeared (epoch)                              |
| workplaceType                              | Int32    | The type of the workplace                                                                        |
| workplaceTypeDescriptionSv                 | String   | The description of the type (Swedish) of the workplace                                           |
| employeesRangeType                         | Int32    | The range of number of employees (interval)                                                      |
| employeesRangeTypeDescriptionSv            | String   | The description of the range (Swedish)                                                           |
| mostRecentVistingAddress.co                | String   | C/O of the visiting address                                                                      |
| mostRecentVistingAddress.streetAddress     | String   | The full street address of the visting address                                                   |
| mostRecentVistingAddress.street            | String   | Street name of the visiting address                                                              |
| mostRecentVistingAddress.houseNumber       | String   | House number of the visting address                                                              |
| mostRecentVistingAddress.houseLetter       | String   | House letter of the visiting address                                                             |
| mostRecentVistingAddress.postalCode        | String   | Postal code of the visting address                                                               |
| mostRecentVistingAddress.city              | String   | City of the visting address                                                                      |
| mostRecentVistingAddress.countryCodeAlpha3 | String   | Country code (alpha 3) of the visting address                                                    |
| mostRecentVistingAddress.municipalityCode  | String   | The municipality code (Swedish: kommunkod 4 chars)                                               |
| mostRecentVistingAddress.countyCode        | String   | The county code (Swedish: länskod 2 chars)                                                       |
| mostRecentVistingAddress.nyko              | String   | The subdivision code of the municipality                                                         |
| mostRecentVistingAddress.nykoYear          | String   | The origin year of the subdivision code                                                          |
| mostRecentVistingAddress.location          | GeoPoint | The latitude and longitude of the address                                                        |
| mostRecentVistingAddress.firstSeenAt       | String   | The timestamp when we located the visting address (epoch)                                        |
| mostRecentMailingAddress.co                | String   | C/O of the mailing address                                                                       |
| mostRecentMailingAddress.streetAddress     | String   | The full street address of the mailing address                                                   |
| mostRecentMailingAddress.street            | String   | Street name of the mailing address                                                               |
| mostRecentMailingAddress.houseNumber       | String   | House number of the mailing address                                                              |
| mostRecentMailingAddress.houseLetter       | String   | House letter of the mailing address                                                              |
| mostRecentMailingAddress.postalCode        | String   | Postal code of the mailing address                                                               |
| mostRecentMailingAddress.city              | String   | City of the mailing address                                                                      |
| mostRecentMailingAddress.countryCodeAlpha3 | String   | Country code (alpha 3) of the visting address                                                    |
| mostRecentMailingAddress.municipalityCode  | String   | The municipality code (Swedish: kommunkod 4 chars)                                               |
| mostRecentMailingAddress.countyCode        | String   | The county code (Swedish: länskod 2 chars)                                                       |
| mostRecentMailingAddress.nyko              | String   | The subdivision code of the municipality                                                         |
| mostRecentMailingAddress.nykoYear          | String   | The origin year of the subdivision code                                                          |
| mostRecentMailingAddress.location          | GeoPoint | The latitude and longitude of the address                                                        |
| mostRecentMailingAddress.firstSeenAt       | String   | The timestamp when we located the mailing address (epoch)                                        |
| sniCodes.firstSeenAt                       | String   | The timestamp when we located the industry code (epoch)                                          |
| sniCodes.sni\_2007Name                     | String   | The industry code of the workplace based on SNI 2007                                             |
| sniCodes.sni\_2007Code                     | String   | The name/description of the industry cod                                                         |
| sniCodes.rank                              | String   | The rank (sequence number)                                                                       |
| status.statusType                          | String   | The status of the workplace                                                                      |
| status.statusDescription                   | String   | The description of the status of the workplace                                                   |
| status.statusDate                          | String   | The date of the status (if it exists)                                                            |

## Examples

We have put together a few example of how you can use search for workplaces to easy find data.

### Search for workplaces based on a freetext business name

Shows an example searching for workplaces controlled by the freetext business name, Bahnhof.

```bash cURL theme={null}
curl https://api.tic.io/search/company-workplaces/?q=bahnhof&query_by=workplaceCompanies.mostRecentName&key=your_api_key
{
	"facet_counts": [],
	"found": 16,
	"hits": [
		{
			"document": {
				"companyWorkplaceId": 805670,
				"employeesRangeType": 4,
				"employeesRangeTypeDescriptionSv": "10-19 anställda",
				"id": "805670",
				"mostRecentMailingAddress": {
					"city": "Malmö",
					"firstSeenAt": 1726790400,
					"houseLetter": "B",
					"houseNumber": "15",
					"location": [
						55.6001,
						13.003
					],
					"postalCode": "21141",
					"street": "Storgatan",
					"streetAddress": "Storgatan 15 B"
				},
				"mostRecentVistingAddress": {
					"city": "Malmö",
					"countyCode": "12",
					"firstSeenAt": 1726790400,
					"houseLetter": "B",
					"houseNumber": "15",
					"location": [
						55.6001,
						13.003
					],
					"municipalityCode": "1280",
					"nyko": "130110",
					"nykoYear": 2023,
					"postalCode": "21141",
					"street": "Storgatan",
					"streetAddress": "Storgatan 15 B"
				},
				"sniCodes": [
					{
						"rank": 1,
						"sni_2007Code": "63110",
						"sni_2007Name": "Databehandling, hosting o.d."
					}
				],
				"status": [
					{
						"statusDate": 1415318400,
						"statusDescription": "Workplace is active",
						"statusType": "isActive"
					}
				],
				"workplaceCode": 55205868,
				"workplaceCompanies": [
					{
						"companyId": 1893055,
						"elfCode": "XJHM",
						"isCeased": false,
						"legalEntityType": "Aktiebolag",
						"localCompanyCode": "AB",
						"mostRecentName": "Bahnhof AB (publ)",
						"registrationDate": 805680000,
						"registrationNumber": "5565199493"
					}
				],
				"workplaceName": [
					{
						"firstSeenAt": 1726790400,
						"nameOrIdentifier": "SPARVEN 15"
					}
				],
				"workplaceType": 2,
				"workplaceTypeDescriptionSv": "Representerar ej JE",
				"workplaceUnits": [
					{
						"companyId": 1893055,
						"firstSeenAt": 1734364731,
						"unitIdentifier": 9
					}
				]
			},
			"highlight": {
				"workplaceCompanies": [
					{
						"mostRecentName": {
							"matched_tokens": [
								"Bahnhof"
							],
							"snippet": "<mark>Bahnhof</mark> AB (publ)"
						}
					}
				]
			},
			"highlights": [],
			"text_match": 578730123365187705,
			"text_match_info": {
				"best_field_score": "1108091338752",
				"best_field_weight": 15,
				"fields_matched": 1,
				"num_tokens_dropped": 0,
				"score": "578730123365187705",
				"tokens_matched": 1,
				"typo_prefix_score": 0
			}
		},
	],
	"out_of": 1962201,
	"page": 1,
	"request_params": {
		"collection_name": "workplaces_20241228165159",
		"first_q": "bahnhof",
		"per_page": 10,
		"q": "bahnhof"
	},
	"search_cutoff": false,
	"search_time_ms": 1
}
```

### Search for workplaces on a specific street and city

You can search virtually on anything, here is an example search for all workplaces on the specific street, Tunnelgatan, in the city Stockholm.

```bash cURL theme={null}
curl https://api.tic.io/search/company-workplaces/?q=*&query_by=*&filter_by=mostRecentVistingAddress.city:='Stockholm'&&mostRecentVistingAddress.street:='Tunnelgatan'&key=your_api_key
{
    "facet_counts": [],
    "found": 12,
    "hits": [
        {
            "document": {
                "companyWorkplaceId": 1779625,
                "employeesRangeType": 1,
                "employeesRangeTypeDescriptionSv": "0 anställda",
                "id": "1779625",
                "mostRecentMailingAddress": {
                  ...
```

### Search for workplaces with 5000 or more employees

You can also search for workplaces based on number of employees.

```bash cURL theme={null}
curl https://api.tic.io/search/company-workplaces/?q=*&query_by=*&filter_by=employeesRangeType:>=15&key=your_api_key
{
    "facet_counts": [],
    "found": 20,
    "hits": [
        {
            "document": {
                "companyWorkplaceId": 369656,
                "employeesRangeType": 15,
                "employeesRangeTypeDescriptionSv": "5000-9999 anställda",
                ...
```

### Search for all workplaces in a county

Search for all workplaces in a county is simple.

```bash cURL theme={null}
curl https://api.tic.io//search/company-workplaces/?q=*&query_by=*&filter_by=mostRecentVistingAddress.countyCode:='01'&key=your_api_key
{
    "facet_counts": [],
    "found": 504707,
    "hits": [
        {
            "document": {
                "companyWorkplaceId": 1940000,
                "employeesRangeType": 1,
                "employeesRangeTypeDescriptionSv": "0 anställda",
                "id": "1940000",
                "mostRecentMailingAddress": {
                    "city": "Sigtuna",
                    "firstSeenAt": 1728864000,
                    "houseNumber": "8",
                    "location": [
                        59.61802,
                        17.71584
                    ],
                    "postalCode": "19332",
                    "street": "Tunvägen",
                    "streetAddress": "Tunvägen 8"
                },...
```


# Code Blocks
Source: https://docs.tic.io/essentials/code

Display inline code and code blocks

## Basic

### Inline Code

To denote a `word` or `phrase` as code, enclose it in backticks (\`).

```
To denote a `word` or `phrase` as code, enclose it in backticks (`).
```

### Code Block

Use [fenced code blocks](https://www.markdownguide.org/extended-syntax/#fenced-code-blocks) by enclosing code in three backticks and follow the leading ticks with the programming language of your snippet to get syntax highlighting. Optionally, you can also write the name of your code after the programming language.

```java HelloWorld.java theme={null}
class HelloWorld {
    public static void main(String[] args) {
        System.out.println("Hello, World!");
    }
}
```

````md theme={null}
```java HelloWorld.java
class HelloWorld {
    public static void main(String[] args) {
        System.out.println("Hello, World!");
    }
}
```
````


# Images and Embeds
Source: https://docs.tic.io/essentials/images

Add image, video, and other HTML elements

<img />

## Image

### Using Markdown

The [markdown syntax](https://www.markdownguide.org/basic-syntax/#images) lets you add images using the following code

```md theme={null}
![title](/path/image.jpg)
```

Note that the image file size must be less than 5MB. Otherwise, we recommend hosting on a service like [Cloudinary](https://cloudinary.com/) or [S3](https://aws.amazon.com/s3/). You can then use that URL and embed.

### Using Embeds

To get more customizability with images, you can also use [embeds](/writing-content/embed) to add images

```html theme={null}
<img height="200" src="/path/image.jpg" />
```

## Embeds and HTML elements

<iframe title="YouTube video player" />

<br />

<Tip>
  Mintlify supports [HTML tags in Markdown](https://www.markdownguide.org/basic-syntax/#html). This is helpful if you prefer HTML tags to Markdown syntax, and lets you create documentation with infinite flexibility.
</Tip>

### iFrames

Loads another HTML page within the document. Most commonly used for embedding videos.

```html theme={null}
<iframe src="https://www.youtube.com/embed/4KzFe50RQkQ"> </iframe>
```


# Markdown Syntax
Source: https://docs.tic.io/essentials/markdown

Text, title, and styling in standard markdown

## Titles

Best used for section headers.

```md theme={null}
## Titles
```

### Subtitles

Best use to subsection headers.

```md theme={null}
### Subtitles
```

<Tip>
  Each **title** and **subtitle** creates an anchor and also shows up on the table of contents on the right.
</Tip>

## Text Formatting

We support most markdown formatting. Simply add `**`, `_`, or `~` around text to format it.

| Style         | How to write it   | Result            |
| ------------- | ----------------- | ----------------- |
| Bold          | `**bold**`        | **bold**          |
| Italic        | `_italic_`        | *italic*          |
| Strikethrough | `~strikethrough~` | ~~strikethrough~~ |

You can combine these. For example, write `**_bold and italic_**` to get ***bold and italic*** text.

You need to use HTML to write superscript and subscript text. That is, add `<sup>` or `<sub>` around your text.

| Text Size   | How to write it          | Result                 |
| ----------- | ------------------------ | ---------------------- |
| Superscript | `<sup>superscript</sup>` | <sup>superscript</sup> |
| Subscript   | `<sub>subscript</sub>`   | <sub>subscript</sub>   |

## Linking to Pages

You can add a link by wrapping text in `[]()`. You would write `[link to google](https://google.com)` to [link to google](https://google.com).

Links to pages in your docs need to be root-relative. Basically, you should include the entire folder path. For example, `[link to text](/writing-content/text)` links to the page "Text" in our components section.

Relative links like `[link to text](../text)` will open slower because we cannot optimize them as easily.

## Blockquotes

### Singleline

To create a blockquote, add a `>` in front of a paragraph.

> Dorothy followed her through many of the beautiful rooms in her castle.

```md theme={null}
> Dorothy followed her through many of the beautiful rooms in her castle.
```

### Multiline

> Dorothy followed her through many of the beautiful rooms in her castle.
>
> The Witch bade her clean the pots and kettles and sweep the floor and keep the fire fed with wood.

```md theme={null}
> Dorothy followed her through many of the beautiful rooms in her castle.
>
> The Witch bade her clean the pots and kettles and sweep the floor and keep the fire fed with wood.
```

### LaTeX

Mintlify supports [LaTeX](https://www.latex-project.org) through the Latex component.

<Latex>8 x (vk x H1 - H2) = (0,1)</Latex>

```md theme={null}
<Latex>8 x (vk x H1 - H2) = (0,1)</Latex>
```


# Navigation
Source: https://docs.tic.io/essentials/navigation

The navigation field in mint.json defines the pages that go in the navigation menu

The navigation menu is the list of links on every website.

You will likely update `mint.json` every time you add a new page. Pages do not show up automatically.

## Navigation syntax

Our navigation syntax is recursive which means you can make nested navigation groups. You don't need to include `.mdx` in page names.

<CodeGroup>
  ```json Regular Navigation theme={null}
  "navigation": [
      {
          "group": "Getting Started",
          "pages": ["quickstart"]
      }
  ]
  ```

  ```json Nested Navigation theme={null}
  "navigation": [
      {
          "group": "Getting Started",
          "pages": [
              "quickstart",
              {
                  "group": "Nested Reference Pages",
                  "pages": ["nested-reference-page"]
              }
          ]
      }
  ]
  ```
</CodeGroup>

## Folders

Simply put your MDX files in folders and update the paths in `mint.json`.

For example, to have a page at `https://yoursite.com/your-folder/your-page` you would make a folder called `your-folder` containing an MDX file called `your-page.mdx`.

<Warning>
  You cannot use `api` for the name of a folder unless you nest it inside another folder. Mintlify uses Next.js which reserves the top-level `api` folder for internal server calls. A folder name such as `api-reference` would be accepted.
</Warning>

```json Navigation With Folder theme={null}
"navigation": [
    {
        "group": "Group Name",
        "pages": ["your-folder/your-page"]
    }
]
```

## Hidden Pages

MDX files not included in `mint.json` will not show up in the sidebar but are accessible through the search bar and by linking directly to them.


# Reusable Snippets
Source: https://docs.tic.io/essentials/reusable-snippets

Reusable, custom snippets to keep content in sync

One of the core principles of software development is DRY (Don't Repeat
Yourself). This is a principle that apply to documentation as
well. If you find yourself repeating the same content in multiple places, you
should consider creating a custom snippet to keep your content in sync.

## Creating a custom snippet

**Pre-condition**: You must create your snippet file in the `snippets` directory.

<Note>
  Any page in the `snippets` directory will be treated as a snippet and will not
  be rendered into a standalone page. If you want to create a standalone page
  from the snippet, import the snippet into another file and call it as a
  component.
</Note>

### Default export

1. Add content to your snippet file that you want to re-use across multiple
   locations. Optionally, you can add variables that can be filled in via props
   when you import the snippet.

```mdx snippets/my-snippet.mdx theme={null}
Hello world! This is my content I want to reuse across pages. My keyword of the
day is {word}.
```

<Warning>
  The content that you want to reuse must be inside the `snippets` directory in
  order for the import to work.
</Warning>

2. Import the snippet into your destination file.

```mdx destination-file.mdx theme={null}
---
title: My title
description: My Description
---

import MySnippet from '/snippets/path/to/my-snippet.mdx';

## Header

Lorem impsum dolor sit amet.

<MySnippet word="bananas" />
```

### Reusable variables

1. Export a variable from your snippet file:

```mdx snippets/path/to/custom-variables.mdx theme={null}
export const myName = 'my name';

export const myObject = { fruit: 'strawberries' };
```

2. Import the snippet from your destination file and use the variable:

```mdx destination-file.mdx theme={null}
---
title: My title
description: My Description
---

import { myName, myObject } from '/snippets/path/to/custom-variables.mdx';

Hello, my name is {myName} and I like {myObject.fruit}.
```

### Reusable components

1. Inside your snippet file, create a component that takes in props by exporting
   your component in the form of an arrow function.

```mdx snippets/custom-component.mdx theme={null}
export const MyComponent = ({ title }) => (
  <div>
    <h1>{title}</h1>
    <p>... snippet content ...</p>
  </div>
);
```

<Warning>
  MDX does not compile inside the body of an arrow function. Stick to HTML
  syntax when you can or use a default export if you need to use MDX.
</Warning>

2. Import the snippet into your destination file and pass in the props

```mdx destination-file.mdx theme={null}
---
title: My title
description: My Description
---

import { MyComponent } from '/snippets/custom-component.mdx';

Lorem ipsum dolor sit amet.

<MyComponent title={'Custom title'} />
```


# Global Settings
Source: https://docs.tic.io/essentials/settings

Mintlify gives you complete control over the look and feel of your documentation using the mint.json file

Every Mintlify site needs a `mint.json` file with the core configuration settings. Learn more about the [properties](#properties) below.

## Properties

<ResponseField name="name" type="string">
  Name of your project. Used for the global title.

  Example: `mintlify`
</ResponseField>

<ResponseField name="navigation" type="Navigation[]">
  An array of groups with all the pages within that group

  <Expandable title="Navigation">
    <ResponseField name="group" type="string">
      The name of the group.

      Example: `Settings`
    </ResponseField>

    <ResponseField name="pages" type="string[]">
      The relative paths to the markdown files that will serve as pages.

      Example: `["customization", "page"]`
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="logo" type="string or object">
  Path to logo image or object with path to "light" and "dark" mode logo images

  <Expandable title="Logo">
    <ResponseField name="light" type="string">
      Path to the logo in light mode
    </ResponseField>

    <ResponseField name="dark" type="string">
      Path to the logo in dark mode
    </ResponseField>

    <ResponseField name="href" type="string">
      Where clicking on the logo links you to
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="favicon" type="string">
  Path to the favicon image
</ResponseField>

<ResponseField name="colors" type="Colors">
  Hex color codes for your global theme

  <Expandable title="Colors">
    <ResponseField name="primary" type="string">
      The primary color. Used for most often for highlighted content, section
      headers, accents, in light mode
    </ResponseField>

    <ResponseField name="light" type="string">
      The primary color for dark mode. Used for most often for highlighted
      content, section headers, accents, in dark mode
    </ResponseField>

    <ResponseField name="dark" type="string">
      The primary color for important buttons
    </ResponseField>

    <ResponseField name="background" type="object">
      The color of the background in both light and dark mode

      <Expandable title="Object">
        <ResponseField name="light" type="string">
          The hex color code of the background in light mode
        </ResponseField>

        <ResponseField name="dark" type="string">
          The hex color code of the background in dark mode
        </ResponseField>
      </Expandable>
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="topbarLinks" type="TopbarLink[]">
  Array of `name`s and `url`s of links you want to include in the topbar

  <Expandable title="TopbarLink">
    <ResponseField name="name" type="string">
      The name of the button.

      Example: `Contact us`
    </ResponseField>

    <ResponseField name="url" type="string">
      The url once you click on the button. Example: `https://mintlify.com/contact`
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="topbarCtaButton" type="Call to Action">
  <Expandable title="Topbar Call to Action">
    <ResponseField name="type" type={'"link" or "github"'}>
      Link shows a button. GitHub shows the repo information at the url provided including the number of GitHub stars.
    </ResponseField>

    <ResponseField name="url" type="string">
      If `link`: What the button links to.

      If `github`: Link to the repository to load GitHub information from.
    </ResponseField>

    <ResponseField name="name" type="string">
      Text inside the button. Only required if `type` is a `link`.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="versions" type="string[]">
  Array of version names. Only use this if you want to show different versions
  of docs with a dropdown in the navigation bar.
</ResponseField>

<ResponseField name="anchors" type="Anchor[]">
  An array of the anchors, includes the `icon`, `color`, and `url`.

  <Expandable title="Anchor">
    <ResponseField name="icon" type="string">
      The [Font Awesome](https://fontawesome.com/search?s=brands%2Cduotone) icon used to feature the anchor.

      Example: `comments`
    </ResponseField>

    <ResponseField name="name" type="string">
      The name of the anchor label.

      Example: `Community`
    </ResponseField>

    <ResponseField name="url" type="string">
      The start of the URL that marks what pages go in the anchor. Generally, this is the name of the folder you put your pages in.
    </ResponseField>

    <ResponseField name="color" type="string">
      The hex color of the anchor icon background. Can also be a gradient if you pass an object with the properties `from` and `to` that are each a hex color.
    </ResponseField>

    <ResponseField name="version" type="string">
      Used if you want to hide an anchor until the correct docs version is selected.
    </ResponseField>

    <ResponseField name="isDefaultHidden" type="boolean">
      Pass `true` if you want to hide the anchor until you directly link someone to docs inside it.
    </ResponseField>

    <ResponseField name="iconType" type="string">
      One of: "brands", "duotone", "light", "sharp-solid", "solid", or "thin"
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="topAnchor" type="Object">
  Override the default configurations for the top-most anchor.

  <Expandable title="Object">
    <ResponseField name="name" type="string">
      The name of the top-most anchor
    </ResponseField>

    <ResponseField name="icon" type="string">
      Font Awesome icon.
    </ResponseField>

    <ResponseField name="iconType" type="string">
      One of: "brands", "duotone", "light", "sharp-solid", "solid", or "thin"
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="tabs" type="Tabs[]">
  An array of navigational tabs.

  <Expandable title="Tabs">
    <ResponseField name="name" type="string">
      The name of the tab label.
    </ResponseField>

    <ResponseField name="url" type="string">
      The start of the URL that marks what pages go in the tab. Generally, this
      is the name of the folder you put your pages in.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="api" type="API">
  Configuration for API settings. Learn more about API pages at [API Components](/api-playground/demo).

  <Expandable title="API">
    <ResponseField name="baseUrl" type="string">
      The base url for all API endpoints. If `baseUrl` is an array, it will enable for multiple base url
      options that the user can toggle.
    </ResponseField>

    <ResponseField name="auth" type="Auth">
      <Expandable title="Auth">
        <ResponseField name="method" type="&#x22;bearer&#x22; | &#x22;basic&#x22; | &#x22;key&#x22;">
          The authentication strategy used for all API endpoints.
        </ResponseField>

        <ResponseField name="name" type="string">
          The name of the authentication parameter used in the API playground.

          If method is `basic`, the format should be `[usernameName]:[passwordName]`
        </ResponseField>

        <ResponseField name="inputPrefix" type="string">
          The default value that's designed to be a prefix for the authentication input field.

          E.g. If an `inputPrefix` of `AuthKey` would inherit the default input result of the authentication field as `AuthKey`.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="playground" type="Playground">
      Configurations for the API playground

      <Expandable title="Playground">
        <ResponseField name="mode" type="&#x22;show&#x22; | &#x22;simple&#x22; | &#x22;hide&#x22;">
          Whether the playground is showing, hidden, or only displaying the endpoint with no added user interactivity `simple`

          Learn more at the [playground guides](/api-playground/demo)
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="maintainOrder" type="boolean">
      Enabling this flag ensures that key ordering in OpenAPI pages matches the key ordering defined in the OpenAPI file.

      <Warning>This behavior will soon be enabled by default, at which point this field will be deprecated.</Warning>
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="openapi" type="string | string[]">
  A string or an array of strings of URL(s) or relative path(s) pointing to your
  OpenAPI file.

  Examples:

  <CodeGroup>
    ```json Absolute theme={null}
    "openapi": "https://example.com/openapi.json"
    ```

    ```json Relative theme={null}
    "openapi": "/openapi.json"
    ```

    ```json Multiple theme={null}
    "openapi": ["https://example.com/openapi1.json", "/openapi2.json", "/openapi3.json"]
    ```
  </CodeGroup>
</ResponseField>

<ResponseField name="footerSocials" type="FooterSocials">
  An object of social media accounts where the key:property pair represents the social media platform and the account url.

  Example:

  ```json theme={null}
  {
    "x": "https://x.com/mintlify",
    "website": "https://mintlify.com"
  }
  ```

  <Expandable title="FooterSocials">
    <ResponseField name="[key]" type="string">
      One of the following values `website`, `facebook`, `x`, `discord`, `slack`, `github`, `linkedin`, `instagram`, `hacker-news`

      Example: `x`
    </ResponseField>

    <ResponseField name="property" type="string">
      The URL to the social platform.

      Example: `https://x.com/mintlify`
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="feedback" type="Feedback">
  Configurations to enable feedback buttons

  <Expandable title="Feedback">
    <ResponseField name="suggestEdit" type="boolean">
      Enables a button to allow users to suggest edits via pull requests
    </ResponseField>

    <ResponseField name="raiseIssue" type="boolean">
      Enables a button to allow users to raise an issue about the documentation
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="modeToggle" type="ModeToggle">
  Customize the dark mode toggle.

  <Expandable title="ModeToggle">
    <ResponseField name="default" type={'"light" or "dark"'}>
      Set if you always want to show light or dark mode for new users. When not
      set, we default to the same mode as the user's operating system.
    </ResponseField>

    <ResponseField name="isHidden" type="boolean">
      Set to true to hide the dark/light mode toggle. You can combine `isHidden` with `default` to force your docs to only use light or dark mode. For example:

      <CodeGroup>
        ```json Only Dark Mode theme={null}
        "modeToggle": {
          "default": "dark",
          "isHidden": true
        }
        ```

        ```json Only Light Mode theme={null}
        "modeToggle": {
          "default": "light",
          "isHidden": true
        }
        ```
      </CodeGroup>
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="backgroundImage" type="string">
  A background image to be displayed behind every page. See example with
  [Infisical](https://infisical.com/docs) and [FRPC](https://frpc.io).
</ResponseField>


# Generate a client
Source: https://docs.tic.io/generate-client

Generate typed SDKs for 60+ languages from the TIC OpenAPI specs using the OpenAPI Generator.

Both TIC APIs publish OpenAPI specs. Run the [OpenAPI Generator](https://openapi-generator.tech/) against the spec URL to produce a typed client in your language of choice.

## Spec URLs

| API               | OpenAPI version | Spec URL                                       |
| ----------------- | --------------- | ---------------------------------------------- |
| **LENS API (v2)** | 3.1             | `https://lens-api.tic.io/docs/v1/swagger.json` |
| **Legacy v1 API** | 3.0             | `https://api.tic.io/docs/v1/swagger.json`      |

## Quick start

Generate a TypeScript client for the LENS API:

```bash theme={null}
npx @openapitools/openapi-generator-cli generate \
  -i https://lens-api.tic.io/docs/v1/swagger.json \
  -g typescript-fetch \
  -o ./tic-lens-client
```

Same pattern for Python:

```bash theme={null}
npx @openapitools/openapi-generator-cli generate \
  -i https://lens-api.tic.io/docs/v1/swagger.json \
  -g python \
  -o ./tic-lens-client-python
```

Swap `-g <generator>` to target a different language - see the [full generator list](https://openapi-generator.tech/docs/generators).

## Supported languages

The OpenAPI Generator covers 60+ targets including most common server and client languages:

**Backend:** C#, Go, Java, Kotlin, PHP, Python, Ruby, Rust, Scala, Swift, Elixir, Erlang, Haskell, Perl, Crystal.

**Frontend / mobile:** TypeScript (fetch, axios, node, angular, rxjs, redux-query, …), JavaScript, Dart, Swift, Kotlin (Android), Objective-C.

**Other:** Ada, Apex, Bash, C, C++, Clojure, Eiffel, Elm, Groovy, Julia, Lua, Nim, OCaml, PowerShell, R, Zapier.

For the full, current list including beta and experimental generators, see the [OpenAPI Generator documentation](https://openapi-generator.tech/docs/generators).

<Tip>
  Prefer the LENS spec for new clients - it's OpenAPI 3.1 with richer annotations, typed responses, and proper examples. Generate against v1 only if you're maintaining an existing v1 integration.
</Tip>


# Vector Maps
Source: https://docs.tic.io/maps/introduction

Daily-updated vector map tiles for Sweden - property, address, road, and environment layers. Works with Mapbox and MapLibre.

We provide advanced but simple to use vector maps with styles for displaying rich data about properties, addresses, roads and environment and many other things. You can use Mapbox or
MapLibre GL JS to render the maps in both web and mobile apps.

Maps are updated daily and hot swapped.

## Before Getting Started

Prior to using the maps engine you need to ensure you have proper access by allowing domains to use the API. Each domain you use to access our maps needs to be added which is very simple. You
add each domain by posting the domain to the [https://api.tic.io/teams/tiles/cors](https://api.tic.io/teams/tiles/cors) endpoint. If you want to access in development mode you can also add your localhost:port.

```bash cURL theme={null}
curl  \
--request POST
--header "Content-Type: application/json"
--header "x-api-key:your_api_key"
--data '{
  "Domain": "http://mydomain.com"
}'
https://api.tic.io/teams/tiles/cors
```

## Getting Started

This example shows how you get started with MapLibre GL JS in a webpage.

Include the JavaScript and CSS files in the head of your HTML file.

```HTML theme={null}
<script src='https://unpkg.com/maplibre-gl@latest/dist/maplibre-gl.js'></script>
<link href='https://unpkg.com/maplibre-gl@latest/dist/maplibre-gl.css' rel='stylesheet' />
```

Include the following code in the body of your HTML file.

```HTML theme={null}
<div id='map' style='width: 800px; height: 800px;'></div>

<script>
  var map = new maplibregl.Map({
      container: "map",
      style: "https://tiles2.tic.io/style/super-map-style2",
      center: [19.8756, 63.5569], // starting position [lng, lat]
      zoom: 4,  // starting zoom
      attributionControl: false
  });
</script>
```

## Draw additional details

Property borders and buildings are by default included in the style but if you wish to draw areas and greater details about building numbers, usage type etc you
can download the property details from [https://api.tic.io/datasets/properties/se/uuid](/api-core/properties/details). This endpoint gives you additional
data and areas.

In the example below we are adding four(4) layers:

* Areas
* Building parts (already included in the default style)
* Building parts text (number)
* Areas text (number)

Result will look like the example below where the area is filled with light blue opacity and buildings are drawn in yellow adding the text number.

<img alt="Vector map with areas and building numbers" />

For simplicity we are using Lodash.

Include the JavaScript and CSS files in the head of your HTML file.

```HTML theme={null}
<script src="https://cdn.jsdelivr.net/npm/lodash@4.17.21/lodash.min.js"></script>
<script src='https://unpkg.com/maplibre-gl@latest/dist/maplibre-gl.js'></script>
<link href='https://unpkg.com/maplibre-gl@latest/dist/maplibre-gl.css' rel='stylesheet' />
```

```HTML theme={null}
<div id='map' style='width: 800px; height: 800px;'></div>

<script>
  // See above make a request to
  // https://api.tic.io/datasets/properties/se/{uuid} (replace uuid with the property id)
  // in your server controller / backend
  const dataFromRequest = {};
  // Then copy and paste the code below

  const areas = dataFromRequest.omraden;
  const byggnader = dataFromRequest.byggnader;

  var map = new maplibregl.Map({
      container: "map",
      style: "https://tiles2.tic.io/style/super-map-style2",
      center: [19.8756, 63.5569], // starting position [lng, lat]
      zoom: 4,  // starting zoom
      attributionControl: false
  });

  let bounds = [];
  map.on('load', async () => {
      const coordinates = [];
      const geojsonOmraden = {
          type: 'geojson',
          data: {
              "type": 'FeatureCollection',
              "features": []
          }
      };
      _.forEach(omraden, function(omrade) {
          geojsonOmraden.data.features.push({
              type: 'Feature',
              properties: {
                  omradesnummer: omrade.omradesnummer
              },
              geometry: {
                  type: 'Polygon',
                  coordinates: omrade.omradeYta
              }
          });
          _.forEach(omrade.omradeYta[0], i => coordinates.push(i));
      });
      map.addSource('omraden', geojsonOmraden);
      map.addLayer({
          'id': 'omraden',
          'type': 'fill',
          'source': 'omraden',
          'paint': {
              'fill-color': '#90E0EF',
              'fill-opacity': 0.7
          },
          'filter': ['==', '$type', 'Polygon']
      });

      const geojsonByggnadsdelar = {
          type: 'geojson',
          data: {
              "type": 'FeatureCollection',
              "features": []
          }
      };

      _.forEach(byggnader, function(byggnad) {
          _.forEach(byggnad.delar, function(del) {
              geojsonByggnadsdelar.data.features.push({
                  type: 'Feature',
                  properties: {
                      byggnadHusnummer: byggnad.byggnadHusnummer
                  },
                  geometry: {
                      type: 'Polygon',
                      coordinates: [del.byggnadsdelYta]
                  }
              });
          });
      });

      map.addSource('byggnadsdelar', geojsonByggnadsdelar);
      map.addLayer({
          'id': 'byggnadsdelar',
          'type': 'fill',
          'source': 'byggnadsdelar',
          'paint': {
              'fill-color': '#FDC86C',
              'fill-opacity': 0.8,
              'fill-outline-color': '#F9A107'
          },
          'filter': ['==', '$type', 'Polygon']
      });

      map.addLayer({
          'id': 'byggnadsdelartext',
          'type': 'symbol',
          'source': 'byggnadsdelar',
          "layout": {
              "text-field": [
                  "concat",
                  "Husnr: ",
                  ["get", "byggnadHusnummer"],
              ],
              "text-font": ["Open Sans SemiBold"],
              "text-size": {
                  "stops": [
                      [2, 10],
                      [4, 12],
                      [6, 12],
                      [12, 12],
                      [16, 16]
                  ]
              },
              "visibility": "visible"
          },
          "paint": {
              "text-color": "#000",
              "text-halo-blur": 1,
              "text-halo-color": "rgba(255, 255, 255, 1)",
              "text-halo-width": 1
          },
          'filter': ['==', '$type', 'Polygon']
      });

      map.addLayer({
          'id': 'omradesnummertext',
          'type': 'symbol',
          'source': 'omraden',
          "layout": {
              "text-field": [
                  "concat",
                  "Omrnr: ",
                  ["get", "omradesnummer"],
              ],
              "text-font": ["Open Sans SemiBold"],
              "text-size": {
                  "stops": [
                      [2, 10],
                      [4, 12],
                      [6, 12],
                      [12, 12],
                      [16, 16]
                  ]
              },
              "visibility": "visible"
          },
          "paint": {
              "text-color": "#000",
              "text-halo-blur": 1,
              "text-halo-color": "rgba(255, 255, 255, 1)",
              "text-halo-width": 1
          },
          'filter': ['==', '$type', 'Polygon']
      });

      const bounds = coordinates.reduce((bounds, coord) => {
          return bounds.extend(coord);
      }, new maplibregl.LngLatBounds(coordinates[0], coordinates[0]));

      map.fitBounds(bounds, {
          padding: 120,
          duration: 0
      });

  });
</script>
```

## Custom Styles

You can copy the style that we provide and make your own adjustments. We recommend using [Maputnik](https://maputnik.github.io/) which is a visual editor for
MapLibre and MapBox style specifiation. It allows you to make modifications to your style and save the json style sheet and host it yourself.

Each source object in the style reference our tileserver, tiles2.tic.io, which requires CORS. Therefore ensure you have added your domain to the API. Each URL consists of
the following format which contains four(4) parts in the URL that should be replaced [https://tiles2.tic.io/database.schema.table.column](https://tiles2.tic.io/database.schema.table.column) e.g database, schema, table and column.

You have access to the following databases that are updated daily and runs on PostGIS with PostgreSQL. The tile server serves tiles cached and it's extremley fast

| Database                | Description                                                                                    |
| ----------------------- | ---------------------------------------------------------------------------------------------- |
| lm\_belagenhetsadress   | Contains all information relating to an address                                                |
| lm\_fastighetsindelning | Contains all information relating to an property                                               |
| lm\_top1m               | Contains topography 1:1M                                                                       |
| lm\_top10               | Contains topography 1:10                                                                       |
| lm\_top10               | Contains topography 1:10                                                                       |
| naturalearth            | Contains [Natural Earth](https://www.naturalearthdata.com/)                                    |
| ormeo                   | Contains extended databases such as the EBH which is a national database of contaminated areas |

Check next section for a full data dictionary.

## Data Dictionary

Each databases consists of geometric tables and in total they are 248. Each table then contains a range of columns that can be used to be displayed on the map. For simplicity we are adding
a full data dictionary in PDF (582 pages) that you can download and easier search in and pick the fields you want to display.

[Download the data dictionary here](https://content.tic.io/tic/DataDictionary_20250720201303.pdf)

Adding a source layer is very simple in the style sheet and we have made an example below.

Let's say you want to show railroads in the map (enabled by default in our stylesheet), you check the PDF-dictionary and find that there is a table called ralstrafik (English: rail roads)
and the column geom contains the geometry of the railroads.

Just add a source object with the nickname "ralstrafik" and you are done:

```json theme={null}
"ralstrafik": {
      "type": "vector",
      "url": "https://tiles2.tic.io/lm_top10.table.public.ralstrafik.geom"
    },
```

This should be interpreted as

Database = lm\_top10
Schema = public
Table = ralstrafik
Column = geom

<Tip>
  Please note that the data directory contains a suffix on the databases in the
  format \_YYYYMMDD which should NOT be included in the URL. It just shows when
  the table was most recentley updated
</Tip>


# MCP Server
Source: https://docs.tic.io/mcp/introduction

Use the TIC MCP (Model Context Protocol) server in AI applications - prompts, resources, and tools for Claude, OpenAI, and other LLMs.

We provide an MCP (Model Context Protocol) server with prompts, resources and tools that you can use for building AI-applications. The
server uses streamable HTTP transport providing real-time communication with Server-Sent Events (SSE) streaming support.

## Getting Started

Our MCP server is located at [https://mcp.tic.io](https://mcp.tic.io). It accepts your TIC API key via either of two headers:

* `x-api-key: <your_api_key>` - same scheme as our REST API
* `Authorization: Bearer <your_api_key>` - for clients (such as the Anthropic Messages API connector) that only forward an OAuth-style bearer token

Either form authenticates the same way against the same key. Pick whichever your MCP client supports.

## Example of using OpenAI Responses API

OpenAI Responses API is the most advanced interface for generating model responses. Full documentation for the API is available [here](https://platform.openai.com/docs/api-reference/responses).

Endpoint: [https://api.openai.com/v1/responses](https://api.openai.com/v1/responses)

Note you need to include Bearer authentication for the OpenAI to work. An example of the request body follows below that is using flagship gpt-5 model.

```json theme={null}
{
  "model": "gpt-5",
  "input": [
    {
      "role": "developer",
      "content": [
        {
          "type": "input_text",
          "text": "Talk like a chief financial officer"
        }
      ]
    },
    {
      "role": "user",
      "content": [
        {
          "type": "input_text",
          "text": "Get company information for Bahnhof AB (publ)."
        }
      ]
    }
  ],
  "text": {
    "format": {
      "type": "text"
    },
    "verbosity": "medium"
  },
  "reasoning": {
    "effort": "medium",
    "summary": "auto"
  },
  "tools": [
    {
      "type": "mcp",
      "allowed_tools": [
        "get_company_by_registration_number",
        "get_company_by_name",
        "get_company_by_company_id",
        "get_companies_by_sni_code",
        "get_financial_reports",
        "get_annual_reports",
        "get_risk_and_intelligence",
        "get_credit_score",
        "get_company_risk_summary",
        "get_company_debt_cases",
        "get_company_penalties",
        "get_company_lansstyrelsen_decisions",
        "get_company_kammarkollegiet_sanctions",
        "get_company_tax_deferrals",
        "get_company_business_mortgages",
        "get_company_payroll_history",
        "get_company_share_structure",
        "get_company_address_history",
        "get_company_name_history",
        "get_company_vehicles",
        "get_company_bankruptcies"
      ],
      "headers": {
        "x-api-key": "your_api_key"
      },
      "require_approval": "never",
      "server_label": "TIC",
      "server_url": "https://mcp.tic.io"
    }
  ],
  "store": true,
  "include": ["reasoning.encrypted_content"]
}
```

## Example of using Anthropic Messages API

Anthropic's Messages API can call remote MCP servers directly through its MCP connector. Full documentation is available [here](https://docs.claude.com/en/docs/agents-and-tools/mcp-connector).

Endpoint: `https://api.anthropic.com/v1/messages`

You need three headers on the request:

* `x-api-key: <your_anthropic_api_key>` - your Anthropic API key
* `anthropic-version: 2023-06-01`
* `anthropic-beta: mcp-client-2025-11-20`

The `authorization_token` field on the MCP server entry is forwarded by Anthropic to our server as `Authorization: Bearer <token>` - pass your **TIC** API key there. An example request body:

```json theme={null}
{
  "model": "claude-opus-4-7",
  "max_tokens": 1024,
  "messages": [
    {
      "role": "user",
      "content": "Get company information for Bahnhof AB (publ)."
    }
  ],
  "mcp_servers": [
    {
      "type": "url",
      "url": "https://mcp.tic.io",
      "name": "tic",
      "authorization_token": "your_tic_api_key"
    }
  ],
  "tools": [
    {
      "type": "mcp_toolset",
      "mcp_server_name": "tic"
    }
  ]
}
```

To restrict which TIC tools the model can see, use the `mcp_toolset` allowlist pattern - disable everything by default, then enable specific tools:

```json theme={null}
{
  "tools": [
    {
      "type": "mcp_toolset",
      "mcp_server_name": "tic",
      "default_config": { "enabled": false },
      "configs": {
        "get_company_by_registration_number": { "enabled": true },
        "get_company_risk_summary":            { "enabled": true },
        "get_company_debt_cases":              { "enabled": true },
        "get_company_penalties":               { "enabled": true }
      }
    }
  ]
}
```

## Example of LibreChat configuration

If you wish to use our MCP in LibreChat you simply add a block inside mcpServers section in yaml configuration file:

```yaml librechat.yaml theme={null}
mcpServers:
  tic:
    type: streamable-http
    url: https://mcp.tic.io
    headers:
      x-api-key: 'your_api_key'
```

## Example of prompt and response

This shows an example of a user input prompt and the response. The request is using gpt-4.1.

<img alt="Clean page" />

## Prompts

Prompts are user-invokable workflow templates that combine multiple tools into a single
investigation flow with explicit framing and a named deliverable. Pick one from your
MCP client's prompt menu to kick off an end-to-end analysis.

Most prompts take `registrationNumber` (Swedish organisationsnummer, e.g. `556519-9493`) and resolve identity to the
internal companyId as their first step. `build_prospect_list` is the exception - it starts from a free-text brief rather
than a known company.

| Prompt                     | Parameters           | What it does                                                                                                                                                       |
| -------------------------- | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| investigate\_company       | `registrationNumber` | Full company workup: identity, risk, debts, penalties, addresses, naming, share structure. Deliverable: red-flag report grouped by category.                       |
| liquidity\_stress\_check   | `registrationNumber` | Combines credit risk, Skatteverket tax deferrals, Kronofogden debts, and payroll trend. Deliverable: stress score (Low/Medium/High/Critical) with evidence.        |
| due\_diligence\_check      | `registrationNumber` | Know-Your-Business check. Resolves identity then runs the full workup. Deliverable: KYB verdict (Proceed / Conditions / Decline).                                  |
| shell\_company\_indicators | `registrationNumber` | Screens for shell-company / fraud signals: name churn, address intelligence, missing payroll, share-capital anomalies. Deliverable: shell likelihood + indicators. |
| build\_prospect\_list      | `brief`              | Turns a free-text ideal-customer brief into firmographic search filters, calibrates on the result count, and returns a qualified, contactable lead list.           |

## Resources

Resources are static reference data the model reads once into context - no tool call required.
They decode the codes that appear in tool responses.

| URI                     | What it contains                                                                                                                                  |
| ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
| ormeo://reference/codes | Decoder for `LocalCompanyCode` (Swedish legal-form codes: AB, HB, KB, BRF, EK, SF, FL, …) and Kronofogden `KFM_DebtCaseType` (A vs E debt cases). |

## Tools

Functions the model invokes to retrieve company, property, or vehicle data. Tools are grouped
below by purpose.

### Company search & identity

| Tool                                   | Description                                                                                                                                 |
| -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| get\_company\_by\_name                 | Find a company by current or historical name                                                                                                |
| get\_company\_by\_registration\_number | Find a company by Swedish registration number (organisationsnummer)                                                                         |
| get\_company\_by\_company\_id          | Get the core company record by internal companyId                                                                                           |
| get\_companies\_by\_sni\_code          | List companies matching a 5-digit SNI industry code. Supports both SNI 2007 and SNI 2025 - pass `sniStandard="2007"` (default) or `"2025"`. |

### Company financials & risk

| Tool                         | Description                                                                                                                                                                                                                                                                     |
| ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| get\_financial\_reports      | Income statement and balance sheet across all available periods (TKR, SEK)                                                                                                                                                                                                      |
| get\_annual\_reports         | List of available annual reports in PDF with metadata and download URLs                                                                                                                                                                                                         |
| get\_credit\_score           | Current credit score and the descriptions used as the basis of the calculation                                                                                                                                                                                                  |
| get\_company\_risk\_summary  | Numeric risk scores: credit score, forward risk forecast/class, board score, beneficial-owners score, financial-discrepancy score, other-intelligence score, intelligence aggregates, and ORB network-risk aggregate counts. Scores only - no per-person details. 4-hour cache. |
| get\_risk\_and\_intelligence | Raw company-intelligence records (flags and signals collected over time)                                                                                                                                                                                                        |

### Company enforcement & compliance

| Tool                                     | Description                                                                                        |
| ---------------------------------------- | -------------------------------------------------------------------------------------------------- |
| get\_company\_debt\_cases                | Kronofogden enforcement: debtor summary, debt summary, current cases, weekly aggregates            |
| get\_company\_penalties                  | Consolidated penalties (Skatteverket, Kammarkollegiet, Länsstyrelsen, Försäkringskassan, fees)     |
| get\_company\_lansstyrelsen\_decisions   | Länsstyrelsen (County Administrative Board) decisions and penalty fees                             |
| get\_company\_kammarkollegiet\_sanctions | Kammarkollegiet sanction cases grouped by diary number, with current balance and full case history |
| get\_company\_tax\_deferrals             | Skatteverket TF-ANST temporary tax-payment deferrals (liquidity-stress signal)                     |
| get\_company\_bankruptcies               | Bankruptcies initiated on a given date                                                             |

### Company structure & history

| Tool                              | Description                                                                                    |
| --------------------------------- | ---------------------------------------------------------------------------------------------- |
| get\_company\_business\_mortgages | Bolagsverket-registered business mortgages (företagsinteckningar) - collateral encumbrance     |
| get\_company\_payroll\_history    | Skatteverket MOMS-AG (VAT/employer tax) filings and aggregated CompanyPayroll2 history         |
| get\_company\_share\_structure    | Registered share capital over time and share-class structure (A/B/C, …) from Bolagsverket      |
| get\_company\_address\_history    | All addresses (visiting, mailing, registered) enriched with active AddressIntelligence signals |
| get\_company\_name\_history       | Current and historical legal names plus trade names (bifirma)                                  |

### Vehicles

| Tool                             | Description                                              |
| -------------------------------- | -------------------------------------------------------- |
| get\_company\_vehicles           | Vehicles owned or operated by a company                  |
| get\_vehicle\_by\_license\_plate | Look up a vehicle by license plate                       |
| get\_vehicle\_by\_vin            | Look up a vehicle by VIN (vehicle identification number) |

### Property

| Tool                        | Description                                                                            |
| --------------------------- | -------------------------------------------------------------------------------------- |
| get\_property\_by\_label    | Find a property by its label (property designation / fastighetsbeteckning)             |
| get\_orthophoto\_by\_year   | Get an orthophoto for a property; leave year empty for the most recent year            |
| list\_property\_orthophotos | List every available orthophoto for a property, optionally filtered to one flight year |
| get\_property\_by\_location | Find the property at a latitude/longitude position (WGS84)                             |

### Prospecting & registers

| Tool                          | Description                                                                                          |
| ----------------------------- | ---------------------------------------------------------------------------------------------------- |
| search\_companies\_for\_leads | Firmographic company search for building sales lead lists. See below for the filter set.             |
| search\_lei                   | Search the LEI register (Legal Entity Identifiers) by name, LEI code or national registration number |

#### search\_companies\_for\_leads

The broadest tool on the server. It combines free-text matching against company name, business purpose
(verksamhet) and SNI industry names with structured firmographic filters, and returns a paged lead list.

| Filter group    | Parameters                                                                                                                                                                          |
| --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Text & industry | `purposeOrKeywords`, `sniCode` - the SNI filter matches SNI 2025 **or** SNI 2007, so a company is found whether or not it has been reclassified yet                                 |
| Geography       | `county`, `municipality` - by official name (e.g. `"Stockholm"`, `"Skane"`) or SCB numeric code                                                                                     |
| Size            | `minNetSalesThousandSEK`, `maxNetSalesThousandSEK`, `minEmployees`, `maxEmployees` - matched against SCB size-class bands, which cover far more companies than filed annual reports |
| Contactability  | `requireEmailAddress`, `requirePhoneNumber`, `requireWebsite`                                                                                                                       |
| Registrations   | `onlyVATRegistered`, `onlyFTaxRegistered`, `onlyEmployers`, `legalForm`                                                                                                             |
| Risk            | `excludeCompaniesWithKfmRecord` - drops any company with a Kronofogden debtor record                                                                                                |
| Incorporation   | `registeredAfter`, `registeredBefore`                                                                                                                                               |
| Paging & sort   | `pageNumber`, `pageSize` (max 250), `sortBy` - one of `registrationDateNewest`, `registrationDateOldest`, `debtBalance`                                                             |

Size filters are bucketed: pass a number and it maps to the SCB band containing it. Sorting by turnover or
employee count is not available, because the SCB size-class field is not sortable - filter on it instead.

#### search\_lei

| Parameter                | Description                                                                                                                                                |
| ------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `query`                  | Free text matched against legal name, LEI code and national registration number                                                                            |
| `jurisdiction`           | ISO 3166 country code, e.g. `"SE"`, `"FI"`, `"DE"`. US entities are registered per state, e.g. `"US-DE"`                                                   |
| `registrationStatus`     | `ISSUED`, `LAPSED`, `PENDING_VALIDATION`, `PENDING_TRANSFER`, `PENDING_ARCHIVAL`, `TRANSFERRED`, `DUPLICATE`, `RETIRED`, `ANNULLED`, `CANCELLED`, `MERGED` |
| `entityStatus`           | `ACTIVE` or `INACTIVE`                                                                                                                                     |
| `sortBy`                 | `registrationDateNewest` or `registrationDateOldest`                                                                                                       |
| `pageNumber`, `pageSize` | Paging; `pageSize` maxes out at 250                                                                                                                        |

We will continuously add new tools - check back here for new additions.


# Search
Source: https://docs.tic.io/search

Lightning-fast search across companies, persons, workplaces, properties, vehicles, bankruptcies, and annual reports - with search-as-you-type, autocomplete, geo-search, and LLM augmentation.

<Info>
  This page is a shared introduction to our Typesense-backed search. For **LENS (v2)** deep examples - geo-search, SNI codes, intelligence filters, stock-listed companies, and the full parameter reference - see [Search in the v2 API](/api-lens/search).
</Info>

We provide an easy to use search API based on [Typesense](https://typesense.org) lightning-fast search database.
That means that all features described in [Typesense API version 29](https://typesense.org/docs/29.0/api/) is available in our API.

Search index is stored on RAM memory meaning requests to our search serves very fast and you can use it for search-as-you-type,
autocomplete and other applications.

We today provide five rich search collections:

* **Company search (you are here)**
* [Workplace search](/datasets/search-workplaces)
* [Financial reports search](/datasets/search-reports-se)
* [Bankruptcies](/datasets/search-bankruptcies-se)
* [Vehicles](/datasets/search-vehicles)

## Company search

In companies search you can query and filter by more than **187 fields** listed in the next chapter.

Examples on what you can query on:

* Company Id (our system wide identifier for global companies used across all API calls)
* Country code (ISO 2 letters)
* Registrationnumber (For local region)
* Most recent purpose
* Names (all historic and current names)
* Phonenumbers
* Email addresses
* Hyperlinks
* Bankaccounts
* Addresses (registered, visting and mailing address)
* Document and case history
* Stock
* LEI
* PIC (European Commission)
* Franchises and licences
* Involvement by representatives
* Company representatives
* Beneficial owners
* Property tax
* Vehicles

The response model (schema) depends on your query and if you use faceting. If you
do plain search we have added to our OpenAPI Schema the default response
model namned TypesenseCompanyDocument.

<Card title="OpenAPI Schema" icon="link" href="https://api.tic.io/docs/v1/swagger.json">
  Look for the model name TypesenseCompanyDocument in the schema definition.
</Card>

## Important about redacted properties

Depending on price plan certain properties may not be included. For simplicity we add an object called redacted which contains
a list of redacted properties. An example below shows how the JSON response would look like if you for example don't have AUDITOR\_ACCOUNTING\_ISSUES
to the properties mostRecentDebtorSummary and currentBeneficialOwners.

```bash json theme={null}
"redacted": ['mostRecentDebtorSummary','currentBeneficialOwners']...
```

## Important about changes from SNI 2007 to 2025

On december 10 the Statistics Sweden (SCB) started to change SNI codes for companies. This means that from that time we output the most recent SNI 2007 code, name, rank and section but
also include the most recent SNI 2025 code, name, rank and section. This means that if you use the SNI code to provide searches you should as an interim solution provide search
for both SNI 2025 and SNI 2007 or pick rather 2025 than the earlier.

If you continue to search for only SNI 2007 codes you will not be able to track changes of SNI codes since the SNI 2007 code is the last known record for SNI 2007 and not
necessarily the most recent.

## Fields indexed

The following fields are currently indexed in memory. These can be used in the query\_by parameter and filter\_by. Remember this is not the
schema of the JSON response since it contains a large number of additional properties.

| Field                                                        | Type     | Description                                                                                                                                    |
| ------------------------------------------------------------ | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
| companyId                                                    | Int32    | Our global internal company identifier                                                                                                         |
| registrationNumber                                           | String   | The local registration number in the country                                                                                                   |
| legalEntityType                                              | String   | Type of legal entity as described in local market                                                                                              |
| localCompanyCode                                             | String   | The local company code as known by the market (for example Aktiebolag = AB)                                                                    |
| elfCode                                                      | String   | ISO Standard 20275 Entity Legal Form (ELF)                                                                                                     |
| registrationDate (unix epoch)                                | Int64    | Unix time (epoch) seconds since 1st January 1970                                                                                               |
| ceasedDate (unix epoch)                                      | Int64    | Unix time (epoch) seconds since 1st January 1970, when the company ceased to exist (note date may be unknown by the flag isCeased will be set) |
| isCeased                                                     | Bool     | A flag indicating the business have ceased                                                                                                     |
| mostRecentPurpose                                            | String   | The last purpose registered for the business                                                                                                   |
| names.nameOrIdentifier                                       | String   | Current and former names of the business (could be legalname, particularName etc)                                                              |
| isRegisteredForVAT                                           | Bool     | If the business is registered for VAT                                                                                                          |
| isRegisteredForFTax                                          | Bool     | If the business is registered for F-tax                                                                                                        |
| isRegisteredForPayroll                                       | Bool     | If the business is registered for payroll                                                                                                      |
| ftaxTerminationReason                                        | String   | If the termination of F-tax is known a description                                                                                             |
| phoneNumbers.e164PhoneNumber                                 | String   | E164 formatted phone number                                                                                                                    |
| phoneNumbers.numberPlanServiceType                           | String   | Service type as described in local number plan                                                                                                 |
| phoneNumbers.orginalOperator                                 | String   | The original operator that held the number                                                                                                     |
| phoneNumbers.priorOperator                                   | String   | Last prior operator before the porting                                                                                                         |
| phoneNumbers.currentOperator                                 | String   | Current operator                                                                                                                               |
| phoneNumbers.lastPortingDate                                 | Int64    | Last porting date in Unix time (epoch) seconds since 1st January 1970                                                                          |
| emailAddresses.emailAddress                                  | String   | E-mail addresses to the business                                                                                                               |
| hyperlinks.hyperlink                                         | String   | Hyperlinks to the business                                                                                                                     |
| sniCodes.sni\_2007Name                                       | String   | SNI 2007 name                                                                                                                                  |
| sniCodes.sni\_2007Code                                       | String   | SNI 2007 code                                                                                                                                  |
| sniCodes.sni\_2007Section                                    | String   | SNI 2007 section                                                                                                                               |
| sniCodes.sni\_2025Name                                       | String   | SNI 2007 name                                                                                                                                  |
| sniCodes.sni\_2025Code                                       | String   | SNI 2007 code                                                                                                                                  |
| sniCodes.sni\_2025Section                                    | String   | SNI 2025 section                                                                                                                               |
| sniCodes.rank                                                | String   | SNI 2007/2025 order                                                                                                                            |
| bankAccounts.accountNumber                                   | String   | Bank accounts                                                                                                                                  |
| mostRecentRegisteredAddress.co                               | String   | C/O = care of address                                                                                                                          |
| mostRecentRegisteredAddress.streetAddress                    | String   | Street address                                                                                                                                 |
| mostRecentRegisteredAddress.postalCode                       | String   | The postalcode                                                                                                                                 |
| mostRecentRegisteredAddress.city                             | String   | City                                                                                                                                           |
| mostRecentRegisteredAddress.countryCodeAlpha3                | String   | Country code 3 char alpha                                                                                                                      |
| mostRecentRegisteredAddress.location                         | GeoPoint | Allows geosearch                                                                                                                               |
| mostRecentMailingAddress.co                                  | String   | C/O = care of address                                                                                                                          |
| mostRecentMailingAddress.streetAddress                       | String   | Street address                                                                                                                                 |
| mostRecentMailingAddress.postalCode                          | String   | The postalcode                                                                                                                                 |
| mostRecentMailingAddress.city                                | String   | City                                                                                                                                           |
| mostRecentMailingAddress.countryCodeAlpha3                   | String   | Country code 3 char alpha                                                                                                                      |
| mostRecentMailingAddress.location                            | GeoPoint | Allows geosearch                                                                                                                               |
| mostRecentVisitingAddress.co                                 | String   | C/O = care of address                                                                                                                          |
| mostRecentVisitingAddress.streetAddress                      | String   | Street address                                                                                                                                 |
| mostRecentVisitingAddress.postalCode                         | String   | The postalcode                                                                                                                                 |
| mostRecentVisitingAddress.city                               | String   | City                                                                                                                                           |
| mostRecentVisitingAddress.countryCodeAlpha3                  | String   | Country code 3 char alpha                                                                                                                      |
| mostRecentVistingAddress.location                            | GeoPoint | Allows geosearch                                                                                                                               |
| registeredOffices.municipality                               | String   | The registered office municipality (säte)                                                                                                      |
| registeredOffices.municipalityCode                           | String   | The registered office municipality code (säte)                                                                                                 |
| registeredOffices.county                                     | String   | The registered office county (säte)                                                                                                            |
| registeredOffices.countyCode                                 | String   | The registered office county code (säte)                                                                                                       |
| documents.documentTitle                                      | String   | Title of the document                                                                                                                          |
| documents.documentVersion                                    | String   | Version of the document                                                                                                                        |
| documents.documentValue3                                     | String   | Used to provide additional data about the document                                                                                             |
| intelligence.companyIntelligenceType                         | String   | The specific enum (int) that you want to query by                                                                                              |
| intelligence.companyIntelligenceSubType                      | String   | A text enum describing the sub-type of the intelligence type (see documentation)                                                               |
| intelligence.notes                                           | String   | The description of the discrepancy                                                                                                             |
| intelligence.score                                           | Int32    | A score rank between 0-255 where 0 means only for information and 255 is a serious mark                                                        |
| intelligence.externalId                                      | Int32    | A reference for the intelligence type used to find the associated underlying document                                                          |
| mostRecentFinancialSummary.annualReportPeriod                | Int32    | The endpoint report of the annual report in YYYYMM as Int32                                                                                    |
| mostRecentFinancialSummary.periodStart                       | Int64    | Start period epoch seconds                                                                                                                     |
| mostRecentFinancialSummary.periodEnd                         | Int64    | End period epoch seconds                                                                                                                       |
| mostRecentFinancialSummary.rs\_NetSalesK                     | Int32    | Net sales in K (thousands)                                                                                                                     |
| mostRecentFinancialSummary.rs\_OtherOperatingIncomeK         | Int32    | Other operating income in K (thousands)                                                                                                        |
| mostRecentFinancialSummary.rs\_OperatingProfitOrLossK        | Int32    | Operating profit or loss in K (thousands)                                                                                                      |
| mostRecentFinancialSummary.rs\_SumFinancialItemsK            | Int32    | Sum of financial items in K (thousands)                                                                                                        |
| mostRecentFinancialSummary.rs\_ProfitAfterFinancialItemsK    | Int32    | Profit after financial items in K (thousands)                                                                                                  |
| mostRecentFinancialSummary.bs\_TotalAssetsK                  | Int32    | Total assets in balance sheet in K (thouands)                                                                                                  |
| mostRecentFinancialSummary.fn\_NumberOfEmployees             | Float    | Number of employees with one decimal                                                                                                           |
| mostRecentFinancialSummary.km\_OperatingMargin               | Float    | Operating margin with four decimals                                                                                                            |
| mostRecentFinancialSummary.km\_NetProfitMargin               | Float    | Net profit margin with four decimals                                                                                                           |
| mostRecentFinancialSummary.km\_EquityAssetsRatio             | Float    | Equity asset ratio with four decimals                                                                                                          |
| mostRecentFinancialSummary.km\_GrossMargin                   | Float    | Gross margin with four decimals                                                                                                                |
| mostRecentFinancialSummary.software                          | String   | Software used to generate the financial report (if known)                                                                                      |
| mostRecentSignatory.signatureDescription                     | String   | Description of the signature rights                                                                                                            |
| currentRepresentatives.personId                              | Int32    | An internal id representing the person which makes it simpler to query                                                                         |
| mostRecentDebtorSummary.debtBalance.totalAmountInSEK         | Float    | Holds the total amount, currency SEK, out outstanding debts of public- vs. private debt cases in Sweden                                        |
| mostRecentDebtorSummary.debtBalance.public.description       | String   | The public case debt type and creditor                                                                                                         |
| mostRecentDebtorSummary.debtBalance.public.numberOfCases     | Int32    | Number of public debt cases relating to public debt                                                                                            |
| mostRecentDebtorSummary.debtBalance.public.totalAmountInSEK  | Float    | Total amount outstanding debt for public debt cases                                                                                            |
| mostRecentDebtorSummary.debtBalance.private.numberOfCases    | Int32    | Number of private debt cases relating to public debt                                                                                           |
| mostRecentDebtorSummary.debtBalance.private.totalAmountInSEK | Float    | Total amount private debt for public debt cases                                                                                                |
| currentRepresentatives.personalIdentityNumber                | String   | The local market personal identity number                                                                                                      |
| currentRepresentatives.positionType                          | String   | The position of the representative                                                                                                             |
| currentRepresentatives.positionDescription                   | String   | Text description of the position                                                                                                               |
| currentRepresentatives.fullName                              | String   | Fullname of the person                                                                                                                         |
| currentRepresentatives.roleByCompanyName                     | String   | If the position is held by a company                                                                                                           |
| currentRepresentatives.roleByCompanyRegistrationNumber       | String   | If the position is held by a company                                                                                                           |
| currentRepresentatives.auditorType                           | String   | Auditor type                                                                                                                                   |
| currentRepresentatives.bornYearMonthDay                      | String   | For foreign persons                                                                                                                            |
| currentBeneficialOwners.personId                             | Int32    | An internal id representing the person which makes it simpler to query                                                                         |
| currentBeneficialOwners.personalIdentityNumber               | String   | The local market personal identity number                                                                                                      |
| currentBeneficialOwners.fullName                             | String   | Fullname of the person                                                                                                                         |
| currentBeneficialOwners.countryOfResidenceCode               | String   | ISO3166 Country code 2-char                                                                                                                    |
| currentBeneficialOwners.citizenshipCountryCode               | String   | ISO3166 Country code 2-char                                                                                                                    |
| currentBeneficialOwners.extentDescription                    | String   | Description of the extent                                                                                                                      |
| currentBeneficialOwners.governDescription                    | String   | Description of the govern                                                                                                                      |
| currentBeneficialOwners.throughName                          | String   | If managed through a name / company                                                                                                            |
| currentBeneficialOwners.throughRegistrationNumber            | String   | If managed through a name / company                                                                                                            |
| currentBeneficialOwners.bornYearMonthDay                     | String   | For foreign persons                                                                                                                            |
| mostRecentSignatory.signatureDescription                     | String   | The signature description                                                                                                                      |
| mostRecentShareCapital.shareCapitalAmount                    | Float    | The current share capital amount                                                                                                               |
| franchisesOrLicences.linkedToName                            | String   | From which company name is the franchise, licence or permit given                                                                              |
| franchisesOrLicences.actingUnderName                         | String   | Under which name is the business providing services or sales of goods                                                                          |
| franchisesOrLicences.linkedToCompanyId                       | Int32    | From which company id is the franchise, licence or permit given                                                                                |
| franchisesOrLicences.description                             | String   | Description of the franchise, licence or permit given                                                                                          |
| franchisesOrLicences.companyFranchiseOrLicenceType           | String   | Type of franchise, licence or permit (franchise, licence, membership, agent, other)                                                            |
| currentWorkplaces.companyWorkplaceId                         | Int32    | Our worldwide identifier for the workplace                                                                                                     |
| currentWorkplaces.workplaceCode                              | Int32    | A code for the workplace                                                                                                                       |
| currentWorkplaces.mostRecentName                             | Int32    | The name of workplace                                                                                                                          |
| currentWorkplaces.labelAddress                               | String   | A label containing the street address, postalcode and city                                                                                     |
| currentWorkplaces.location                                   | GeoPoint | Allows geosearch                                                                                                                               |
| trademarks.word                                              | String   | The word representing a word-trademark                                                                                                         |
| trademarks.expire                                            | Int64    | When the trademark expire in Unix time (epoch) seconds since 1st January 1970                                                                  |
| stock.isin                                                   | String   | ISIN                                                                                                                                           |
| stock.ticker                                                 | String   | Ticker symbol on market                                                                                                                        |
| stock.marketName                                             | String   | Market name                                                                                                                                    |
| stock.marketExchangeName                                     | String   | Market exchange name                                                                                                                           |
| stock.sectorName                                             | String   | Business sector as provided on market                                                                                                          |
| stock.branchName                                             | String   | Business branch as provided on market                                                                                                          |
| stock.enterpriseValue                                        | String   | Enterprise value last closing day                                                                                                              |
| stock.nextReportDate                                         | String   | Next report date for the listed company                                                                                                        |
| stock.dividendExDate                                         | String   | Next X-date to receive the dividend                                                                                                            |
| stock.yahooSymbol                                            | String   | The Yahoo finance symbol                                                                                                                       |
| lei.leiCode                                                  | String   | LEI Code                                                                                                                                       |
| lei.registrationStatus                                       | String   | RETIRED, DUPLICATE, LAPSED, ANNULLED, PENDING\_TRANSFER, ISSUED, PENDING\_ARCHIVAL                                                             |
| lei.initialRegistrationDate                                  | Int64    | Initial registration date in Unix time (epoch) seconds since 1st January 1970                                                                  |
| lei.nextRenewalDate                                          | Int64    | Initial registration date in Unix time (epoch) seconds since 1st January 1970                                                                  |
| lei.managingLOU                                              | String   | LEI of the managing LOU                                                                                                                        |
| lei.managingLOULegalName                                     | String   | Legal name of the LOU                                                                                                                          |
| ecParticipant.pic                                            | String   | Participant Identification Code (PIC) as registered with European Commission                                                                   |
| ecParticipant.validationStatus                               | String   | Declared, Validated, Sleeping, Suspended, Blocked, Deprecated (see further documentation)                                                      |
| ecParticipant.numberOfProjects                               | Int32    | Number of projects where the organization has been present with the PIC                                                                        |
| franchisesOrLicences.linkedToName                            | String   | The name of the licencee or company providing the franchise                                                                                    |
| franchisesOrLicences.actingUnderName                         | String   | The name/s under which the company is acting under                                                                                             |
| franchisesOrLicences.linkedToCompanyId                       | Int32    | The company id if exists for which the licence or franchise was given                                                                          |
| salesToPublicActors.actorName                                | String   | The name of the public actor                                                                                                                   |
| salesToPublicActors.actorType                                | String   | The name of the public actor                                                                                                                   |
| salesToPublicActors.actorCode                                | String   | The code of the actor, e.g municipality = municipality code                                                                                    |
| hasSalesToPublicActors                                       | Bool     | Helper flag for knowing if the company has sold to public actors                                                                               |
| hasPhoneNumbers                                              | Bool     | Helper flag for knowing if the company has phone numbers present                                                                               |
| hasEmailAddresses                                            | Bool     | Helper flag for knowing if the company has email addresses present                                                                             |
| hasHyperlinks                                                | Bool     | Helper flag for knowing if the company has hyperlinks present                                                                                  |
| hasIntelligence                                              | Bool     | Helper flag for knowing if the company has intelligence records present                                                                        |
| hasStatus                                                    | Bool     | Helper flag for knowing if the company has status records present                                                                              |
| hasBankAccounts                                              | Bool     | Helper flag for knowing if the company has bank accounts present                                                                               |
| hasAddresses                                                 | Bool     | Helper flag for knowing if the company has addresses present                                                                                   |
| hasDocuments                                                 | Bool     | Helper flag for knowing if the company has documents present                                                                                   |
| hasStock                                                     | Bool     | Helper flag for knowing if the company has stock data present                                                                                  |
| hasLEI                                                       | Bool     | Helper flag for knowing if the company has LEI information present                                                                             |
| hasECParticipant                                             | Bool     | Helper flag for knowing if the company has EU participant information present                                                                  |
| hasFranchisesOrLicences                                      | Bool     | Helper flag for knowing if the company has franchises or licences present                                                                      |
| hasTrademarks                                                | Bool     | Helper flag for knowing if the company has trademarks                                                                                          |
| hasMostRecentDebtorSummary                                   | Bool     | Helper flag for knowing if the company has summary of debts                                                                                    |
| cNbrEmployeesInterval.categoryCode                           | Int32    | The code for the employee interval                                                                                                             |
| cNbrEmployeesInterval.categoryCodeDescription                | String   | Description of the interval                                                                                                                    |
| cVATInterval.categoryCode                                    | Int32    | The code representing the VAT reporting                                                                                                        |
| cVATInterval.categoryCodeDescription                         | String   | Description of the interval                                                                                                                    |
| cTurnoverInterval.categoryCode                               | Int32    | The code for the turnover interval                                                                                                             |
| cTurnoverInterval.categoryCodeDescription                    | String   | Description of the interval                                                                                                                    |
| cPropertyTaxationInterval.categoryCode                       | Int32    | The code for the employee interval                                                                                                             |
| cPropertyTaxationInterval.categoryCodeDescription            | String   | Description of the interval                                                                                                                    |
| cSector.categoryCode                                         | Int32    | The code for the sector                                                                                                                        |
| cSector.categoryCodeDescription                              | String   | Description of the sector                                                                                                                      |
| cTradeAfrica.categoryCode                                    | Int32    | A code (0 or 1) representing if the company is exporting/importing from the continent.                                                         |
| cTradeAfrica.categoryCodeDescription                         | String   | Description of the interval                                                                                                                    |
| cTradeAsia.categoryCode                                      | Int32    | A code (0 or 1) representing if the company is exporting/importing from the continent.                                                         |
| cTradeAsia.categoryCodeDescription                           | String   | Description of the interval                                                                                                                    |
| cTradeEU.categoryCode                                        | Int32    | A code (0 or 1) representing if the company is exporting/importing from the continent.                                                         |
| cTradeEU.categoryCodeDescription                             | String   | Description of the interval                                                                                                                    |
| cTradeFarEast.categoryCode                                   | Int32    | A code (0 or 1) representing if the company is exporting/importing from the continent.                                                         |
| cTradeFarEast.categoryCodeDescription                        | String   | Description of the interval                                                                                                                    |
| cTradeNorthCentralAmerica.categoryCode                       | Int32    | A code (0 or 1) representing if the company is exporting/importing from the continent.                                                         |
| cTradeNorthCentralAmerica.categoryCodeDescription            | String   | Description of the interval                                                                                                                    |
| cTradeNordics.categoryCode                                   | Int32    | A code (0 or 1) representing if the company is exporting/importing from the continent.                                                         |
| cTradeNordics.categoryCodeDescription                        | String   | Description of the interval                                                                                                                    |
| cTradeSouthAmerica.categoryCode                              | Int32    | A code (0 or 1) representing if the company is exporting/importing from the continent.                                                         |
| cTradeSouthAmerica.categoryCodeDescription                   | String   | Description of the interval                                                                                                                    |
| cTradeOtherEurope.categoryCode                               | Int32    | A code (0 or 1) representing if the company is exporting/importing from the continent.                                                         |
| cTradeOtherEurope.categoryCodeDescription                    | String   | Description of the interval                                                                                                                    |
| cTradeExportInterval.categoryCode                            | Int32    | A code representing the export interval                                                                                                        |
| cTradeExportInterval.categoryCodeDescription                 | String   | Description of the interval                                                                                                                    |
| cTradeImportInterval.categoryCode                            | Int32    | A code representing the import interval                                                                                                        |
| cTradeImportInterval.categoryCodeDescription                 | String   | Description of the interval                                                                                                                    |
| cGenderRatioFemale.categoryCode                              | Int32    | Gender ratio females in percentage (no fraction)                                                                                               |
| cGenderRatioFemale.categoryCodeDescription                   | String   | Gender ratio females with percentage sign                                                                                                      |
| cPrivPubl.categoryCode                                       | Int32    | Code representing if the company is private/public/listed etc                                                                                  |
| cPrivPubl.categoryCodeDescription                            | String   | Description of the type of company                                                                                                             |
| cOwnership.categoryCode                                      | Int32    | Code representing the kind of ownership                                                                                                        |
| cOwnership.categoryCodeDescription                           | String   | Description of ownership type                                                                                                                  |

## Category fields

Fields starting with the letter c are category fields. They contain typical intervals across all company types.
Category fields are objects with the same type containing categoryCode, categoryCodeDescription and categoryCode2.

categoryCode is the actual code used to describe the category and categoryCodeDescription contains a formatted string
describing the categoryCode. categoryCode2 typically contains for example the year and month (formatted YYYYMM) or year (YYYY)
for the various categories.

Example:
cTurnoverInterval contains is an object containing the turnover interval.
cTradeImportInterval contains is an object containing the import interval (e.g how much the company is importing per year).

Category fields are efficient when you query across multiple company types since only limited companies (Aktiebolag) typically
submit annual reports (some exceptions other legal types may be required to submit an annual report). Therefore the goverment
agency, Statistics Sweden, weekly compiles data across all legal entities types that we acquire and makes it easier to search
within.

## Unix time only

Typesense only allows unix timestamps to be indexed so search will only present time by the number of non-leap seconds that have elapsed
since 00:00:00 UTC on 1st January 1970, the Unix epoch. Since we may have timestamps earlier than 1st January 1970 negative number of seconds
may appear.

## European Commission and participant status

ecParticipant.validationStatus can contain the following statuses:

**Declared**
Organisation registered by self-registrant. Will remain in this status if the validation is done decentrally by the National Agency.

**Validated**
Organisation validated centrally by REA (Research Executive Agency).

**Suspended**
The legal entity is "frozen" because of an external reason (Bankruptcy, etc.) as a result of central validation by REA (Research Executive Agency).

**Sleeping**
Some data was passed, but the contact person does not react on any demands from the REA (Research Executive Agency) validation team.

**Deprecated**
When duplication is identified by REA (Research Executive Agency), the validity will be Deprecated and the master PIC will be associated. Will not be published in the search.

**Blocked**
Blocked during the validation process by REA (Research Executive Agency).

## Enums

Enums have been stored as plain text in search making it easier to service and not having to remember their numeric values.

## Intelligence types

Intelligence records contains information about various discrepancies that we find in data. A record contains a score between 0 and 255
representing the significance of the discrepancy. If the score equals 0 is means it's just for information while 255 means the discrepancy
is very significant. Each intelligence record also comes with a human English text describing the discrepancy called intelligence.notes.

List of intelligence.companyIntelligenceType below in the table. Please note that while searching you need to enter the value (Int32) and not the name itself. Value
2,4 and 6 are unused currently. They may appear in search result currently just for testing.

| Enum                         | Value | Description                                                                                       |
| ---------------------------- | ----- | ------------------------------------------------------------------------------------------------- |
| CreatedAsShelfCompany        | 0     | The company was created as shelf company                                                          |
| SuspectedForQuickLiquidation | 1     | The company was seems to be going into "quick liquidation"                                        |
| AffliatedWithArticle         | 3     | The company is affiliated with one or multiple articles                                           |
| SuspectedAddress             | 5     | The address has earlier been known                                                                |
| PresentOnWarningList         | 7     | The company is present on certain warning lists                                                   |
| AnnualReportDiscrepancies    | 8     | One or multiple annual reports contains discrepancies                                             |
| AuditorResignation           | 9     | Auditor has resigned from their duties                                                            |
| Registration                 | 10    | One or more issues about registration                                                             |
| RegisterChanges              | 11    | A change in a registry triggered an intelligence policy                                           |
| PenaltyFees                  | 12    | The company has been penalized by a fee                                                           |
| BeneficialOwner              | 13    | The registration office have indicated issues relating to registration of beneficial owners       |
| Claims                       | 14    | Claims from various goverment agencies e.g company is required to repay for example contributions |

The intelligence.externalId is used to reference an id containing the orgin of the intelligence record. If for example the
intelligence record is of type: AnnualReportDiscrepancies (8) it means the external id represents the id of the annual report.

## Intelligence subtypes

Certain intelligence types have subtypes to further describe what has been found. The intelligence.companyIntelligenceSubType is
an enum text to make it easier to filter based on search.

List of subtypes. Please note you need to filter by string when using intelligence.companyIntelligenceSubType.

| Enum                            | Description                                                                                           |
| ------------------------------- | ----------------------------------------------------------------------------------------------------- |
| BS\_MISMATCH                    | The balance sheet doesn't balance                                                                     |
| AGM\_TO\_LATE                   | The annual general meeting was held to late                                                           |
| AR\_TO\_LATE                    | The annual report was submitted to late                                                               |
| AGM\_WRONG\_DATE                | Suspected wrong date of annual general meeting date                                                   |
| MISSING\_MULTIYEAR              | The multi-year overview is missing                                                                    |
| MISSING\_CHANGEEQUITY           | The table showing change of equity is missing                                                         |
| WRONG\_SIGNATUREDATE            | Signature date (last signature) seems to be wrong                                                     |
| WRONG\_EQUITYASSETSRATIO        | The given equity asset ratio doesn't match the calculation                                            |
| MISSING\_AUDITOR                | The company is passing the thresholds requiring an auditor (check response for mandatory requirement) |
| DUPLICATE                       | The annual report is a duplicate for another company                                                  |
| NO\_SHARECAPITAL                | The balance sheet is missing share capital                                                            |
| POSSIBLE\_MISSINGASSETS         |                                                                                                       |
| NEGATIVE\_SHARECAPITAL          | The balance sheet contains negative share capital                                                     |
| NEGATIVE\_ASSETS                | The balance sheet total assets are negative                                                           |
| MISSING\_BS\_ASSETS             | Missing part of the balance sheet (assets)                                                            |
| MISSING\_BS\_EQUITY             | Missing part of the balance sheet (equity)                                                            |
| MISSING\_RS                     | Missing result sheet                                                                                  |
| LIQUIDATION\_REQUIRED           | The company is subject to liquidation requirements                                                    |
| WRONG\_SHARECAPITAL             | The share capital is wrong in the balance sheet                                                       |
| MISSING\_NUMBEREMPLOYEES        | Missing number of employees but required                                                              |
| MISMATCH\_PL\_RS\_BS            | Mismatch of profit/loss in result sheet and balance sheet                                             |
| MISMATCH\_PL\_CE                | Mismatch of profit/loss in change of equity                                                           |
| SUSPECT\_YEAR\_DUPLICATE        | Suspected annual report for duplicated data from last year                                            |
| PROPOSED\_DIVIDEND\_ERR         | Proposed dividend contains a too high number                                                          |
| MANAGEMENT\_REPORT\_ERR         | The management report contains errors                                                                 |
| MANAGEMENT\_REPORT\_UNCERTAINTY | The management report mention uncertainty in the business                                             |
| FORBIDDEN\_LOAN                 | The management report mention a forbidden loan                                                        |
| CONTROL\_BS                     | The management report mention a control balance sheet                                                 |
| AUDITOR\_CONTROL\_BS            | Auditor mentions a control balance sheet                                                              |
| AUDITOR\_LIQUIDATION\_REQUIRED  | Auditor mentions liquidation requirements                                                             |
| AUDITOR\_FORBIDDEN\_LOAN        | Auditor mentions forbidden loan                                                                       |
| AUDITOR\_DISCOURGES             | Auditor discourges the balance/or/and result sheet                                                    |
| AUDITOR\_ACCOUNTING\_LAG        | Auditor mentions lag in the accounting of the company                                                 |
| AUDITOR\_MISSING\_EVIDENCE      | Auditor is missing documentation / evidence for transactions                                          |
| AUDITOR\_TAXES\_LATE            | Auditor mentions taxes have been paid late                                                            |
| AUDITOR\_UNAUTH\_VALUETRANSFER  | Auditor mentions unauthorized value transfers                                                         |
| AUDITOR\_ACCOUNTING\_ISSUES     | Auditor mentions accounting issues                                                                    |
| AUDITOR\_UNCERTAINTY            | Auditor mentions uncertainty in the business                                                          |
| AUDITOR\_ACCOUNTING\_ERR        | Auditor mentions errors in accounting                                                                 |
| AUDITOR\_REMARK                 | Auditor report contains a remark                                                                      |
| COMPARATIVE\_FIGURES\_ERR       | There is an error in compartative figures for the year                                                |
| AUDITOR\_EARLY\_RESIGNATION     | An auditor has made an early resignation leaving certain remarks                                      |
| SUSPECTED\_AR                   | One or multiple discrepancies have been found in the annual report                                    |
| K3\_REQUIRED                    | Company is using K2 ruleset but is required to use K3 ruleset                                         |
| ISSUE\_WITH\_REGISTRATION       | The annual report was registered with a discrepancy indicating one or multiple issues                 |
| F\_TAX\_REVOKED                 | The F-tax registration of the company have been revoked                                               |
| AFFILIATION                     | The business is affiliated with external data                                                         |
| CEO\_MISSING                    | Company is missing a CEO registered but required to have one registered                               |
| AR\_MISSING                     | Annual report is missing for a period                                                                 |
| UNAUTH\_BOARD                   | Board is unauthorized and doesn't meet the terms                                                      |
| AUDITOR\_MISSING                | Company is missing an auditor                                                                         |
| REPR\_MISSING                   | Company is missing a special recipient of service                                                     |
| BR\_SURPLUS                     | Bankruptcy terminated with surplus and is subject to liquidation                                      |
| AR\_SHORTAGE                    | Shortage listed by Bolagsverket to the company                                                        |
| PENALTY\_FEE                    | The company has been penalized with a fee, see more in the description data                           |

Check back continuously since we are adding more subtypes.

## Examples

We have put together a few example of how you can use search to efficiently query the millions of companies we track.

### Search for companies at at specific street

```bash cURL theme={null}
curl https://api.tic.io/search/companies?q=Fabriksgatan&query_by=addresses.street&key=your_api_key
{
    {
    "facet_counts": [],
    "found": 1563,
    "hits": [
        {
            "document": {
                "id": "3427183",
                "companyId": 3427183,
                "iso3166CountryCode": "SE",
                "registrationNumber": "5564228509",
                "registrationDate": 669510000....
}
```

### Search for a specific phone number in E164 format

<Note>
  What is E.164? E164 format is an international format for phone numbers. E.164
  numbers are formatted \[+] \[country code] \[subscriber number including area
  code] and can have a maximum of fifteen digits.
</Note>

```bash cURL theme={null}
curl https://api.tic.io/search/companies?q=+46850565800&query_by=phoneNumbers.e164PhoneNumber&key=your_api_key
```

### Search for companies within a certain geographic area

Search for companies covering a 300 meters radius around the provided location by latitude and longitude in WGS84 format.
Read more about geosearch [here](https://typesense.org/docs/26.0/api/geosearch.html).

```bash cURL theme={null}
curl https://api.tic.io/search/companies?q=*&query_by=addresses.street&filter_by=addresses.location:(57.6799,12.09162, 0.300 km)&sort_by=addresses.location(57.6799,12.09162):asc&key=your_api_key
```

### Filter for a specific companyId

Filters allows you to narrow down your search. This example shows how to specifically match only the company with id 3508351.
Read more about filters [here](https://typesense.org/docs/26.0/api/search.html#filter-parameters).

```bash cURL theme={null}
curl https://api.tic.io/search/companies?q=*&query_by=registrationNumber&filter_by=companyId:[3508351]&key=your_api_key
```

### Search for companies with specific industry names or codes

Searches for companies that have a number of specific industry codes as defined in [SNI 2007 standard](https://www.scb.se/en/documentation/classifications-and-standards/swedish-standard-industrial-classification-sni). You
can search either for the name as described in the standard or the code itself.

```bash cURL theme={null}
curl https://api.tic.io/search/companies?q=Handel%20med%20personbilar%20och%20l%C3%A4tta%20motorfordon&query_by=sniCodes.sni_2007Name&key=your_api_key"
```

### Search for stock listed companies

Searches for companies listed on market exchange name, OMX Stockholm,

```bash cURL theme={null}
curl https://api.tic.io/search/companies?q=OMX+Stockholm&query_by=stock.marketExchangeName&key=your_api_key
```

### Search for companies that have sold to public actors

Searches for companies that have sold to Gävle municipality.

```bash cURL theme={null}
curl https://api.tic.io/search/companies?q=gävle&query_by=salesToPublicActors.actorName&key=your_api_key
{
    {
    "facet_counts": [],
    "found": 1563,
    "hits": [
        {
            "document": {
                "id": "3427183",
                "companyId": 3427183,
                "iso3166CountryCode": "SE",
                "registrationNumber": "5564228509",
                "registrationDate": 669510000....
}
```

### Search for intelligence records

Searches for companies that have passed auditor requirements by third consecutive year. Note that the score should exceed 254.

```bash cURL theme={null}
curl https://api.tic.io/search/companies?q=*&query_by=registrationNumber&filter_by=intelligence.companyIntelligenceSubType:['MISSING_AUDITOR']&&intelligence.score:>254&key=your_api_key
```

### Multi search

Multi search enables you to carry out multi searches in one request by posting a json model to the search endpoint. Typesense have a description of the feature in their [documentation](https://typesense.org/docs/26.0/api/federated-multi-search.html).

Here is an example of how to use multisearch while searching for a company registration number, e-mail, stock ticker and LEI code.

```bash cURL theme={null}
curl  \
--request POST
--header "Content-Type: application/json"
--header "x-api-key:your_api_key"
--data '{
  "searches": [
    {
      "collection": "companies",
      "query_by": "registrationNumber",
      "q": "5565199493"
    },
    {
      "collection": "companies",
      "query_by": "emailAddresses.emailAddress",
      "q": "kundtjanst@tibroenergi.se"
    },
    {
      "collection": "companies",
      "query_by": "stock.ticker",
      "q": "SBB"
    },
     {
      "collection": "companies",
      "query_by": "lei.leiCode",
      "q": "549300YECS8HKCIMMB67"
    }
  ]
}'
https://api.tic.io/search/companies
```

### Response model

The search response for example when you search for our company would look like the example below for our company.

<Note>
  The registrationDate is in Unix epoch seconds e.g the number of seconds that
  have elapsed since January 1, 1970 (midnight UTC/GMT). Same applies for
  various dates since Typesense requires dates to be serialized to epoch. For
  example listingDate (stock) and nextRenewalDate (lei) are both epoch.
</Note>

```json Search response for companies theme={null}
{
  "results": [
    {
      "facet_counts": [],
      "found": 1,
      "hits": [
        {
          "document": {
            "addresses": [
              {
                "addressType": "mailAddress",
                "city": "BORLÄNGE",
                "postalCode": "78129",
                "street": "Box 930"
              },
              {
                "addressType": "mailAddress",
                "city": "Stockholm",
                "countryCodeAlpha3": "SWE",
                "houseNumber": "41",
                "location": [59.33876, 18.06013],
                "postalCode": "11134",
                "street": "Sveavägen"
              },
              {
                "addressType": "registeredAddress",
                "city": "STOCKHOLM",
                "co": "Bahnhof AB",
                "countryCodeAlpha3": "SE ",
                "postalCode": "10395",
                "street": "Box 7702"
              }
            ],
            "bankAccounts": [
              {
                "accountNumber": "1746635",
                "bankAccountType": "bankgiro"
              },
              {
                "accountNumber": "51365088",
                "bankAccountType": "bankgiro"
              },
              {
                "accountNumber": "56117526",
                "bankAccountType": "bankgiro"
              },
              {
                "accountNumber": "59219212",
                "bankAccountType": "bankgiro"
              },
              {
                "accountNumber": "7859291",
                "bankAccountType": "bankgiro"
              }
            ],
            "companyId": 1893055,
            "currentBeneficialOwners": [
              {
                "beneficialOwnerId": 1651253,
                "personalIdentityNumber": "redacted for privacy reasons",
                "personId": 2954253,
                "citizenshipCountryCode": "SE",
                "countryOfResidenceCode": "SE",
                "extentCode": "INTERVALL2",
                "extentDescription": "Mer än 25 % men inte mer än 50 %",
                "fromDate": 1506866424,
                "fullName": "redacted for privacy reasons",
                "governDescription": "Personen har kontroll genom aktier, andelar, medlemskap, avtal eller bestämmelse i exempelvis bolagsordning eller stadgar."
              }
            ],
            "currentRepresentatives": [
              {
                "fullName": "redacted for privacy reasons",
                "personalIdentityNumber": "redacted for privacy reasons",
                "personId": 2954253,
                "positionDescription": "STYRELSELEDAMOT",
                "positionStart": 1723161600,
                "positionType": "LE"
              },
              {
                "fullName": "redacted for privacy reasons",
                "personalIdentityNumber": "redacted for privacy reasons",
                "personId": 2954253,
                "positionDescription": "VERKSTÄLLANDE DIREKTÖR",
                "positionStart": 1723161600,
                "positionType": "VD"
              }
            ],
            "documents": [
              {
                "companyDocumentId": 13036521,
                "companyDocumentType": "minutes",
                "documentDate": 1723161600,
                "documentTitle": "Minutes registered on 2024-08-09",
                "documentUrl": "https://api.tic.io/company-documents/13036521/order",
                "documentVersion": "219870278",
                "grossPriceIfAny": 2.0
              },
              {
                "companyDocumentId": 10801798,
                "companyDocumentType": "annualReport",
                "documentDate": 1719360000,
                "documentTitle": "Annual report submitted by mail on 2024-06-26 for 2023-01-01 to 2023-12-31 and registered on 2024-08-08",
                "documentUrl": "https://api.tic.io/financial-documents/se/520470",
                "documentValue1": "2023-01-01",
                "documentValue2": "2023-12-31",
                "documentVersion": "9392305/2024"
              },
              {
                "companyDocumentId": 13036522,
                "companyDocumentType": "minutes",
                "documentDate": 1715731200,
                "documentTitle": "Minutes registered on 2024-05-15",
                "documentUrl": "https://api.tic.io/company-documents/13036522/order",
                "documentVersion": "214580527",
                "grossPriceIfAny": 2.0
              },
              {
                "companyDocumentId": 8894711,
                "companyDocumentType": "case",
                "documentDate": 1715644800,
                "documentTitle": "Change of representative/company signature",
                "documentValue1": "FÖR",
                "documentValue2": "2024-05-15",
                "documentVersion": "263117/2024"
              },
              {
                "companyDocumentId": 16922683,
                "companyDocumentType": "case",
                "documentDate": 1694476800,
                "documentTitle": "Change of the company's representative address",
                "documentValue1": "FÖRP",
                "documentValue2": "2023-09-12",
                "documentVersion": "476753/2023"
              },
              {
                "companyDocumentId": 16922684,
                "companyDocumentType": "case",
                "documentDate": 1694476800,
                "documentTitle": "Change of the company's representative address",
                "documentValue1": "FÖRP",
                "documentValue2": "2023-09-12",
                "documentVersion": "476744/2023"
              },
              {
                "companyDocumentId": 13036523,
                "companyDocumentType": "minutes",
                "documentDate": 1684108800,
                "documentTitle": "Minutes registered on 2023-05-15",
                "documentUrl": "https://api.tic.io/company-documents/13036523/order",
                "documentVersion": "197346117",
                "grossPriceIfAny": 2.0
              },
              {
                "companyDocumentId": 23646449,
                "companyDocumentType": "annualReport",
                "documentDate": 1672444800,
                "documentTitle": "Annual report for period ending 2022-12-31 registered",
                "documentUrl": "https://api.tic.io/company-documents/23646449/order",
                "documentValue2": "2022-12-31",
                "documentVersion": "202977827",
                "grossPriceIfAny": 40.0
              },
              {
                "companyDocumentId": 16922685,
                "companyDocumentType": "case",
                "documentDate": 1661731200,
                "documentTitle": "Change relating to auditors",
                "documentValue1": "REV",
                "documentValue2": "2022-08-29",
                "documentVersion": "432632/2022"
              },
              {
                "companyDocumentId": 13036524,
                "companyDocumentType": "minutes",
                "documentDate": 1653350400,
                "documentTitle": "Minutes registered on 2022-05-24",
                "documentUrl": "https://api.tic.io/company-documents/13036524/order",
                "documentVersion": "182079292",
                "grossPriceIfAny": 2.0
              },
              {
                "companyDocumentId": 23646450,
                "companyDocumentType": "annualReport",
                "documentDate": 1640908800,
                "documentTitle": "Annual report for period ending 2021-12-31 registered",
                "documentUrl": "https://api.tic.io/company-documents/23646450/order",
                "documentValue2": "2021-12-31",
                "documentVersion": "185126852",
                "grossPriceIfAny": 40.0
              },
              {
                "companyDocumentId": 13036525,
                "companyDocumentType": "minutes",
                "documentDate": 1636588800,
                "documentTitle": "Minutes registered on 2021-11-11",
                "documentUrl": "https://api.tic.io/company-documents/13036525/order",
                "documentVersion": "173834528",
                "grossPriceIfAny": 2.0
              },
              {
                "companyDocumentId": 16922686,
                "companyDocumentType": "case",
                "documentDate": 1635897600,
                "documentTitle": "Change of representative/company signature,Change of subject's mailing address",
                "documentValue1": "FÖR,PA",
                "documentValue2": "2021-11-11",
                "documentVersion": "624165/2021"
              },
              {
                "companyDocumentId": 23646451,
                "companyDocumentType": "annualReport",
                "documentDate": 1609372800,
                "documentTitle": "Annual report for period ending 2020-12-31 registered",
                "documentUrl": "https://api.tic.io/company-documents/23646451/order",
                "documentValue2": "2020-12-31",
                "documentVersion": "164060402",
                "grossPriceIfAny": 40.0
              },
              {
                "companyDocumentId": 13036526,
                "companyDocumentType": "minutes",
                "documentDate": 1590624000,
                "documentTitle": "Minutes registered on 2020-05-28",
                "documentUrl": "https://api.tic.io/company-documents/13036526/order",
                "documentVersion": "144379934",
                "grossPriceIfAny": 2.0
              },
              {
                "companyDocumentId": 16922687,
                "companyDocumentType": "case",
                "documentDate": 1589414400,
                "documentTitle": "Change of representative/company signature",
                "documentValue1": "FÖR",
                "documentValue2": "2020-05-28",
                "documentVersion": "272195/2020"
              },
              {
                "companyDocumentId": 23646452,
                "companyDocumentType": "annualReport",
                "documentDate": 1577750400,
                "documentTitle": "Annual report for period ending 2019-12-31 registered",
                "documentUrl": "https://api.tic.io/company-documents/23646452/order",
                "documentValue2": "2019-12-31",
                "documentVersion": "148605084",
                "grossPriceIfAny": 40.0
              },
              {
                "companyDocumentId": 13036527,
                "companyDocumentType": "minutes",
                "documentDate": 1564358400,
                "documentTitle": "Minutes registered on 2019-07-29",
                "documentUrl": "https://api.tic.io/company-documents/13036527/order",
                "documentVersion": "140284912",
                "grossPriceIfAny": 2.0
              },
              {
                "companyDocumentId": 13036528,
                "companyDocumentType": "minutes",
                "documentDate": 1564358400,
                "documentTitle": "Minutes registered on 2019-07-29",
                "documentUrl": "https://api.tic.io/company-documents/13036528/order",
                "documentVersion": "140284911",
                "grossPriceIfAny": 2.0
              },
              {
                "companyDocumentId": 16922688,
                "companyDocumentType": "case",
                "documentDate": 1561593600,
                "documentTitle": "Change of representative/company signature",
                "documentValue1": "FÖR",
                "documentValue2": "2019-07-29",
                "documentVersion": "344374/2019"
              },
              {
                "companyDocumentId": 23646570,
                "companyDocumentType": "annualReport",
                "documentDate": 1546214400,
                "documentTitle": "Annual report for period ending 2018-12-31 registered",
                "documentUrl": "https://api.tic.io/company-documents/23646570/order",
                "documentValue2": "2018-12-31",
                "documentVersion": "134135352",
                "grossPriceIfAny": 40.0
              },
              {
                "companyDocumentId": 16922689,
                "companyDocumentType": "case",
                "documentDate": 1527120000,
                "documentTitle": "Change of representative/company signature",
                "documentValue1": "FÖR",
                "documentValue2": "2018-06-13",
                "documentVersion": "273061/2018"
              },
              {
                "companyDocumentId": 23646571,
                "companyDocumentType": "annualReport",
                "documentDate": 1514678400,
                "documentTitle": "Annual report for period ending 2017-12-31 registered",
                "documentUrl": "https://api.tic.io/company-documents/23646571/order",
                "documentValue2": "2017-12-31",
                "documentVersion": "106264065",
                "grossPriceIfAny": 40.0
              },
              {
                "companyDocumentId": 13036520,
                "companyDocumentType": "articlesOfAssociation",
                "documentDate": 1507680000,
                "documentTitle": "Articles of association stated on 2017-10-11",
                "documentUrl": "https://api.tic.io/company-documents/13036520/order",
                "documentVersion": "116345562",
                "grossPriceIfAny": 40.0
              },
              {
                "companyDocumentId": 23646572,
                "companyDocumentType": "annualReport",
                "documentDate": 1483142400,
                "documentTitle": "Annual report for period ending 2016-12-31 registered",
                "documentUrl": "https://api.tic.io/company-documents/23646572/order",
                "documentValue2": "2016-12-31",
                "documentVersion": "36159320",
                "grossPriceIfAny": 40.0
              },
              {
                "companyDocumentId": 23646573,
                "companyDocumentType": "annualReport",
                "documentDate": 1451520000,
                "documentTitle": "Annual report for period ending 2015-12-31 registered",
                "documentUrl": "https://api.tic.io/company-documents/23646573/order",
                "documentValue2": "2015-12-31",
                "documentVersion": "30454182",
                "grossPriceIfAny": 40.0
              },
              {
                "companyDocumentId": 23646574,
                "companyDocumentType": "annualReport",
                "documentDate": 1419984000,
                "documentTitle": "Annual report for period ending 2014-12-31 registered",
                "documentUrl": "https://api.tic.io/company-documents/23646574/order",
                "documentValue2": "2014-12-31",
                "documentVersion": "26697277",
                "grossPriceIfAny": 40.0
              },
              {
                "companyDocumentId": 23646575,
                "companyDocumentType": "annualReport",
                "documentDate": 1388448000,
                "documentTitle": "Annual report for period ending 2013-12-31 registered",
                "documentUrl": "https://api.tic.io/company-documents/23646575/order",
                "documentValue2": "2013-12-31",
                "documentVersion": "22762254",
                "grossPriceIfAny": 40.0
              },
              {
                "companyDocumentId": 16922690,
                "companyDocumentType": "case",
                "documentDate": 1369785600,
                "documentTitle": "Change of representative/company signature",
                "documentValue1": "FÖR",
                "documentValue2": "2013-06-17",
                "documentVersion": "193232/2013"
              },
              {
                "companyDocumentId": 23646576,
                "companyDocumentType": "annualReport",
                "documentDate": 1356912000,
                "documentTitle": "Annual report for period ending 2012-12-31 registered",
                "documentUrl": "https://api.tic.io/company-documents/23646576/order",
                "documentValue2": "2012-12-31",
                "documentVersion": "20035600",
                "grossPriceIfAny": 40.0
              },
              {
                "companyDocumentId": 16922691,
                "companyDocumentType": "case",
                "documentDate": 1349913600,
                "documentTitle": "Change of representative/company signature",
                "documentValue1": "FÖR",
                "documentValue2": "2012-10-16",
                "documentVersion": "390371/2012"
              },
              {
                "companyDocumentId": 16922692,
                "companyDocumentType": "case",
                "documentDate": 1338163200,
                "documentTitle": "Change of representative/company signature",
                "documentValue1": "FÖR",
                "documentValue2": "2012-05-30",
                "documentVersion": "208178/2012"
              },
              {
                "companyDocumentId": 23646577,
                "companyDocumentType": "annualReport",
                "documentDate": 1325289600,
                "documentTitle": "Annual report for period ending 2011-12-31 registered",
                "documentUrl": "https://api.tic.io/company-documents/23646577/order",
                "documentValue2": "2011-12-31",
                "documentVersion": "18120881",
                "grossPriceIfAny": 40.0
              },
              {
                "companyDocumentId": 16922693,
                "companyDocumentType": "case",
                "documentDate": 1304553600,
                "documentTitle": "Change of mailing address of representative and/or auditor in several companies",
                "documentValue1": "MPA",
                "documentValue2": "2011-05-09",
                "documentVersion": "171354/2011"
              },
              {
                "companyDocumentId": 16922694,
                "companyDocumentType": "case",
                "documentDate": 1294790400,
                "documentTitle": "Change of representative/company signature",
                "documentValue1": "FÖR",
                "documentValue2": "2011-01-27",
                "documentVersion": "12506/2011"
              },
              {
                "companyDocumentId": 23646578,
                "companyDocumentType": "annualReport",
                "documentDate": 1293753600,
                "documentTitle": "Annual report for period ending 2010-12-31 registered",
                "documentUrl": "https://api.tic.io/company-documents/23646578/order",
                "documentValue2": "2010-12-31",
                "documentVersion": "15944944",
                "grossPriceIfAny": 40.0
              },
              {
                "companyDocumentId": 16922695,
                "companyDocumentType": "case",
                "documentDate": 1288656000,
                "documentTitle": "Resignation from the board of directors",
                "documentValue1": "FÖRU",
                "documentValue2": "2010-11-03",
                "documentVersion": "560174/2010"
              },
              {
                "companyDocumentId": 16922696,
                "companyDocumentType": "case",
                "documentDate": 1282608000,
                "documentTitle": "Change of representative/company signature",
                "documentValue1": "FÖR",
                "documentValue2": "2010-09-06",
                "documentVersion": "399206/2010"
              },
              {
                "companyDocumentId": 23646579,
                "companyDocumentType": "annualReport",
                "documentDate": 1262217600,
                "documentTitle": "Annual report for period ending 2009-12-31 registered",
                "documentUrl": "https://api.tic.io/company-documents/23646579/order",
                "documentValue2": "2009-12-31",
                "documentVersion": "13522725",
                "grossPriceIfAny": 40.0
              },
              {
                "companyDocumentId": 16922697,
                "companyDocumentType": "case",
                "documentDate": 1243209600,
                "documentTitle": "Authorisation to increase share capital through the issue of new shares,Change of representative/company signature,Change of subject's mailing address",
                "documentValue1": "BENY,FÖR,PA",
                "documentValue2": "2009-06-01",
                "documentVersion": "225051/2009"
              },
              {
                "companyDocumentId": 23646580,
                "companyDocumentType": "annualReport",
                "documentDate": 1230681600,
                "documentTitle": "Annual report for period ending 2008-12-31 registered",
                "documentUrl": "https://api.tic.io/company-documents/23646580/order",
                "documentValue2": "2008-12-31",
                "documentVersion": "11901777",
                "grossPriceIfAny": 40.0
              },
              {
                "companyDocumentId": 16922698,
                "companyDocumentType": "case",
                "documentDate": 1222300800,
                "documentTitle": "Change of information for legal person registered as representative/auditor",
                "documentValue1": "BVEJUR",
                "documentValue2": "2008-09-25",
                "documentVersion": "414260/2008"
              },
              {
                "companyDocumentId": 16922699,
                "companyDocumentType": "case",
                "documentDate": 1213574400,
                "documentTitle": "Change of representative/company signature",
                "documentValue1": "FÖR",
                "documentValue2": "2008-06-17",
                "documentVersion": "275101/2008"
              },
              {
                "companyDocumentId": 23646581,
                "companyDocumentType": "annualReport",
                "documentDate": 1199059200,
                "documentTitle": "Annual report for period ending 2007-12-31 registered",
                "documentUrl": "https://api.tic.io/company-documents/23646581/order",
                "documentValue2": "2007-12-31",
                "documentVersion": "10193935",
                "grossPriceIfAny": 40.0
              },
              {
                "companyDocumentId": 16922700,
                "companyDocumentType": "case",
                "documentDate": 1191542400,
                "documentTitle": "Change of business name,Change of representative/company signature,Change of limits for the number of board members,Amendment of Articles of Association,Change of category from private to public company,Change relating to auditors,Issue or change of warrants,Ökning av aktiekapitalet genom nyemission",
                "documentValue1": "FIRM,FÖR,FÖRGR,ORDN,PUBL,REV,TOPT,ÖKNY",
                "documentValue2": "2007-11-16",
                "documentVersion": "308663/2007"
              },
              {
                "companyDocumentId": 23646582,
                "companyDocumentType": "annualReport",
                "documentDate": 1167523200,
                "documentTitle": "Annual report for period ending 2006-12-31 registered",
                "documentUrl": "https://api.tic.io/company-documents/23646582/order",
                "documentValue2": "2006-12-31",
                "documentVersion": "8619003",
                "grossPriceIfAny": 40.0
              },
              {
                "companyDocumentId": 23646765,
                "companyDocumentType": "annualReport",
                "documentDate": 1135987200,
                "documentTitle": "Annual report for period ending 2005-12-31 registered",
                "documentUrl": "https://api.tic.io/company-documents/23646765/order",
                "documentValue2": "2005-12-31",
                "documentVersion": "6930943",
                "grossPriceIfAny": 40.0
              },
              {
                "companyDocumentId": 16922701,
                "companyDocumentType": "case",
                "documentDate": 1117065600,
                "documentTitle": "Registration of secondary name or change in the business conducted under the secondary name.,Change of business name,Change of representative/company signature,Amendment of Articles of Association,Change of subject's mailing address",
                "documentValue1": "BIF,FIRM,FÖR,ORDN,PA",
                "documentValue2": "2005-06-01",
                "documentVersion": "142782/2005"
              },
              {
                "companyDocumentId": 16922702,
                "companyDocumentType": "case",
                "documentDate": 1105488000,
                "documentTitle": "Change relating to auditors",
                "documentValue1": "REV",
                "documentValue2": "2005-01-15",
                "documentVersion": "8175/2005"
              },
              {
                "companyDocumentId": 23646766,
                "companyDocumentType": "annualReport",
                "documentDate": 1104451200,
                "documentTitle": "Annual report for period ending 2004-12-31 registered",
                "documentUrl": "https://api.tic.io/company-documents/23646766/order",
                "documentValue2": "2004-12-31",
                "documentVersion": "5584259",
                "grossPriceIfAny": 40.0
              },
              {
                "companyDocumentId": 16922703,
                "companyDocumentType": "case",
                "documentDate": 1095724800,
                "documentTitle": "Change of representative/company signature",
                "documentValue1": "FÖR",
                "documentValue2": "2004-10-11",
                "documentVersion": "256580/2004"
              },
              {
                "companyDocumentId": 23646767,
                "companyDocumentType": "annualReport",
                "documentDate": 1072828800,
                "documentTitle": "Annual report for period ending 2003-12-31 registered",
                "documentUrl": "https://api.tic.io/company-documents/23646767/order",
                "documentValue2": "2003-12-31",
                "documentVersion": "4371486",
                "grossPriceIfAny": 40.0
              },
              {
                "companyDocumentId": 16922704,
                "companyDocumentType": "case",
                "documentDate": 1067644800,
                "documentTitle": "Conversion of objects to the Swedish Companies Registration Office's data system",
                "documentValue1": "KONV",
                "documentValue2": "2003-11-01",
                "documentVersion": "1093215/2003"
              },
              {
                "companyDocumentId": 23646768,
                "companyDocumentType": "annualReport",
                "documentDate": 1041292800,
                "documentTitle": "Annual report for period ending 2002-12-31 registered",
                "documentUrl": "https://api.tic.io/company-documents/23646768/order",
                "documentValue2": "2002-12-31",
                "documentVersion": "3339325",
                "grossPriceIfAny": 40.0
              },
              {
                "companyDocumentId": 23646769,
                "companyDocumentType": "annualReport",
                "documentDate": 1009756800,
                "documentTitle": "Annual report for period ending 2001-12-31 registered",
                "documentUrl": "https://api.tic.io/company-documents/23646769/order",
                "documentValue2": "2001-12-31",
                "documentVersion": "2621768",
                "grossPriceIfAny": 40.0
              },
              {
                "companyDocumentId": 23646770,
                "companyDocumentType": "annualReport",
                "documentDate": 978220800,
                "documentTitle": "Annual report for period ending 2000-12-31 registered",
                "documentUrl": "https://api.tic.io/company-documents/23646770/order",
                "documentValue2": "2000-12-31",
                "documentVersion": "323673",
                "grossPriceIfAny": 40.0
              },
              {
                "companyDocumentId": 23646771,
                "companyDocumentType": "annualReport",
                "documentDate": 962323200,
                "documentTitle": "Annual report for period ending 2000-06-30 registered",
                "documentUrl": "https://api.tic.io/company-documents/23646771/order",
                "documentValue2": "2000-06-30",
                "documentVersion": "176529",
                "grossPriceIfAny": 40.0
              },
              {
                "companyDocumentId": 23646772,
                "companyDocumentType": "annualReport",
                "documentDate": 930700800,
                "documentTitle": "Annual report for period ending 1999-06-30 registered",
                "documentUrl": "https://api.tic.io/company-documents/23646772/order",
                "documentValue2": "1999-06-30",
                "documentVersion": "1094929",
                "grossPriceIfAny": 40.0
              },
              {
                "companyDocumentId": 16922705,
                "companyDocumentType": "case",
                "documentDate": 917481600,
                "documentTitle": "Åtgärd av Bolagsverket på grund av personlig konkurs,Change of representative/company signature",
                "documentValue1": "PRVK,ST",
                "documentValue2": "1999-01-29",
                "documentVersion": "18651/1999"
              },
              {
                "companyDocumentId": 16922706,
                "companyDocumentType": "case",
                "documentDate": 898041600,
                "documentTitle": "Amendment of Articles of Association,Change of business name,Change of financial year,Change of representative/company signature,Change relating to auditors,Auditor's commisssion terminated early",
                "documentValue1": "ORDN,FIRM,RÄK,ST,REV,REVF",
                "documentValue2": "1998-06-24",
                "documentVersion": "115524/1998"
              },
              {
                "companyDocumentId": 23646773,
                "companyDocumentType": "annualReport",
                "documentDate": 883526400,
                "documentTitle": "Annual report for period ending 1997-12-31 registered",
                "documentUrl": "https://api.tic.io/company-documents/23646773/order",
                "documentValue2": "1997-12-31",
                "documentVersion": "529477",
                "grossPriceIfAny": 40.0
              },
              {
                "companyDocumentId": 16922707,
                "companyDocumentType": "case",
                "documentDate": 804297600,
                "documentTitle": "New registration,Registrering av ärende utan avgift",
                "documentValue1": "NYB,UP",
                "documentValue2": "1995-07-14",
                "documentVersion": "132365/1995"
              }
            ],
            "elfCode": "XJHM",
            "emailAddresses": [
              {
                "emailAddress": "ekonomi@bahnhof.se",
                "emailAddressType": "general"
              }
            ],
            "franchisesOrLicences": [],
            "hasAddresses": true,
            "hasBankAccounts": true,
            "hasDocuments": true,
            "hasECParticipant": false,
            "hasEmailAddresses": true,
            "hasFranchisesOrLicences": false,
            "hasHyperlinks": true,
            "hasIntelligence": false,
            "hasLEI": true,
            "hasMostRecentFinancialSummary": true,
            "hasPhoneNumbers": true,
            "hasSalesToPublicActors": true,
            "hasStatus": false,
            "hasStock": true,
            "hasTrademarks": true,
            "hyperlinks": [
              {
                "hyperlink": "https://bahnhof.se/",
                "hyperlinkType": "homepage"
              },
              {
                "hyperlink": "https://se.linkedin.com/company/bahnhof",
                "hyperlinkType": "linkedIn"
              }
            ],
            "id": "1893055",
            "intelligence": [],
            "isCeased": false,
            "isRegisteredForFTax": true,
            "isRegisteredForPayroll": true,
            "isRegisteredForVAT": true,
            "iso3166CountryCode": "SE",
            "legalEntityType": "Aktiebolag",
            "lei": {
              "initialRegistrationDate": 1477533600,
              "leiCode": "213800K7LQU3H85KCU96",
              "managingLOU": "549300O897ZC5H7CY412",
              "managingLOULegalName": "Nordic Legal Entity Identifier AB",
              "nextRenewalDate": 1745795880,
              "registrationStatus": "ISSUED"
            },
            "localCompanyCode": "AB",
            "mostRecentFinancialSummary": {
              "bs_TotalAssetsK": 1101530,
              "fn_NumberOfEmployees": 290.0,
              "isAudited": true,
              "km_EquityAssetsRatio": 0.4946,
              "km_GrossMargin": 0.2893,
              "km_NetProfitMargin": 0.1264,
              "km_OperatingMargin": 0.1254,
              "periodEnd": 1672444800,
              "periodStart": 1640995200,
              "rs_NetSalesK": 1730020,
              "rs_OperatingProfitOrLossK": 216943,
              "rs_OtherOperatingIncomeK": 691,
              "rs_ProfitAfterFinancialItemsK": 218657,
              "rs_SumFinancialItemsK": 1714
            },
            "mostRecentPurpose": "Aktiebolaget ska bedriva försäljning av mjukvaror, hårdvaror samt tjänster inom datakommunikation, produktion och försäljning av mediaprodukter och mediatjänster samt därmed förenlig verksamhet.",
            "mostRecentRegisteredAddress": {
              "addressType": "registeredAddress",
              "city": "STOCKHOLM",
              "co": "Bahnhof AB",
              "countryCodeAlpha3": "SE ",
              "postalCode": "10395",
              "street": "Box 7702"
            },
            "mostRecentShareCapital": {
              "firstSeenAt": 1723209756,
              "numberOfShares": 107565130,
              "numberOfSharesHigherLimit": 400000000,
              "numberOfSharesLowerLimit": 100000000,
              "shareCapitalAmount": 1075651.0,
              "shareCapitalHigherLimitAmount": 4000000.0,
              "shareCapitalISO4217CurrencyCode": "SEK",
              "shareCapitalLowerLimitAmount": 1000000.0
            },
            "mostRecentSignatory": {
              "firstSeenAt": 1723209756,
              "signatureDescription": "Firman tecknas av styrelsen Firman tecknas i förening av >Karlung, Jon >Norman, Bengt Staffan Andreas Dessutom har verkställande direktören rätt att teckna firman beträffande löpande förvaltningsåtgärder"
            },
            "names": [
              {
                "companyNamingType": "legalName",
                "firstSeenAt": 1195171200,
                "nameOrIdentifier": "Bahnhof AB (publ)"
              },
              {
                "companyNamingType": "particularName",
                "firstSeenAt": 1117584000,
                "nameOrIdentifier": "Komintern"
              }
            ],
            "phoneNumbers": [
              {
                "e164PhoneNumber": "+46105100000",
                "numberPlanServiceType": "Geografiskt oberoende tjänster",
                "orginalOperator": "Bahnhof AB",
                "phoneNumberType": "fixedLine"
              }
            ],
            "registeredOffices": [
              {
                "county": "Stockholms län",
                "countyCode": "01",
                "firstSeenAt": 1723209756,
                "municipality": "Stockholm",
                "municipalityCode": "0180"
              }
            ],
            "registrationDate": 805680000,
            "registrationNumber": "5565199493",
            "salesToPublicActors": [
              {
                "actorCode": "2260",
                "actorName": "Ånge",
                "actorType": "Municipality",
                "invoicedApprox2022K": 90,
                "invoicedApprox2023K": 59
              },
              {
                "actorCode": "1765",
                "actorName": "Årjäng",
                "actorType": "Municipality",
                "invoicedApprox2022K": 14,
                "invoicedApprox2023K": 8
              }
              {
                "actorName": "Got Event AB",
                "actorType": "MunicipalityCompany",
                "invoicedApprox2022K": 153,
                "invoicedApprox2023K": 179
              },
              {
                "actorName": "Region Halland",
                "actorType": "Region",
                "invoicedApprox2022K": 0,
                "invoicedApprox2023K": 59
              },
              {
                "actorName": "Västra Götalandsregionen",
                "actorType": "Region",
                "invoicedApprox2022K": 52,
                "invoicedApprox2023K": 40
              },
              {
                "actorName": "Sveriges lantbruksuniversitet",
                "actorType": "University",
                "invoicedApprox2022K": 0,
                "invoicedApprox2023K": 448
              },
              {
                "actorName": "Kungliga biblioteket",
                "actorType": "Authority",
                "invoicedApprox2022K": 23,
                "invoicedApprox2023K": 0
              },
              {
                "actorName": "Statens konstråd",
                "actorType": "Authority",
                "invoicedApprox2022K": 35,
                "invoicedApprox2023K": 34
              },
              {
                "actorName": "Institutet för rymdfysik",
                "actorType": "Authority",
                "invoicedApprox2022K": 0,
                "invoicedApprox2023K": 18
              },
              {
                "actorName": "Trafikverket",
                "actorType": "Authority",
                "invoicedApprox2022K": 0,
                "invoicedApprox2023K": 8
              }
            ],
            "sniCodes": [
              {
                "sni_2007Code": "61100",
                "sni_2007Name": "Trådbunden telekommunikation"
              },
              {
                "sni_2007Code": "63110",
                "sni_2007Name": "Databehandling, hosting o.d."
              },
              {
                "sni_2007Code": "69201",
                "sni_2007Name": "Redovisning och bokföring"
              }
            ],
            "status": [],
            "stock": {
              "branchName": "Bredband & Telefoni",
              "dividendAmount": 2.0,
              "dividendCurrency": "SEK",
              "dividendExDate": 1715731200,
              "dividendsPerYear": 1,
              "enterpriseValue": 5163.99,
              "enterpriseValueUpdated": 1731043862,
              "isin": "SE0010442418",
              "listingDate": 1198022400,
              "marketCountryCodeAlpha3": "SWE",
              "marketExchangeName": "OMX Stockholm",
              "marketName": "First North",
              "nextReportDate": 1739836800,
              "nextReportType": "ANNUAL",
              "sectorName": "Telekommunikation",
              "stockQuote": 52.0,
              "stockQuoteUpdated": 1731087908,
              "ticker": "BAHN B",
              "yahooSymbol": "BAHN-B.ST"
            },
            "trademarks": [
              {
                "applicationNumber": "2007-05003",
                "feature": "Figurative",
                "mediaUrl": "https://api.tic.io/media/trademarks/se/415329",
                "registeredCountryCode": "SE",
                "status": "Applicationrefused",
                "trademarkId": 415329,
                "word": "B BAHNHOF"
              },
              {
                "applicationNumber": "2009-06701",
                "expire": 1574812800,
                "feature": "Word",
                "registered": 1259280000,
                "registeredCountryCode": "SE",
                "status": "Expired",
                "trademarkId": 447292,
                "word": "Comptainer"
              },
              {
                "applicationNumber": "2009-06702",
                "expire": 1574812800,
                "feature": "Word",
                "registered": 1259280000,
                "registeredCountryCode": "SE",
                "status": "Expired",
                "trademarkId": 447293,
                "word": "Servtainer"
              },
              {
                "applicationNumber": "2012-04739",
                "expire": 1982361600,
                "feature": "Word",
                "registered": 1351209600,
                "registeredCountryCode": "SE",
                "status": "Registered",
                "trademarkId": 482096,
                "word": "Thule Data Center"
              },
              {
                "applicationNumber": "2013-00692",
                "expire": 1996876800,
                "feature": "Word",
                "registered": 1365724800,
                "registeredCountryCode": "SE",
                "status": "Registered",
                "trademarkId": 488573,
                "word": "IKAPP Finans"
              },
              {
                "applicationNumber": "2013-00975",
                "expire": 1997481600,
                "feature": "Word",
                "registered": 1366329600,
                "registeredCountryCode": "SE",
                "status": "Registered",
                "trademarkId": 489078,
                "word": "OpenGiga"
              },
              {
                "applicationNumber": "2013-02106",
                "expire": 2001110400,
                "feature": "Word",
                "registered": 1369958400,
                "registeredCountryCode": "SE",
                "status": "Registered",
                "trademarkId": 490365,
                "word": "DCDH - Data Center for District Heating"
              },
              {
                "applicationNumber": "2013-04191",
                "expire": 1697587200,
                "feature": "Word",
                "registered": 1382054400,
                "registeredCountryCode": "SE",
                "status": "Expired",
                "trademarkId": 492972,
                "word": "NoLeaks"
              },
              {
                "applicationNumber": "2013-05251",
                "expire": 2027116800,
                "feature": "Word",
                "registered": 1395964800,
                "registeredCountryCode": "SE",
                "status": "Registered",
                "trademarkId": 494265,
                "word": "Based in Sweden"
              },
              {
                "applicationNumber": "2014-03224",
                "feature": "Word",
                "registeredCountryCode": "SE",
                "status": "Applicationrefused",
                "trademarkId": 502301,
                "word": "Kraftwerk"
              },
              {
                "applicationNumber": "2014-08132",
                "expire": 1749081600,
                "feature": "Word",
                "registered": 1433462400,
                "registeredCountryCode": "SE",
                "status": "Registered",
                "trademarkId": 508011,
                "word": "Triple Green"
              },
              {
                "applicationNumber": "2016-05296",
                "expire": 1793664000,
                "feature": "Word",
                "registered": 1478131200,
                "registeredCountryCode": "SE",
                "status": "Registered",
                "trademarkId": 525052,
                "word": "Northern Light"
              },
              {
                "applicationNumber": "2016-05808",
                "expire": 1795392000,
                "feature": "Word",
                "registered": 1479859200,
                "registeredCountryCode": "SE",
                "status": "Registered",
                "trademarkId": 525563,
                "word": "Spridningskollen"
              },
              {
                "applicationNumber": "2017-05526",
                "expire": 1827014400,
                "feature": "Word",
                "registered": 1511481600,
                "registeredCountryCode": "SE",
                "status": "Registered",
                "trademarkId": 536066,
                "word": "Climate+"
              },
              {
                "applicationNumber": "2017-07191",
                "feature": "Word",
                "registeredCountryCode": "SE",
                "status": "Applicationrefused",
                "trademarkId": 537998,
                "word": "Big City"
              },
              {
                "applicationNumber": "2017-08630",
                "expire": 1836777600,
                "feature": "Word",
                "registered": 1521158400,
                "registeredCountryCode": "SE",
                "status": "Registered",
                "trademarkId": 539770,
                "word": "VXDC"
              },
              {
                "applicationNumber": "2018-02465",
                "feature": "Word",
                "registeredCountryCode": "SE",
                "status": "Applicationrefused",
                "trademarkId": 543262,
                "word": "Streama lagligt"
              },
              {
                "applicationNumber": "2018-02507",
                "feature": "Word",
                "registeredCountryCode": "SE",
                "status": "Applicationrefused",
                "trademarkId": 543304,
                "word": "Öppet Spektrum"
              },
              {
                "applicationNumber": "2019-06976",
                "feature": "Word",
                "registeredCountryCode": "SE",
                "status": "Applicationrefused",
                "trademarkId": 558152,
                "word": "Quantum Cloud"
              },
              {
                "applicationNumber": "2020-01310",
                "expire": 1898121600,
                "feature": "Word",
                "registered": 1599609600,
                "registeredCountryCode": "SE",
                "status": "Registered",
                "trademarkId": 561236,
                "word": "Bahnhof"
              },
              {
                "applicationNumber": "2020-03102",
                "expire": 1904342400,
                "feature": "Figurative",
                "mediaUrl": "https://api.tic.io/media/trademarks/se/563313",
                "registered": 1591056000,
                "registeredCountryCode": "SE",
                "status": "Registered",
                "trademarkId": 563313,
                "word": "B BAHNHOF INTERNET MED SEKRETESS"
              },
              {
                "applicationNumber": "2020-03106",
                "expire": 1904342400,
                "feature": "Word",
                "registered": 1590537600,
                "registeredCountryCode": "SE",
                "status": "Registered",
                "trademarkId": 563317,
                "word": "Elementica Data Center Construction"
              },
              {
                "applicationNumber": "2020-03596",
                "expire": 1906070400,
                "feature": "Word",
                "registered": 1592438400,
                "registeredCountryCode": "SE",
                "status": "Registered",
                "trademarkId": 563926,
                "word": "GothCom"
              },
              {
                "applicationNumber": "2021-04259",
                "feature": "Word",
                "registeredCountryCode": "SE",
                "status": "Applicationrefused",
                "trademarkId": 574763,
                "word": "FOLIE"
              },
              {
                "applicationNumber": "2021-06328",
                "expire": 1947196800,
                "feature": "Word",
                "registered": 1634860800,
                "registeredCountryCode": "SE",
                "status": "Registered",
                "trademarkId": 577183,
                "word": "Foliehatt"
              },
              {
                "applicationNumber": "2022-01324",
                "expire": 1962316800,
                "feature": "Word",
                "registered": 1648425600,
                "registeredCountryCode": "SE",
                "status": "Registered",
                "trademarkId": 581448,
                "word": "Nord Stream 3"
              }
            ]
          },
          "highlight": {
            "registrationNumber": {
              "matched_tokens": ["5565199493"],
              "snippet": "<mark>5565199493</mark>"
            }
          },
          "highlights": [
            {
              "field": "registrationNumber",
              "matched_tokens": ["5565199493"],
              "snippet": "<mark>5565199493</mark>"
            }
          ],
          "text_match": 578730123365711993,
          "text_match_info": {
            "best_field_score": "1108091339008",
            "best_field_weight": 15,
            "fields_matched": 1,
            "num_tokens_dropped": 0,
            "score": "578730123365711993",
            "tokens_matched": 1,
            "typo_prefix_score": 0
          }
        }
      ],
      "out_of": 1840750,
      "page": 1,
      "request_params": {
        "collection_name": "companies_se_20241215202246",
        "first_q": "5565199493",
        "per_page": 10,
        "q": "5565199493"
      },
      "search_cutoff": false,
      "search_time_ms": 2
    }
  ]
}
```


# AI Annual Report Intelligence
Source: https://docs.tic.io/technology/ai-annual-report-intelligence

How TIC detects discrepancies, anomalies, and potential financial-statement fraud in Swedish annual reports using AI.

Credit reference agencies gives lenders and others a range of information about the
potential borrower, customer or vendor. A significant part of this information is based
on annual reports and other financial statements belonging to the business.

The same set of financial data is also exposed in business information services provided
by a large number of actors in the market.

In countries such as Sweden the statutory audit requirements for companies was abolished in 2010
which since then allows businesses under certain size to reduce administrative burden by not having
an auditor. This has created new challenges which has remained unsolved by our competitors. Companies
can submit financial statements and annual reports that contains forged financial data and authorities
have very little to no possibility to detect these.

The Swedish National Audit Office, NAO, wrote in the [report 12 december 2017 - Abolition of audit obligation for small limited companies](https://www.riksrevisionen.se/download/18.26c2548c1616574394b157/1518435480894/RiR_2017_35_REVISIONSPLIKT_SUMMARY.PDF):

*One consequence is that the registered annual reports risk containing incorrect totals, which contravenes
the requirement that annual reports must give a true and fair view of the companies’ finances.
The deficient annual reports are passed on unchanged to various stakeholders, such as other authorities in
criminal investigations and credit rating companies, which risk making assessments on incorrect grounds.
For example, a company can record incorrect financial information in the balance or income statement to
present the company's finances as better or worse.*

## Solution

Together with AI intelligent document processing (IDP), we detect a large number of discrepancies in
annual reports such as these examples:

* Similarities in annual reports based on historic annual reports for all businesses, e.g has the
  annual report been copied from another business or part of the data been modified
* Summary errors
* Unrestricted equity doesn't balance between the years
* The annual report doesn't adhere to requirement per local regulations for example in Sweden Annual Accounts Act
  according to K2 (BFNAR 2016:10) / K3 (BFNAR 2012:1)
* Visually aligning with known accounting systems that typically produce annual reports

These discrepancies are registered on each document with links to which similarities exists
with other documents. The discrepancies are summed up and expressed in words what is wrong
with a score discrepancy ranking between 0-255 where 0 means just a note while 255 means something
very a significant discrepancy.

You will find examples in our API when we return for example:

```json Search response for companies theme={null}
{
  "intelligence": [
    {
      "companyIntelligenceType": "annualReportDiscrepancies",
      "notes": "The annual report for 2021-01-01 to 2021-12-31 is
      similar to one or many more annual reports that
      has been submitted for other companies",
      "score": 255,
      "firstSeenAt": 1711843200
    }
  ]
}
```

## Example

A business with an auditor submits an annual report for the year ending 2020-12-31. The following
year another business without an auditor submits a copy of the same annual report
but the multi-year overview is wrong and one of the digits in the organizational number has been
removed.

Visually comparing the result sheet for both businesses you can notice that the rows and amounts are
the same with the difference for the year.

<img alt="resultsheet" />

Visually comparing the balance sheet for both businesses you can notice that the rows and amounts are
the same with the difference for the year.

<img alt="balancesheet" />

The business that made a copy of the annual report report has also copied the overview with the
other business change of equity. The following image shows that the outgoing balance should be 372,707 SEK
in unrestricted equity.

<img alt="change of equity" />

The following year the summary with change of equity doesn't match with the prior year. For the year
ending 2022-12-31 the business reports that the ingoing unrestricted equity balance is 1,245,154 SEK
while the prior year had an outgoing balance of 372,707 SEK. There are no remarks regarding
the changes of the unrestricted equity.

<img alt="change of equity following year" />

In the balance sheet of the business it's reporting a change in credit facility debt of 1,467,157 SEK.

## How common are financial statement frauds

We have learned by looking at discrepancies for the last ten years that financial statement frauds are
more common in businesses that has no auditor but they do exist in both. It's easy to create a new
business, submit a fradulent financial report with good looking numbers and get a descent credit score
ranking by existing credit reference agencies. The companies may then be used to receive contributions
and borrow money and then eventually they go bankrupt.

Often we see networks of companies using the same set of financial records but with no links between
the company representatives. They exist in various industries and cities.

This anonymized example shows a small portion of a network of such companies where eight businesses uses
two set of different financial reports but there are no links between the yellow company representatives.
These companies could ultimatley be controlled by other individuals.

<img alt="example network financial statement fraud" />


# AI Anomaly Detection
Source: https://docs.tic.io/technology/ai-anomaly-detection

How TIC uses artificial intelligence and machine learning to detect hidden patterns and anomalies across company, financial, and behavioural data.

Credit reference agencies typically uses fixed credit scoring models that are applied based on a set on instructions.
Companies that files their annual report seven months after the year ended would typically take up to ten months
before credit assessment is carried out by these agencies.

We, The Intelligence Company AB (publ), are changing the industry by providing an anomaly detection engine that looks
at continous flow of data relating to a business or individual. Similar to network traffic in cybersecurity, changes
surrounding a business triggers an anomaly detection to determine the impact of the change.

## Abnormal or suspicious behaviors

Events that falls outside the normal range called deviations are collected and stored as intelligence metrics.

## Early warning

A sudden change in data from previous behavior could signal increased risks. With us you receive early and accurate
data.

## Financial statement frauds

By combining AI intelligent document processing (IDP) and anomaly
detection we process financial statements and annual reports for businesses to identity risks and thereby offering
credit scoring models that efficiently targets any discrepancies.

In [our solution we describe](/technology/ai-annual-report-intelligence) we describe how the techniques are used
to identity and score discrepancies.


# Domain & social-media monitoring
Source: https://docs.tic.io/technology/domain-and-social-media-monitoring

How TIC uses domain and social-media signals to enrich company intelligence - verifying activity, surfacing reputation data, and spotting dormant shell entities.

As a credit reference agency we believe rich trusted data is important to make the right decisions
and can also be used to detect anomalies and increase sales by delivering better prospecting tools.
We continuously monitor domains belonging to a business, their subdomains, issued certificates,
DNS records and actual content on the pages including usage of payment methods and other services.

## Domains

We have a distributed large network of crawlers that monitors both zone files for selected domains
and [certificate transparency](https://en.wikipedia.org/wiki/Certificate_Transparency) entries. Certificate
transparency logs contains issued certificates and allows us to detect some of the used subdomains and
other important metrics.

## Certificate Logs

Certificate transparency logs contains the entries for issued certificate which reveals information about
subdomains. It can also reveal which companies are using services which can be used for anomaly analysis
and prospecting.

```json Example Certificate Log Entries theme={null}
[
  {
    "issuer_ca_id": 183267,
    "issuer_name": "C=US, O=Let's Encrypt, CN=R3",
    "common_name": "aimn.eng.kb.kundo.se",
    "name_value": "aimn.eng.kb.kundo.se",
    "id": 4621048740,
    "entry_timestamp": "2021-05-31T09:49:11.019",
    "not_before": "2021-05-31T08:49:10",
    "not_after": "2021-08-29T08:49:10",
    "serial_number": "03960b69bbef9f16051fc886795165302746",
    "result_count": 1
  },
  {
    "issuer_ca_id": 183267,
    "issuer_name": "C=US, O=Let's Encrypt, CN=R3",
    "common_name": "k2a.kb.kundo.se",
    "name_value": "k2a.kb.kundo.se",
    "id": 4616950227,
    "entry_timestamp": "2021-05-30T16:12:00.294",
    "not_before": "2021-05-30T15:12:00",
    "not_after": "2021-08-28T15:12:00",
    "serial_number": "04fe8b238d0ab13e6f63e67e40949ca528af",
    "result_count": 2
  }
]
```

## DNS records

We monitor DNS records and their changes daily and make it simple to consume anomalies in modifications
such as try to hide the destination IP-address by proxying calls.

## HTML content

In comparison to traditional web crawling technology that visits web pages periodically and crawls content and links
we use a distributed network of headless browsers to simulate real users and allows crawling HTML generated
by front-end frameworks such as React, Vue, Svelte, Angular and many more. We also automatically detect
front-end APIs and tech stack. Last we also detect usage of Stripe tokens and other payment
gateways.

It's similar to [Wayback Machine](https://en.wikipedia.org/wiki/Wayback_Machine) which is an archive of homepages
found on the internet but our method is tailored for anomaly analysis.

## Social media

We continuously search for social media accounts and pages linked to companies such as Facebook, LinkedIn, X,
Instagram and many more. We look for example at number of posts, last date of post, reviews which is
bundled into anomaly metrics for businesses.

## Payment gateways

HTML pages leaves tracks of usage of payment gateways which is used to determine how they are used across
multiple pages.


# Graph Intelligence Solutions
Source: https://docs.tic.io/technology/graph-visualization

TIC's graph intelligence - traverse ownership, representation, and relationship networks to combat financial crime with intuitive graph visualization.

Use our lightning fast graph API to create stunning user-friendly and intuitive graph visualization for complex
relationships in high-velocity environments. Tailored made for fraud and network risk detection.

Based on C++ graph databases we offer an API that runs an in-memory graph with low latency query times
and employs graph algorithms to make sense of our rich datasets, find critical nodes and detect anomalies.

Compatible with the query language [openCypher](https://opencypher.org/), the open source specification of query language Cypher® originally developed by Neo4j,
and Bolt protocol.

## Fraud risk detection

Use our graph analytics to enhance fraud detection and analyze complex relations. Use ready to use REST endpoints or
access our graph API by using Cypher queries.

With Cyper you are able to quickly find and visualize over 100 million nodes and over 50 million edges representing our
large ecosystem of sources.

```Cypher query example theme={null}
MATCH (c:Company)
WHERE c.id = 3503318
OPTIONAL MATCH path1=(c)-[r1:REPRESENTATIVE_OF]-(:Person)-[r2:REPRESENTATIVE_OF]-(:Company)-[r3:REPRESENTATIVE_OF]-(:Person)-[r4:REPRESENTATIVE_OF]-(:Company)
RETURN c,path1;
```

Example of company and persons and their relationships as both board members and beneficial owners.

<img alt="Graph example" />

## Visualizations in the browser

Our API is compatible with all major visualization software such as:

* [Linkurious Ogma](https://resources.linkurious.com/ogma-overview)
* [Cambridge Intelligence Keylines](https://cambridge-intelligence.com/keylines-javascript-graph-visualization/)
* [Sigma.js](https://www.sigmajs.org/)
* [Memgraph Orb](https://github.com/memgraph/orb)

## How to get started

We have made a few simple steps showing how to integrate with our API and the visualization software [Orb](https://github.com/memgraph/orb).

### Create an html page

This short example is everything you need, just replace the your\_api\_key with your key and pick the company you want to analyze (the company id).

If you wish to use npm just install the Orb library by:

```shell theme={null}
npm install @memgraph/orb
```

```html theme={null}
<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="UTF-8" />
    <title>Orb | Simple graph</title>
    <!-- Direct reference non-minified -->
    <!-- <script src="dist/browser/orb.js"></script> -->
    <!-- Direct reference minified -->
    <!-- <script src="dist/browser/orb.min.js"></script> -->
    <!-- unpkg CDN non-minified -->
    <!-- <script src="https://unpkg.com/@memgraph/orb/dist/browser/orb.js"></script> -->
    <!-- unpkg CDN minified -->
    <script src="https://unpkg.com/@memgraph/orb/dist/browser/orb.min.js"></script>
    <style>
      #graph {
        border: 1px solid #e0e0e0;
        width: 100vw;
        height: 100vh;
      }
    </style>
  </head>
  <body>
    <div id="graph"></div>
    <script>
      window.addEventListener('DOMContentLoaded', async function () {
        // Avoid exposing your API key in requests directly in the browser. It's just here to demonstrate
        // how to get started.
        const response = await fetch(
          'https://lens-api.tic.io/companies/pick_your_id/graph?key=your_api_key'
        );
        const graphJson = await response.json();
        const container = document.getElementById('graph');
        const orb = new Orb.Orb(container);
        orb.data.setup(graphJson);
        orb.view.render(() => {
          orb.view.recenter();
        });
      });
    </script>
  </body>
</html>
```

### Apply styling

You can apply styling based on various nodes and edge properties. This example just illustrates how simple it is to set size, color and title of the nodes.

```html theme={null}
<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="UTF-8" />
    <title>Orb | Simple graph</title>
    <!-- Direct reference non-minified -->
    <!-- <script src="dist/browser/orb.js"></script> -->
    <!-- Direct reference minified -->
    <!-- <script src="dist/browser/orb.min.js"></script> -->
    <!-- unpkg CDN non-minified -->
    <!-- <script src="https://unpkg.com/@memgraph/orb/dist/browser/orb.js"></script> -->
    <!-- unpkg CDN minified -->
    <script src="https://unpkg.com/@memgraph/orb/dist/browser/orb.min.js"></script>
    <style>
      #graph {
        border: 1px solid #e0e0e0;
        width: 100vw;
        height: 100vh;
      }
    </style>
  </head>
  <body>
    <div id="graph"></div>
    <script>
      window.addEventListener('DOMContentLoaded', async function () {
        // Avoid exposing your API key in requests directly in the browser. It's just here to demonstrate
        // how to get started.
        const response = await fetch(
          'https://lens-api.tic.io/companies/pick_your_id/graph?key=your_api_key'
        );
        const graphJson = await response.json();
        const container = document.getElementById('graph');
        const orb = new Orb.Orb(container);
        orb.data.setDefaultStyle({
          getNodeStyle(node) {
            console.log(node);
            // Access various properties for the node - check documentation for more details
            const props = node.data.properties;
            let title = node.data.label;
            if (title == 'Company')
              return {
                color: '#FF0000',
                fontSize: 10,
                size: 6,
                label: `${props.name}`,
              };
            else if (title == 'Person')
              return {
                color: '#00008B',
                fontSize: 10,
                size: 4,
                label: `${props.name}`,
              };
          },
          getEdgeStyle() {
            return {
              color: '#000000',
              width: 0.2,
            };
          },
        });
        orb.data.setup(graphJson);
        orb.view.render(() => {
          orb.view.recenter();
        });
      });
    </script>
  </body>
</html>
```


# Introduction
Source: https://docs.tic.io/technology/introduction

Intelligence at the Speed of Business. LENS - TIC's AI-powered platform for real-time credit, compliance, and risk decisions.

**Intelligence at the Speed of Business.** TIC's **LENS** platform delivers real-time intelligence across credit, compliance, and risk - so your teams can make smarter, faster decisions without waiting for stale reports.

<Tip>
  **LENS** is the TIC intelligence platform. The **LENS API** (v2) gives you programmatic access. A **v1 API** remains available for existing integrations.
</Tip>

TIC is a **licensed credit reference agency** - we go beyond the traditional credit bureau model by combining authoritative public-source data, AI anomaly detection, and intelligent document processing into a single live platform.

## What you can do with LENS

<CardGroup>
  <Card title="Knowledge graphs" icon="diagram-project" href="/technology/graph-visualization">
    Traverse ownership, representation, and relationship networks across companies, persons, properties, and vehicles.
  </Card>

  <Card title="Watchlists & real-time monitoring" icon="bell" href="/webhooks">
    Track entities you care about and receive webhooks, emails, or SMS the moment something changes.
  </Card>

  <Card title="Sentinel forensics" icon="shield-halved" href="/api-lens/sentinel/submit-a-file-for-forensic-analysis">
    Detect document and image fraud with AI-driven forensic analysis - upload a file, get a full report.
  </Card>

  <Card title="Beneficial ownership" icon="user-magnifying-glass" href="/api-lens/companies/get-beneficial-owners-for-a-company">
    Resolve UBOs, verify KYC chains, and spot hidden control structures across jurisdictions.
  </Card>

  <Card title="Anomaly detection" icon="wave-pulse" href="/technology/ai-anomaly-detection">
    Surface unusual patterns in financials, filings, and activity before they become incidents.
  </Card>
</CardGroup>

## Built for

<CardGroup>
  <Card title="Finance" icon="building-columns" />

  <Card title="Insurance" icon="umbrella" />

  <Card title="Compliance & AML" icon="scale-balanced" />

  <Card title="Legal" icon="gavel" />
</CardGroup>

## Choose your API

<CardGroup>
  <Card title="LENS API (recommended)" icon="sparkles" href="/api-lens/introduction">
    **The new standard.** Modern, fully-annotated endpoints with typed schemas, watchlists, Sentinel forensics, and unified search. OpenAPI 3.1. Start here for new integrations.
  </Card>

  <Card title="Legacy API (v1)" icon="server" href="/api-core/introduction">
    **Stable and supported.** The original TIC API - still fully supported for existing integrations. Broad dataset coverage across companies, persons, properties, and vehicles.
  </Card>
</CardGroup>

## Get started

<CardGroup>
  <Card title="Authenticate" icon="key" href="/authentication">
    API-key and JWT flows. Works for both APIs.
  </Card>

  <Card title="Search" icon="magnifying-glass" href="/search">
    Lightning-fast Typesense-backed search across companies, persons, properties, vehicles.
  </Card>

  <Card title="Generate a client" icon="code" href="/generate-client">
    Generate typed SDKs for 60+ languages from our OpenAPI specs.
  </Card>
</CardGroup>

## Datasets

<CardGroup>
  <Card title="Core datasets" icon="globe" href="/datasets/companies">
    Companies, persons, addresses, properties, and vehicles - the foundation of the platform.
  </Card>

  <Card title="Industry datasets" icon="industry" href="/datasets/europeancommission">
    European Commission, Finansinspektionen, ICA, and other industry-specific sources.
  </Card>
</CardGroup>

## About TIC

The Intelligence Company AB (publ) is a licensed credit reference agency. We aggregate authoritative public and commercial data, apply credit scoring and continuous credit assessment, and turn it into actionable intelligence - powered by AI anomaly detection and our IDP engine.


# Rate limits & throttling
Source: https://docs.tic.io/throttling

How TIC protects the API from abuse. Both LENS (v2) and the legacy v1 API use per-IP and per-API-key sliding-window rate limits, with 429 responses when exceeded.

<Info>
  This page is the shared overview for both APIs. For **LENS (v2)** specifics - exact windows, every response header, and the full error reference - see [Rate limits in the v2 API](/api-lens/rate-limits).
</Info>

TIC rate-limits every request to protect the service from abuse and keep response times fast for everyone. When you hit a limit, the API responds with **HTTP 429** and tells you exactly when you can retry via the `Retry-After` header.

## How limits are enforced

Both APIs enforce rate limits at two levels, using sliding windows:

| Level              | Purpose                                                                                               |
| ------------------ | ----------------------------------------------------------------------------------------------------- |
| **Per IP address** | Applied to every request regardless of authentication. Protects the platform from anonymous flooding. |
| **Per API key**    | Applied on top of IP limits for authenticated requests. Your plan determines the quotas.              |

Defaults are below. Actual quotas depend on your plan.

| Level                       | Per minute | Per day | Per month | Unique IPs (per key) |
| --------------------------- | ---------- | ------- | --------- | -------------------- |
| **Per IP** (both APIs)      | 600        | 15,000  | -         | -                    |
| **Per API key** (both APIs) | 60         | -       | 3,000     | 20                   |

For LENS (v2) specifics including all response headers and error messages, see **[Rate limits in the v2 API Reference](/api-lens/rate-limits)**.

## Response headers

Every response includes rate-limit headers so you can track your usage and throttle proactively.

| Header                         | Meaning                                        |
| ------------------------------ | ---------------------------------------------- |
| `X-RateLimit-Limit`            | Quota for the current period                   |
| `X-RateLimit-Remaining`        | Requests remaining in the period               |
| `X-RateLimit-Reset`            | Seconds until the period resets                |
| `X-RateLimit-Limit-Minute`     | Per-minute quota                               |
| `X-RateLimit-Remaining-Minute` | Requests remaining in the current minute       |
| `X-RateLimit-Limit-IP`         | Maximum unique source IPs allowed for the key  |
| `X-RateLimit-Remaining-IP`     | Unique IPs remaining                           |
| `Retry-After`                  | Seconds to wait before retrying (set when 429) |

## 429 response body

When you're throttled, you receive an HTTP 429 with a JSON body describing which window tripped and when it resets.

```json theme={null}
{
  "status": 429,
  "detail": "Too many requests, buy more or upgrade your subscription, check header X-RateLimit-Reset. Will reset at 2024-11-17 07:10:53.",
  "urlForDocumentation": "https://docs.tic.io/throttling"
}
```

**Always read `Retry-After` (or `X-RateLimit-Reset`) and back off.** Do not retry in a tight loop. A well-behaved client reads these headers on every response and adapts pre-emptively.

## IP-based limits

Each API key is capped at a number of unique source IPs per month (default: **20**). This protects you if a key is leaked - an attacker's IP would count against the limit. The downstream IP is read from `X-Real-IP` or `X-Forwarded-For`.

If you run behind a load balancer or a pool of NAT'd outbound IPs, size your quota accordingly.

## Best practices

* **Use exponential backoff** when you get a `429`.
* **Monitor `X-RateLimit-Remaining-Minute`** to throttle proactively rather than reactively.
* **Consolidate traffic through few IPs** to stay under the unique-IP cap.
* **Prefer POST multi-search** where available to combine queries into fewer requests.


# Webhooks & notifications
Source: https://docs.tic.io/webhooks

Receive real-time notifications when monitored entities change. TIC supports webhook, email, and SMS delivery.

<Info>
  This page explains the shared notification model and the **v1 API** URL examples. For the full **LENS (v2)** watchlist surface - CRUD, members, subscriptions, event types, dashboard, and bulk acknowledge - see [Watchlists in the v2 API](/api-lens/watchlists).
</Info>

## Concepts

TIC uses three concepts for change notifications. Keeping them straight makes the rest of this page easier to follow.

| Term                     | Meaning                                                                                                                                                                                        |
| ------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Watchlist**            | A list of entities you want to monitor (companies, persons, addresses, properties, vehicles).                                                                                                  |
| **Notification trigger** | A destination attached to a watchlist that receives notifications. A trigger has a **type** (`webhook`, `email`, or `sms`) and a **destination** (URL, email address, or mobile phone number). |
| **Event**                | A detected change to a watchlist member (e.g. new address, new beneficial owner). Events are delivered to every enabled trigger on the watchlist.                                              |

A webhook is one *type* of notification trigger - specifically, one whose destination is an HTTPS URL. Email and SMS triggers carry a narrower summary; **only webhook triggers receive the full event payload**.

<Tip>
  Use webhook triggers when you need the full event data. Use email/SMS when a human just needs to be alerted that *something* changed.
</Tip>

## Creating a notification trigger

Before a trigger becomes active it must be **confirmed**. Confirmation behavior depends on the trigger type:

### Webhook trigger (URL)

Auto-confirms when the destination URL responds with a successful HTTP status code to the initial confirmation request. Retries up to three times.

### Email trigger

An email is sent to the destination address with a confirmation link. The trigger activates once the recipient clicks it.

### SMS trigger

A text message is sent to the destination mobile number with a confirmation link. The trigger activates once the recipient clicks it.

## Example - creating a webhook trigger

The example below adds a webhook trigger to watchlist `6` that reacts to changes in address, annual reports, intelligence, representatives, and status.

```bash cURL theme={null}
curl \
  --request POST \
  --header "Content-Type: application/json" \
  --header "x-api-key: your_api_key" \
  --data '
    {
      "Destination": "https://webhook.site/cf728358-1738-4ffe-be04-f14a9d28a4de",
      "DestinationType": "webhook",
      "Address": true,
      "AnnualReport": true,
      "Intelligence": true,
      "Representatives": true,
      "Status": true
    }
  ' \
  https://api.tic.io/watchlists/6/triggers
```

```json Response theme={null}
{
  "teamWatchListTriggerId": 2,
  "destination": "https://webhook.site/cf728358-1738-4ffe-be04-f14a9d28a4de",
  "destinationType": "webhook",
  "address": true,
  "annualReport": true,
  "intelligence": true,
  "representatives": true,
  "status": true,
  "hasBeenValidated": false,
  "lastMessageSentAtUtc": null,
  "lastUpdatedAtUtc": "2024-12-22T10:29:39.1746639Z"
}
```

A confirmation notification is then POSTed to the destination URL using the same payload format shown below.

```json Webhook payload theme={null}
[
  {
    "teamWatchListMemberEventId": 1,
    "teamWatchListMemberId": 1,
    "teamWatchListId": 1,
    "externalId": "EXTERNAL ID 1",
    "companyId": 3503318,
    "watchListMemberEventType": "companyAddress",
    "eventDate": "2024-02-02T10:49:24",
    "lastUpdatedAtUtc": "2025-05-02T11:30:09"
  }
]
```

## Testing a webhook trigger

You can test webhook triggers to verify your endpoint handles the payload correctly.

```bash cURL theme={null}
curl \
  --request POST \
  --header "Content-Type: application/json" \
  --header "x-api-key: your_api_key" \
  https://api.tic.io/watchlists/6/triggers/test
```

The test POST carries an array of sample events. Since **2025-05-02**, every event in the array includes the source of the change.

```json Test payload theme={null}
[
  {
    "teamWatchListMemberEventId": 1,
    "teamWatchListMemberId": 9029,
    "teamWatchListId": 18,
    "externalId": "MY_NUMBER_1",
    "companyId": 12345678,
    "watchListMemberEventType": "companyAddress",
    "eventDate": "2024-02-02T10:49:24",
    "lastUpdatedAtUtc": "2025-05-02T11:30:09"
  },
  {
    "teamWatchListMemberEventId": 2,
    "teamWatchListMemberId": 9029,
    "teamWatchListId": 18,
    "externalId": "MY_NUMBER_2",
    "companyId": 12345678,
    "watchListMemberEventType": "companyRegistration",
    "eventDate": "2025-04-09T15:21:04",
    "lastUpdatedAtUtc": "2025-05-02T11:30:09"
  },
  {
    "teamWatchListMemberEventId": 3,
    "teamWatchListMemberId": 9029,
    "teamWatchListId": 18,
    "externalId": "MY_NUMBER_3",
    "companyId": 12345678,
    "watchListMemberEventType": "companyIntelligence",
    "eventDate": "2025-04-13T15:47:27",
    "lastUpdatedAtUtc": "2025-05-02T11:30:09"
  },
  {
    "teamWatchListMemberEventId": 4,
    "teamWatchListMemberId": 9029,
    "teamWatchListId": 18,
    "externalId": "MY_NUMBER_4",
    "companyId": 12345678,
    "watchListMemberEventType": "companyFinancialDocument",
    "eventDate": "2025-02-25T08:51:23",
    "lastUpdatedAtUtc": "2025-05-02T11:30:09"
  }
]
```

## Event types

The `watchListMemberEventType` field identifies what changed. Valid values:

| Type                     | Description                                                         |
| ------------------------ | ------------------------------------------------------------------- |
| companyAddress           | New information about one or more company addresses                 |
| companyName              | New information about the company's legal or trade names            |
| companyStatus            | New information about company status                                |
| companyRegistration      | New information about registration (VAT, payroll, tax, etc.)        |
| companyIntelligence      | New intelligence flags or signals                                   |
| companyBeneficialOwner   | New information about beneficial owners                             |
| companyWorkplace         | New information about one or more workplaces owned by the company   |
| companyPerson            | New information about company representatives                       |
| companyRegisteredOffice  | New information about the registered office                         |
| companyShareCapital      | New information about share capital                                 |
| companyPurpose           | New information about the company's registered purpose              |
| companyDebtBalance       | Changes to the debt balance                                         |
| companyOrderToPayCase    | New information about one or more order-to-pay cases                |
| companyFinancialDocument | New financial documents such as annual reports                      |
| companyCase              | New information about cases (*inneliggande ärenden*)                |
| personAddress            | New information about person addresses                              |
| personName               | New information about person names                                  |
| personStatus             | New information about person status                                 |
| personCompany            | New information about the person's role as a company representative |