Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.tic.io/llms.txt

Use this file to discover all available pages before exploring further.

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.
EntityID fieldTypeExample
CompanycompanyIdint3508351
PersonpersonIdint2954253
AddressaddressIdint12345
VehiclevehicleIdint789012
PropertypropertyIdint456789
WorkplacecompanyWorkplaceIdint234567
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.
FieldDescriptionExample
registrationNumberLocal registration number5565199493
personalIdentityNumberPersonal identity number (persons)Varies by country
To find a company by registration number, use the search API: 
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:
EntityTypeExample
WatchlistGuida1b2c3d4-e5f6-...
Watchlist memberGuidf6e5d4c3-b2a1-...
NotificationGuid12345678-abcd-...
SubscriptionGuidabcdef01-2345-...
See 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

1

Search

Search for a company by name or registration number to get companyId.
2

Fetch details

Use GET /companies/{companyId} to get the full company record.
3

Drill into sub-resources

Use GET /companies/{companyId}/representatives to get personId values.
4

Follow connections

Use GET /persons/{personId} or POST /persons/{personId}/companies to see their other positions.
5

Monitor changes

Use POST /watchlists/{watchlistGuid}/companies/{companyId} to add the company to a watchlist.