API Documentation

Connections

First step with perfoming Due Diligence or sharing your profile is to connect with other registered companies in GRC Watch.

Get your connections

To get the complete list of your connections, call the company connections endpoint.

GET /api/companies/connections

[
  {
    "id": "COMPANY-ID",
    "name": "Example company 1",
  },
  {
    "id": COMPANY-ID,
    "name": "Example company 2"
  },
  {
    "id": COMPANY-ID,
    "name": "Example company 2"
  },
  ...
]

Get connection information

For retrieving details about the company you are connected with, utilize the GET api/companies/connections/{connection-company-id} endpoint. You should use the specific companyId of the connection you wish to acquire information about.

GET /api/companies/connections/{connection-company-id}

{
  "id": "COMPANY-ID",
  "name": "Example company 1",
  "country": "Sweden",
  "readingRights": {
    "given": {
      "companyTypeIds": [ COMPANY-TYPE-ID, COMPANY-TYPE-ID ]
    },
    "received": {
      "companyTypeIds": [ COMPANY-TYPE-ID ]
    }
  }
}