Internal IDs
Every entity has a numeric internal ID that is stable and unique within its type.
These IDs are used across all API endpoints:
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.
To find a company by registration number, use the search API:
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:Watchlist IDs
Watchlists and their sub-resources use GUIDs:
See Watchlists for how these are used.
Order IDs
Document orders are identified by GUIDs: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.