Skip to main content
POST
/
watchlists
/
{id}
/
subscriptions
Subscribe a watchlist to event types
curl --request POST \
  --url https://lens-api.tic.io/watchlists/{id}/subscriptions \
  --header 'Content-Type: application/json-patch+json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "eventType": "companyAddress",
  "subscribeToAll": true
}
'
[
  {
    "subscriptionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "eventType": "companyAddress",
    "eventTypeName": "<string>",
    "lastUpdatedAtUtc": "2023-11-07T05:31:56Z"
  }
]

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.

Pro+ tier

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
id
string<uuid>
required

Watchlist GUID

Body

​
eventType
enum<string>
Available options:
companyAddress,
companyName,
companyStatus,
companyRegistration,
companyIntelligence,
companyBeneficialOwner,
companyDocument,
companyWorkplace,
companyPerson,
companyRegisteredOffice,
companyShareCapital,
companyPurpose,
companyDebtBalance,
companyOrderToPayCase,
companyFinancialDocument,
companyCase,
companyWorkplaceAddress,
unused_Company4,
unused_Company5,
unused_Company6,
unused_Company7,
unused_Company8,
unused_Company9,
unused_Company10,
personAddress,
personName,
personIntelligence,
personStatus,
personCompany,
unused_Person1,
unused_Person2,
unused_Person3,
unused_Person4,
unused_Person5,
unused_Person6,
unused_Person7,
unused_Person8,
unused_Person9,
unused_Person10,
propertyOwnershipChange,
propertyMortageDeedChange,
unused_Property1,
unused_Property2,
unused_Property3,
unused_Property4,
unused_Property5,
vehicleOwnerChange,
vehicleUserChange,
vehicleStatusChange,
vehicleInspection,
vehicleStolen,
unused_Vehicle1,
unused_Vehicle2,
unused_Vehicle3,
unused_Vehicle4,
unused_Vehicle5
​
subscribeToAll
boolean

Response

Newly created subscriptions (may be empty if all already existed)

​
subscriptionId
string<uuid>
​
eventType
enum<string>
Available options:
companyAddress,
companyName,
companyStatus,
companyRegistration,
companyIntelligence,
companyBeneficialOwner,
companyDocument,
companyWorkplace,
companyPerson,
companyRegisteredOffice,
companyShareCapital,
companyPurpose,
companyDebtBalance,
companyOrderToPayCase,
companyFinancialDocument,
companyCase,
companyWorkplaceAddress,
unused_Company4,
unused_Company5,
unused_Company6,
unused_Company7,
unused_Company8,
unused_Company9,
unused_Company10,
personAddress,
personName,
personIntelligence,
personStatus,
personCompany,
unused_Person1,
unused_Person2,
unused_Person3,
unused_Person4,
unused_Person5,
unused_Person6,
unused_Person7,
unused_Person8,
unused_Person9,
unused_Person10,
propertyOwnershipChange,
propertyMortageDeedChange,
unused_Property1,
unused_Property2,
unused_Property3,
unused_Property4,
unused_Property5,
vehicleOwnerChange,
vehicleUserChange,
vehicleStatusChange,
vehicleInspection,
vehicleStolen,
unused_Vehicle1,
unused_Vehicle2,
unused_Vehicle3,
unused_Vehicle4,
unused_Vehicle5
​
eventTypeName
null | string
​
lastUpdatedAtUtc
string<date-time>