TIC

https://docs.tic.io/
Admin
TIC is a licensed credit reference agency that provides an API for businesses and individuals to...
Tokens:408,220
Snippets:1,454
Trust Score:7.4
Update:3 months ago
Show doc for...
Tokens:
Raw
### Accessing Document Orders via GUID

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

Retrieve document order information and files using the order GUID.

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

--------------------------------

### Authentication example

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

Demonstrates how to include the API key in the request header for authentication.

```bash
curl -H "x-api-key: YOUR_API_KEY" https://lens-api.tic.io/companies/123
```

--------------------------------

### GET /sentinel/jobs/{guid}

Source: https://docs.tic.io/api-lens/sentinel/get-sentinel-job-status-and-report

Retrieves the status and report for a specific Sentinel job identified by its GUID.

```APIDOC
## GET /sentinel/jobs/{guid}

### Description
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.

### Method
GET

### Endpoint
/sentinel/jobs/{guid}

### Parameters
#### Path Parameters
- **guid** (string, uuid) - Required - SentinelJobGuid returned from /analyze

### Response
#### Success Response (200)
- **report** (object) - Job analysis report
- **language** (string) - Language of the job
- **webhook** (object) - Webhook information
- **sentinelJobGuid** (string) - Job GUID
- **filename** (string) - Name of the file
- **status** (string) - Current status of the job
- **stage** (string) - Current processing stage
- **progress** (number) - Progress percentage
- **pageCount** (integer) - Number of pages
- **riskScore** (number) - Calculated risk score
- **riskLevel** (string) - Risk level classification
- **verdictSummary** (string) - Summary of the verdict
- **errorMessage** (string) - Error message if failed
- **fileSizeBytes** (integer) - Size of the file in bytes
- **createdAtUtc** (string) - Creation timestamp
- **completedAtUtc** (string) - Completion timestamp

#### Error Response (404)
- Job not found in this team
```

--------------------------------

### Create a watchlist

Source: https://docs.tic.io/api-lens/watchlists

Creates a new watchlist with the provided name and description.

```bash
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" }'
```

--------------------------------

### GET /orders/{orderGuid}

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

Retrieves the core metadata of a document order identified by its GUID.

```APIDOC
## GET /orders/{orderGuid}

### Description
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.

### Method
GET

### Endpoint
https://lens-api.tic.io/orders/{orderGuid}

### Parameters
#### Path Parameters
- **orderGuid** (string, uuid) - Required - Public order identifier (GUID)

### Response
#### Success Response (200)
- **teamDocumentOrderId** (integer) - Internal ID of the order
- **teamId** (integer) - ID of the team
- **teamName** (string) - Name of the team
- **documentOrderGuid** (string) - GUID of the order
- **documentTitle** (string) - Title of the document
- **documentOrderDate** (string) - Date of the order
- **price** (number) - Price of the order
- **lastUpdatedAtUtc** (string) - Last update timestamp
- **legalName** (string) - Legal name associated with the order
- **companyRegistrationNumber** (string) - Registration number of the company
- **personalIdentityNumber** (string) - Personal identity number
- **firstName** (string) - First name
- **lastName** (string) - Last name

#### Error Response (404)
- Order not found
```

--------------------------------

### Initialize Basic Graph Visualization

Source: https://docs.tic.io/technology/graph-visualization

A minimal HTML template to fetch graph data from the Tic.io API and render it using the Orb library.

```html
<!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>
```

--------------------------------

### GET /orders/{orderGuid}/content

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

Retrieves the structured (parsed) content of a document order identified by its GUID.

```APIDOC
## GET /orders/{orderGuid}/content

### Description
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.

### Method
GET

### Endpoint
/orders/{orderGuid}/content

### Parameters
#### Path Parameters
- **orderGuid** (string, uuid) - Required - Public order identifier (GUID)

### Response
#### Success Response (200)
- **content** (object) - Structured order content

#### Error Response (404)
- Order or content not found
```

--------------------------------

### Install Orb via NPM

Source: https://docs.tic.io/technology/graph-visualization

Use this command to add the Orb library to your project dependencies.

```shell
npm install @memgraph/orb
```

--------------------------------

### GET /sentinel/jobs/{guid}/annotations/{type}

Source: https://docs.tic.io/api-lens/sentinel/download-a-forensic-annotation-image

Proxies a PNG annotation image from the Sentinel backend for a completed job.

```APIDOC
## GET /sentinel/jobs/{guid}/annotations/{type}

### Description
Proxies a PNG annotation image from the Sentinel backend for a completed job.

### Method
GET

### Endpoint
/sentinel/jobs/{guid}/annotations/{type}

### Parameters
#### Path Parameters
- **guid** (string, uuid) - Required - SentinelJobGuid of the job
- **type** (string) - Required - Annotation type: "ela", "noise", "cfa", "forensic", or "overview"

### Response
#### Success Response (200)
- **image/png** (binary) - PNG image data

#### Error Responses
- **404** - Job or annotation not found
- **502** - Sentinel backend error or unavailable
```

--------------------------------

### Example Certificate Log Entries

Source: https://docs.tic.io/technology/domain-and-social-media-monitoring

Sample JSON structure representing entries from certificate transparency logs, including issuer details, common names, and timestamps.

```json
[
  {
    "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
  }
]
```

--------------------------------

### OpenAPI Specification for PDF Report Download

Source: https://docs.tic.io/api-lens/sentinel/download-pdf-forensic-report

Defines the GET endpoint for retrieving a PDF forensic report using a job GUID.

```yaml
paths:
  /sentinel/jobs/{guid}/report.pdf:
    get:
      tags:
        - Sentinel
      summary: Download PDF forensic report
      description: >-
        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.
      operationId: DownloadSentinelReport
      parameters:
        - name: guid
          in: path
          description: SentinelJobGuid of the completed job
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: PDF report
          content:
            application/pdf:
              schema:
                type: string
                format: binary
        '400':
          description: Job has not completed or report data is missing
        '404':
          description: Job not found in this team
```

--------------------------------

### OpenAPI definition for downloading order binary content

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

Defines the GET endpoint for streaming order exports, requiring a valid order GUID and an API key.

```yaml
openapi: 3.1.1
info:
  title: TIC Lens API
  description: "The TIC Lens API provides programmatic access to company, person, property, vehicle, and order data.\r\n\r\n## Authentication\r\n\r\nAll requests require an API key passed via the `x-api-key` header:\r\n\r\n```bash\r\ncurl -H \"x-api-key: YOUR_API_KEY\" https://lens-api.tic.io/companies/123\r\n```\r\n\r\nAPI keys are managed through the TIC Lens web application under **Settings → API Keys**.\r\n\r\n## Base URL\r\n\r\n| Environment | URL |\r\n|-------------|-----|\r\n| Production  | `https://lens-api.tic.io` |\r\n\r\n## Feature Access\r\n\r\nEndpoints are gated by your subscription plan. If your plan does not include a feature, the endpoint will return `403 Forbidden`.\r\n\r\n## Rate Limits\r\n\r\nRate limits are applied per API key. If you exceed the limit, requests will return `429 Too Many Requests`.\r\n\r\n## Response Format\r\n\r\nAll responses are JSON. Null values are omitted from responses.\r\n"
  version: v1
servers:
  - url: https://lens-api.tic.io
security:
  - ApiKey: []
tags:
  - name: Addresses
  - name: Bolagsverket
  - name: Brf
  - name: Companies
  - name: Documents
  - name: FlightImages
  - name: Free
  - name: Orders
  - name: OrdersExports
  - name: PaymentControl
  - name: PaymentControlImport
  - name: Persons
  - name: Properties
  - name: PublicSearch
  - name: SearchAutocomplete
  - name: Sentinel
  - name: ServingPermits
  - name: Team
  - name: Teams
  - name: Transportstyrelsen
  - name: Vehicles
  - name: WatchList
paths:
  /orders/exports/{orderGuid}/download:
    get:
      tags:
        - OrdersExports
      summary: Download the binary content of an order
      description: >-
        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.
      operationId: DownloadOrderExport
      parameters:
        - name: orderGuid
          in: path
          description: Public order identifier (GUID)
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Binary file stream
        '404':
          description: Order not found, no content rows, or content has no FileIdentifier
components:
  securitySchemes:
    ApiKey:
      type: apiKey
      name: x-api-key
      in: header
```

--------------------------------

### Create a basic reusable snippet

Source: https://docs.tic.io/essentials/reusable-snippets

Define content in a file within the snippets directory to be reused across multiple pages.

```mdx
Hello world! This is my content I want to reuse across pages. My keyword of the
day is {word}.
```

--------------------------------

### GET /sentinel/jobs/{guid}/report.pdf

Source: https://docs.tic.io/api-lens/sentinel/download-pdf-forensic-report

Generates and returns a PDF forensic report for a completed job, including the original image, forensic explanation, findings, annotations, and metadata.

```APIDOC
## GET /sentinel/jobs/{guid}/report.pdf

### Description
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.

### Method
GET

### Endpoint
/sentinel/jobs/{guid}/report.pdf

### Parameters
#### Path Parameters
- **guid** (string, uuid) - Required - SentinelJobGuid of the completed job

### Response
#### Success Response (200)
- **application/pdf** (binary) - PDF report

#### Error Responses
- **400** - Job has not completed or report data is missing
- **404** - Job not found in this team
```

--------------------------------

### Import and use a reusable component

Source: https://docs.tic.io/essentials/reusable-snippets

Import the component from the snippet file and pass props to it in the destination file.

```mdx
---
title: My title
description: My Description
---

import { MyComponent } from '/snippets/custom-component.mdx';

Lorem ipsum dolor sit amet.

<MyComponent title={'Custom title'} />
```

--------------------------------

### Apply Custom Node and Edge Styling

Source: https://docs.tic.io/technology/graph-visualization

Demonstrates how to define custom styles for nodes and edges based on their properties using setDefaultStyle.

```html
<!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>
```

--------------------------------

### Import a reusable snippet

Source: https://docs.tic.io/essentials/reusable-snippets

Import the snippet file into a destination file and render it as a component.

```mdx
---
title: My title
description: My Description
---

import MySnippet from '/snippets/path/to/my-snippet.mdx';

## Header

Lorem impsum dolor sit amet.

<MySnippet word="bananas" />
```

--------------------------------

### Get Sentinel backend capabilities OpenAPI definition

Source: https://docs.tic.io/api-lens/sentinel/get-sentinel-backend-capabilities

The OpenAPI specification for the GET /sentinel/capabilities endpoint, including the response schema for Sentinel capabilities.

```yaml
openapi: 3.1.1
info:
  title: TIC Lens API
  description: "The TIC Lens API provides programmatic access to company, person, property, vehicle, and order data.\r\n\r\n## Authentication\r\n\r\nAll requests require an API key passed via the `x-api-key` header:\r\n\r\n```bash\r\ncurl -H \"x-api-key: YOUR_API_KEY\" https://lens-api.tic.io/companies/123\r\n```\r\n\r\nAPI keys are managed through the TIC Lens web application under **Settings → API Keys**.\r\n\r\n## Base URL\r\n\r\n| Environment | URL |\r\n|-------------|-----|\r\n| Production  | `https://lens-api.tic.io` |\r\n\r\n## Feature Access\r\n\r\nEndpoints are gated by your subscription plan. If your plan does not include a feature, the endpoint will return `403 Forbidden`.\r\n\r\n## Rate Limits\r\n\r\nRate limits are applied per API key. If you exceed the limit, requests will return `429 Too Many Requests`.\r\n\r\n## Response Format\r\n\r\nAll responses are JSON. Null values are omitted from responses.\r\n"
  version: v1
servers:
  - url: https://lens-api.tic.io
security:
  - ApiKey: []
tags:
  - name: Addresses
  - name: Bolagsverket
  - name: Brf
  - name: Companies
  - name: Documents
  - name: FlightImages
  - name: Free
  - name: Orders
  - name: OrdersExports
  - name: PaymentControl
  - name: PaymentControlImport
  - name: Persons
  - name: Properties
  - name: PublicSearch
  - name: SearchAutocomplete
  - name: Sentinel
  - name: ServingPermits
  - name: Team
  - name: Teams
  - name: Transportstyrelsen
  - name: Vehicles
  - name: WatchList
paths:
  /sentinel/capabilities:
    get:
      tags:
        - Sentinel
      summary: Get Sentinel backend capabilities
      description: >-
        Returns the Sentinel backend's advertised capabilities — available
        analyzers, GPU/ML/VLM status, supported file formats, and the max upload
        size.
      operationId: GetSentinelCapabilities
      responses:
        '200':
          description: Backend capabilities
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/Ormeo_Web_Lens_Models_Sentinel_SentinelCapabilities_Dto
        '502':
          description: Sentinel backend unavailable
components:
  schemas:
    Ormeo_Web_Lens_Models_Sentinel_SentinelCapabilities_Dto:
      type: object
      properties:
        analyzers:
          type:
            - 'null'
            - array
          items:
            $ref: >-
              #/components/schemas/Ormeo_Web_Lens_Models_Sentinel_SentinelAnalyzerInfo_Dto
        gpuAvailable:
          type: boolean
        mlAvailable:
          type: boolean
        vlmAvailable:
          type: boolean
        supportedFormats:
          type:
            - 'null'
            - array
          items:
            type: string
        annotationTypes:
          type:
            - 'null'
            - array
          items:
            type: string
        maxUploadBytes:
          type: integer
          format: int64
      additionalProperties: false
    Ormeo_Web_Lens_Models_Sentinel_SentinelAnalyzerInfo_Dto:
      type: object
      properties:
        name:
          type:
            - 'null'
            - string
        stage:
          type:
            - 'null'
            - string
        available:
          type: boolean
      additionalProperties: false
  securitySchemes:
    ApiKey:
      type: apiKey
      name: x-api-key
      in: header
```

--------------------------------

### GET /watchlists

Source: https://docs.tic.io/api-lens/watchlist/list-watchlists-for-the-team

Lists all the watchlists for the team.

```APIDOC
## GET /watchlists

### Description
Lists all the watchlists for the team. 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.

### Method
GET

### Endpoint
/watchlists

### Parameters
#### Query Parameters
- **query** (string) - Optional - Watch list or team name, use % for wildcard
- **lastItemId** (integer) - Optional - Take records after the id (default: 0)
- **pageSize** (integer) - Optional - Page size (default: 100)

### Response
#### Success Response (200)
- **pageSize** (integer) - Page size
- **lastItemId** (integer) - Last item ID
- **totalItems** (integer) - Total number of items
- **items** (array) - List of watchlists
  - **teamWatchListId** (integer) - ID of the team watchlist
  - **watchListName** (string) - Name of the watchlist
  - **watchListDescription** (string) - Description of the watchlist
  - **lastUpdatedAtUtc** (string) - Timestamp of the last update in UTC
```

--------------------------------

### Configure Folder-based Navigation

Source: https://docs.tic.io/essentials/navigation

Reference MDX files located within subdirectories by including the folder path in the pages array.

```json
"navigation": [
    {
        "group": "Group Name",
        "pages": ["your-folder/your-page"]
    }
]
```

--------------------------------

### Generate a TypeScript client for the LENS API

Source: https://docs.tic.io/generate-client

Uses the typescript-fetch generator to create a client in the ./tic-lens-client directory.

```bash
npx @openapitools/openapi-generator-cli generate \
  -i https://lens-api.tic.io/docs/v1/swagger.json \
  -g typescript-fetch \
  -o ./tic-lens-client
```

--------------------------------

### Update a watchlist

Source: https://docs.tic.io/api-lens/watchlists

Updates an existing watchlist using its GUID.

```http
PUT /watchlists/{watchlistGuid}
```

--------------------------------

### Configure Mode Toggle

Source: https://docs.tic.io/essentials/settings

Use these configurations to force a specific theme by setting the default mode and hiding the toggle.

```json
"modeToggle": {
  "default": "dark",
  "isHidden": true
}
```

```json
"modeToggle": {
  "default": "light",
  "isHidden": true
}
```

--------------------------------

### GET /watchlists

Source: https://docs.tic.io/api-lens/watchlists

Retrieve a list of all watchlists for the authenticated user.

```APIDOC
## GET /watchlists

### Description
Retrieve a list of all watchlists for the authenticated user.

### Method
GET

### Endpoint
https://lens-api.tic.io/watchlists

### Parameters
#### Query Parameters
- **sortBy** (string) - Optional - Sort by 'name' or 'created'. Defaults to 'name'.

### Response
#### Success Response (200)
- **watchListGuid** (string) - Unique identifier for the watchlist
- **watchListName** (string) - Name of the watchlist
- **watchListDescription** (string) - Description of the watchlist
- **numberOfCompanies** (integer) - Count of companies in the list
- **numberOfPersons** (integer) - Count of persons in the list
- **numberOfNotifications** (integer) - Count of notifications
- **numberOfSubscriptions** (integer) - Count of subscriptions
- **numberOfUnacknowledgedEvents** (integer) - Count of unacknowledged events
```

--------------------------------

### GET /search/vehicles/se

Source: https://docs.tic.io/datasets/search-vehicles

Search for vehicles by VIN or manufacturer name.

```APIDOC
## GET /search/vehicles/se

### Description
Search for vehicles using a query string and specifying the field to search by.

### Method
GET

### Endpoint
https://api.tic.io/search/vehicles/se

### Query Parameters
- **q** (string) - Required - The search term (e.g., VIN or manufacturer name).
- **query_by** (string) - Required - The field to search by (e.g., 'vin' or 'fabric').
- **key** (string) - Required - Your API authentication key.

### Response
#### Success Response (200)
- **facet_counts** (array) - List of facet counts.
- **found** (integer) - Total number of results found.
- **hits** (array) - List of matching vehicle documents.
```

--------------------------------

### Initialize a MapLibre map instance

Source: https://docs.tic.io/maps/introduction

Define a container element and initialize the map object with the specified style and starting coordinates.

```HTML
<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>
```

--------------------------------

### Add an image with Markdown

Source: https://docs.tic.io/essentials/images

Standard Markdown syntax for images. Ensure the file size is under 5MB.

```md
![title](/path/image.jpg)
```
Tokens:
Raw