Monitoring API - VisionNet API

All requests must first be Authorized over HTTPS.

Company Monitoring. Allows to get latest changes, list, add or remove companies monitored. Below are listed endpoints with parameters and examples

An account can have one of the two modes of monitoring enabled. Certain parameters and responses differs based on the type in use. Account type can be found out by doing a valid request to any of the endpoints and checking returned root object name. Default monitoring type is Normal Monitoring. To change your monitoring type contact your account manager.

Normal Monitoring - Standard monitoring type with list of companies. All alerts will go to the email provided for the account contact.
Individual Monitoring - Monitoring list is grouped by emails, where each email has its own list of companies monitored.

NOTE: Most requests handle multiple company values passed(eg. adding multiple companies or getting changes for a particular list of company numbers). Handling multiple companies in a single request is described at the bottom of the document

List monitored companies

https://api.vision-net.ie/cws/2.3/monitoring/company/list?co_num={{COMPANY_NUM}}&co_notes={{CO_NOTES}}&email={{EMAIL@DOMAIN.COM}}

Parameter	Type	Description
co_num	Number	Optional. Only returns specified company from the list. To filter by multiple companies in a single request look here
co_notes	String	Optional. Only returns entries matching notes string. Allows % and _ wildcards.
email	String	Individual Monitoring Only. Optional. Only returns entries for specified email. Allows % and _ wildcards.

Get company changes

https://api.vision-net.ie/cws/2.3/monitoring/company/changes?co_num={{COMPANY_NUM}}&change_type={{CHANGE_TYPE}}&since_date={{SINCE_DATE}}&co_notes={{CO_NOTES}}&email={{EMAIL@DOMAIN.COM}}

Parameter	Type	Description
since_date	yyyy-MM-dd	Required. Changes since date
co_num	Number	Optional. Only returns changes for specified company. To get changes for multiple specific company numbers look here
change_type	Number	Optional. Only returns changes of specified type. Multiple types can be requested comma separated.
co_notes	String	Optional. Get changes only for companies with notes. Allows % and _ wildcards. To test matching companies you can use /list request
email	Email String	Individual Monitoring Only. Optional. Only returns changes for specified email. Allows % and _ wildcards. To test matching companies you can use /list request

Sample Response for changes?since_date=2022-01-01

{
  "monitor_normal": {
    "unique_companies_total": 2,
    "changes_total": 4,
    "entry": [
      {
        "co_num": 654321,
        "changes": {
          "change": [
            {
              "company_cro_filling": {
                "doc_id": 123456789
              },
              "change_date": "2022-10-21T00:00:00Z",
              "change_description": "DOCUMENT FILED: B47 RESIGNATION OF AUDITOR",
              "change_type_id": 1
            },
            {
              "credit_score_change": {
                "score_curr": 52,
                "doc_id": 123456789,
                "score_prev": 52,
                "change_reason": "WE HAVE ANALYSED A NEW SET OF ACCOUNTS."
              },
              "change_date": "2022-12-10T00:00:00Z",
              "change_description": "UPDATED CREDIT SCORE",
              "change_type_id": 4
            }
          ]
        }
      },
      {
        "co_num": 123456,
        "changes": {
          "change": [
            {
              "company_name_change": {
                "curr_name": "BEST OF THE BEST UNLIMITED COMPANY",
                "prev_name": "BEST OF THE BEST LIMITED"
              },
              "change_date": "2022-02-17T00:00:00Z",
              "change_description": "NAME CHANGE FROM [BEST OF THE BEST LIMITED] TO [BEST OF THE BEST UNLIMITED COMPANY]",
              "change_type_id": 3
            },
            {
              "change_date": "2023-01-10T00:00:00Z",
              "company_status_change": {
                "prev_status_id": 1157,
                "curr_status_id": 1158
              },
              "change_description": "STATUS CHANGE FROM [STRUCK OFF] TO [DISSOLVED]",
              "change_type_id": 2
            }
          ]
        }
      }
    ]
  }
}

Add companies to the monitoring list

https://api.vision-net.ie/cws/2.3/monitoring/company/add?co_num={{COMPANY_NUM}}&co_notes={{CO_NOTES}}&email={{EMAIL@DOMAIN.COM}}

Parameter	Type	Description
co_num	Number	Required. Company number to add to the monitoring list. To add multiple company numbers in single request look here
co_notes	String	Optional. Notes string to save as company reference
email	Email String	Individual Monitoring Only. Required. Only returns entry for specified email company.

Remove companies from monitoring list

https://api.vision-net.ie/cws/2.3/monitoring/company/remove?co_num={{COMPANY_NUM}}&email={{EMAIL@DOMAIN.COM}}

Parameter	Type	Description
co_num	Number	Required. Remove company from monitoring list. To remove multiple company numbers look here
email	Email String	Individual Monitoring Only. Optional. Removes companies for specified email.

Multiple Company Request

Multiple entries can be processed by using a JSON post body request.

Below array object of company numbers can be used for any normal monitoring requests, and individual monitoring requests that do not require email. Other optional parameters in this case will be empty.

[2321,232445,506985,4532]

Below JSON object can be used to send multiple companies with parameters. co_notes is optional(add request only), and email only required for individual monitoring

[ { "co_num": "123", "co_notes": "test note 1", "email": "email@test.ie" }, { "co_num": "12345", "co_notes": "test note 2", "email": "email1@test.ie" } ]

VisionNet Irish Company Information API