> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# CrustData V2: Enrich Company

> Retrieve detailed company data using one or more identifiers. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

Retrieve detailed company data using one or more identifiers.

> [!NOTE]
>
> Tool ID: `crustdata_v2_enrich_company`

## Run this action

Use the TypeScript SDK for one call. Use `ctx.tools.execute(...)` inside a Play for durable calls, scheduled calls, or CSV processing.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'crustdata_v2_enrich_company',
  {
    "company_domain": "example.com",
    "company_name": "Example Corp",
    "company_linkedin_url": "https://www.linkedin.com/in/jane-doe"
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute crustdata_v2_enrich_company --input '{
  "company_domain": "example.com",
  "company_name": "Example Corp",
  "company_linkedin_url": "https://www.linkedin.com/in/jane-doe"
}' --json
```

## Example response

The SDK returns this shape at `result.toolResponse.raw`. The example values illustrate the response.

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "data": {
    "company_id": 123,
    "company_name": "Example Corp",
    "linkedin_profile_url": "https://www.linkedin.com/in/jane-doe"
  }
}
```

Use `deepline describe crustdata_v2_enrich_company --json` for the latest machine-readable contract.

## Input reference

Retrieve detailed company data using one or more identifiers. **At least one** of `company_domain`, `company_name`, `company_linkedin_url`, or `company_id` must be supplied.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.company_domain` | `string` | No | — | Comma-separated list (max 25) of company domains. |
| `payload.company_name` | `string` | No | — | Comma-separated list (max 25) of company names. If a name itself contains a comma, wrap it in double quotes. |
| `payload.company_linkedin_url` | `string` | No | — | Comma-separated list (max 25) of LinkedIn company profile URLs. |
| `payload.company_id` | `string` | No | — | Comma-separated list (max 25) of Crustdata company IDs. |
| `payload.fields` | `string` | No | — | Comma-separated list of fields to include in the response (supports dot-notation for nested fields). |
| `payload.enrich_realtime` | `boolean` | No | — | When **true** and a company isn't in the DB, Crustdata enriches it within \~10 minutes. Default: **false**. |
| `payload.exact_match` | `boolean` | No | — | If **true**, identifiers must match exactly. if **false**, best-match logic applies. Default: **false**. |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Retrieve detailed company data using one or more identifiers. **At least one** of `company_domain`, `company_name`, `company_linkedin_url`, or `company_id` must be supplied.",
    "properties": {
      "company_domain": {
        "type": "string",
        "description": "Comma-separated list (max 25) of company domains."
      },
      "company_name": {
        "type": "string",
        "description": "Comma-separated list (max 25) of company names. If a name itself contains a comma, wrap it in double quotes."
      },
      "company_linkedin_url": {
        "type": "string",
        "description": "Comma-separated list (max 25) of LinkedIn company profile URLs."
      },
      "company_id": {
        "type": "string",
        "description": "Comma-separated list (max 25) of Crustdata company IDs."
      },
      "fields": {
        "type": "string",
        "description": "Comma-separated list of fields to include in the response (supports dot-notation for nested fields)."
      },
      "enrich_realtime": {
        "type": "boolean",
        "description": "When **true** and a company isn't in the DB, Crustdata enriches it within ~10 minutes. Default: **false**."
      },
      "exact_match": {
        "type": "boolean",
        "description": "If **true**, identifiers must match exactly; if **false**, best-match logic applies. Default: **false**."
      }
    },
    "required": [],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object \| array` | Yes | — | Provider response payload. |
| `result.data.company_id` | `integer` | No | — | Unique identifier for the company |
| `result.data.company_name` | `string` | No | — | Name of the company. |
| `result.data.linkedin_profile_url` | `string` | No | — | URL of the company's LinkedIn profile. |
| `result.data.company_twitter_url` | `string` | No | — | URL of the company's Twitter profile. |
| `result.data.company_website_domain` | `string` | No | — | Domain name of the company's website. |
| `result.data.hq_country` | `string` | No | — | Country where the company's headquarters are located. |
| `result.data.largest_headcount_country` | `string` | No | — | Country where the company has the largest number of employees. |
| `result.data.hq_street_address` | `string` | No | — | Street address of the company's headquarters. |
| `result.data.company_website` | `string` | No | — | URL of the company's website. |
| `result.data.year_founded` | `string` | No | — | Year the company was founded. |
| `result.data.fiscal_year_end` | `string` | No | — | Month in which the company's fiscal year ends. |
| `result.data.linkedin_company_description` | `string` | No | — | Description of the company from its LinkedIn profile. |
| `result.data.acquisition_status` | `string` | No | — | Whether the company has been acquired by another company. (null in this example) |
| `result.data.markets` | `array` | No | — | Stock exchanges where the company's stock is traded. |
| `result.data.ceo_location` | `string` | No | — | — |
| `result.data.all_office_addresses` | `array` | No | — | — |
| `result.data.taxonomy` | `record` | No | — | — |
| `result.data.headcount` | `record` | No | — | — |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "description": "Provider response payload.",
        "anyOf": [
          {
            "type": "object",
            "properties": {
              "company_id": {
                "type": "integer",
                "description": "Unique identifier for the company"
              },
              "company_name": {
                "type": "string",
                "description": "Name of the company."
              },
              "linkedin_profile_url": {
                "type": "string",
                "description": "URL of the company's LinkedIn profile."
              },
              "company_twitter_url": {
                "type": "string",
                "description": "URL of the company's Twitter profile."
              },
              "company_website_domain": {
                "type": "string",
                "description": "Domain name of the company's website."
              },
              "hq_country": {
                "type": "string",
                "description": "Country where the company's headquarters are located."
              },
              "largest_headcount_country": {
                "type": "string",
                "description": "Country where the company has the largest number of employees."
              },
              "hq_street_address": {
                "type": "string",
                "description": "Street address of the company's headquarters."
              },
              "company_website": {
                "type": "string",
                "description": "URL of the company's website."
              },
              "year_founded": {
                "type": "string",
                "description": "Year the company was founded.",
                "format": "date"
              },
              "fiscal_year_end": {
                "type": "string",
                "description": "Month in which the company's fiscal year ends."
              },
              "linkedin_company_description": {
                "type": "string",
                "description": "Description of the company from its LinkedIn profile."
              },
              "acquisition_status": {
                "type": "string",
                "description": "Whether the company has been acquired by another company. (null in this example)"
              },
              "markets": {
                "type": "array",
                "description": "Stock exchanges where the company's stock is traded.",
                "items": {
                  "type": "string"
                }
              },
              "ceo_location": {
                "type": "string"
              },
              "all_office_addresses": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "taxonomy": {
                "type": "object"
              },
              "headcount": {
                "type": "object"
              }
            },
            "additionalProperties": false
          },
          {
            "type": "array",
            "description": "An array of objects describing companies currently under enrichment.",
            "items": {
              "type": "object",
              "properties": {
                "status": {
                  "type": "string",
                  "description": "Status of the enrichment operation"
                },
                "message": {
                  "type": "string",
                  "description": "Message describing the enrichment status"
                },
                "companies": {
                  "type": "array",
                  "description": "A list of companies pending enrichment",
                  "items": {
                    "type": "object",
                    "properties": {
                      "identifier": {
                        "type": "string",
                        "description": "Identifier for the company (e.g. domain or LinkedIn URL)"
                      },
                      "type": {
                        "type": "string",
                        "description": "Type of identifier (e.g. 'linkedin_url', 'company_domain')"
                      }
                    },
                    "additionalProperties": false
                  }
                }
              },
              "additionalProperties": false
            }
          },
          {
            "type": "array",
            "description": "An array of objects describing companies that could not be found even after enrichment.",
            "items": {
              "type": "object",
              "properties": {
                "status": {
                  "type": "string",
                  "description": "Status indicating the company was not found"
                },
                "message": {
                  "type": "string",
                  "description": "Message describing the not-found status"
                },
                "companies": {
                  "type": "array",
                  "description": "A list of companies for which data could not be found",
                  "items": {
                    "type": "object",
                    "properties": {
                      "identifier": {
                        "type": "string",
                        "description": "Identifier for the company (e.g. domain or LinkedIn URL)"
                      },
                      "type": {
                        "type": "string",
                        "description": "Type of identifier (e.g. 'linkedin_url', 'company_domain')"
                      }
                    },
                    "additionalProperties": false
                  }
                }
              },
              "additionalProperties": false
            }
          }
        ]
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

* Pricing model: `per_result` (per result).
* Estimated Deepline credits: `0.4` per pricing unit.

## Related documentation

* [CrustData V2 provider guide](https://deepline.com/docs/providers/crustdata-v2/guide.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.