API Reference

searchCompaniesByTerm (company screening)

Enables users to consume necessary information to enhance its due diligence of companies.

Arguments

NameTypeDescription
searchTermString!The query returns companies with matching names.

Returns

NameDescription
[Company!]!The company-related attributes.

Company fields

NameTypeDescription
complianceRiskCompanyComplianceRisk!The compliance risk level of a company (sanctioned/high/moderate/low).
countryEnumStringA country identifier set by Windward.
dunsStringThe company Dun & Bradstreet ID.
idObjectIdThe company Unique Windward assigned ID.
nameStringThe company name.
nationalityOfRegistrationStringThe country in which the company is registered.
roles[String]The role types the company has in relation to vessels.
sanctions[CompanySanction!]!The sanction program the company is associated with.

Example Code

Sample Query

query SearchCompaniesByTerm($searchTerm: String!) {
  searchCompaniesByTerm(searchTerm: $searchTerm) {
    id
    name
    countryEnum
    duns
    nationalityOfRegistration
    roles
    complianceRisk {
      level
      program
      riskySince
      buildingBlocks {
        name
        count
        level
        program
      }
    }
    sanctions {
      source
      comment
      insertDate
      removalDate
      listType
      program
      companyName
    }    
  }
}

Variables

{
  "searchTerm": "Parsian Golden Sea Shipping Company"
}

Response

{
  "data": {
    "searchCompaniesByTerm": [
      {
        "id": "5fec49b3ca5c4c43da6c2708",
        "name": "Parsian Golden Sea Shipping Company",
        "countryEnum": "Iran",
        "duns": "534617613",
        "nationalityOfRegistration": null,
        "roles": [
          "BENEFICIAL_OWNER",
          "COMMERCIAL_CONTROLLER",
          "OPERATOR",
          "OWNER",
          "MANAGEMENT"
        ],
        "complianceRisk": {
          "level": "High",
          "program": [
            "IRAN"
          ],
          "riskySince": null,
          "buildingBlocks": [
            {
              "name": "SANCTIONED_COUNTRY",
              "count": null,
              "level": "High",
              "program": null
            },
            {
              "name": "SANCTIONED_COUNTRY_VESSEL",
              "count": null,
              "level": "Medium",
              "program": null
            },
            {
              "name": "SANCTIONED_COMPANY",
              "count": null,
              "level": "Low",
              "program": null
            },
            {
              "name": "SANCTIONED_VESSEL",
              "count": null,
              "level": "Low",
              "program": null
            }
          ]
        },
        "sanctions": []
      }
    ]
  }
}