---
updatedAt: 2024-12-11T17:28:36.000Z
agentTools:
  projectIndex: https://developer.windward.ai/llms.txt
---

# searchCompaniesByTerm (company screening)

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

# Arguments

| Name       | Type                   | Description                                      |
| :--------- | :--------------------- | :----------------------------------------------- |
| searchTerm | [String!](https://developer.windward.ai/reference/scalars) | The query returns companies with matching names. |

# Returns

| Name                         | Description                     |
| :--------------------------- | :------------------------------ |
| [\[Company!\]!](ref:company) | The company-related attributes. |

## Company fields

| Name                      | Type                                                                             | Description                                                            |
| :------------------------ | :------------------------------------------------------------------------------- | :--------------------------------------------------------------------- |
| complianceRisk            | [CompanyComplianceRisk!](https://developer.windward.ai/reference/companycompliancerisk)                              | The compliance risk level of a company (sanctioned/high/moderate/low). |
| countryEnum               | [String](https://developer.windward.ai/reference/scalars)                                                            | A country identifier set by Windward.                                  |
| duns                      | [String](https://developer.windward.ai/reference/scalars)                                                            | The company Dun & Bradstreet ID.                                       |
| id                        | [ObjectId](https://developer.windward.ai/reference/scalars)                                                          | The company Unique Windward assigned ID.                               |
| name                      | [String](https://developer.windward.ai/reference/scalars)                                                            | The company name.                                                      |
| nationalityOfRegistration | [String](https://developer.windward.ai/reference/scalars)                                                            | The country in which the company is registered.                        |
| roles                     | [\[String\]](ref:scalars)                                                        | The role types the company has in relation to vessels.                 |
| sanctions                 | [\[CompanySanction!\]!](ref:companysanction)                                     | The sanction program the company is associated with.                   |
| worldCheckOneIds          | [\[String\]](https://dash.readme.com/project/windward-gql-api/v1.0/refs/scalars) | The company World-Check One ID.                                        |

# Example Code

## Sample Query

```graphql
query SearchCompaniesByName($searchTerm: String, $limit: PositiveInt, $includeHistorical: Boolean, $roles: [CompanyRole!]) {
  searchCompaniesByName(searchTerm: $searchTerm, limit: $limit) {
    id
    name
    countryEnum
    roles
        complianceRisk {
      level
      program
      riskySince
      buildingBlocks {
        name
        count
        level
        program
      }
    }


  }
}
```

## Variables

```json
{
{
  "searchTerm": "Marine Trans Shipping"
}}
```

## Response

```json
{
  "data": {
    "searchCompaniesByName": [
      {
        "id": "60a33f318c64fe19d01ce17e",
        "name": "Marine Trans Shipping",
        "countryEnum": "Russia",
        "roles": [
          "OPERATOR",
          "OWNER",
          "ISM_MANAGER",
          "MANAGEMENT",
          "TECHNICAL_MANAGER"
        ],
        "complianceRisk": {
          "level": "Sanctioned",
          "program": [
            "RUSSIA_GENERAL"
          ],
          "riskySince": "2022-05-01T00:00:00.000Z",
          "buildingBlocks": [
            {
              "name": "SANCTIONED_COMPANY",
              "count": 3,
              "level": "Sanctioned",
              "program": null
            },
            {
              "name": "SANCTIONED_VESSEL",
              "count": 12,
              "level": "High",
              "program": null
            },
            {
              "name": "SANCTIONED_COUNTRY",
              "count": 1,
              "level": "Medium",
              "program": null
            },
            {
              "name": "SANCTIONED_COUNTRY_VESSEL",
              "count": 5,
              "level": "Medium",
              "program": null
            }
          ]
        },
  }
}
```