> ## 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.

# Datagma: Enrich Company

> Enrich company firmographics from Datagma data: company name, website, domain, or SIREN number. Includes inputs, outputs, SDK V2 examples, and Deepline cost.

Enrich company firmographics from Datagma data: company name, website, domain, or SIREN number.

> [!NOTE]
>
> Tool ID: `datagma_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(
  'datagma_enrich_company',
  {
    "data": "example",
    "companyName": "Example Corp",
    "domain": "example.com"
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute datagma_enrich_company --input '{
  "data": "example",
  "companyName": "Example Corp",
  "domain": "example.com"
}' --json
```

## Example response

The static output schema lacks the details for a reliable example. Use `deepline describe datagma_enrich_company --json` for the complete live contract.

## Input reference

Datagma company enrichment input matching the documented /api/ingress/v2/full query params, excluding apiId. Also accepts legacy companyName/domain aliases and maps them to data.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.data` | `string` | No | — | Datagma identifier for company enrichment: company name, website, domain, or SIREN number. Minimum length: 1. |
| `payload.companyName` | `string` | No | — | Legacy company-name alias for data. Used when data is not provided. Minimum length: 1. |
| `payload.domain` | `string` | No | — | Legacy company-domain alias for data. Used when data is not provided. Minimum length: 1. |
| `payload.website` | `string` | No | — | Legacy company-website alias for data. Used when data is not provided. Minimum length: 1. |
| `payload.companyDomain` | `string` | No | — | Legacy company-domain alias for data. Used when data is not provided. Minimum length: 1. |
| `payload.companyKeyword` | `string` | No | — | Optional Datagma disambiguation keyword, such as founder, location, or industry. Minimum length: 1. |
| `payload.countryCode` | `string` | No | — | Optional Datagma country code to narrow matching. Minimum length: 1. |
| `payload.firstName` | `string` | No | — | Minimum length: 1. |
| `payload.lastName` | `string` | No | — | Minimum length: 1. |
| `payload.fullName` | `string` | No | — | Minimum length: 1. |
| `payload.companyPremium` | `boolean` | No | — | — |
| `payload.companyFull` | `boolean` | No | — | — |
| `payload.companyFrench` | `boolean` | No | — | — |
| `payload.personFull` | `boolean` | No | — | — |
| `payload.phoneFull` | `boolean` | No | — | — |
| `payload.deepTraffic` | `boolean` | No | — | — |
| `payload.debug` | `boolean` | No | — | — |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Datagma company enrichment input matching the documented /api/ingress/v2/full query params, excluding apiId. Also accepts legacy companyName/domain aliases and maps them to data.",
    "properties": {
      "data": {
        "type": "string",
        "description": "Datagma identifier for company enrichment: company name, website, domain, or SIREN number.",
        "minLength": 1
      },
      "companyName": {
        "type": "string",
        "description": "Legacy company-name alias for data. Used when data is not provided.",
        "minLength": 1
      },
      "domain": {
        "type": "string",
        "description": "Legacy company-domain alias for data. Used when data is not provided.",
        "minLength": 1
      },
      "website": {
        "type": "string",
        "description": "Legacy company-website alias for data. Used when data is not provided.",
        "minLength": 1
      },
      "companyDomain": {
        "type": "string",
        "description": "Legacy company-domain alias for data. Used when data is not provided.",
        "minLength": 1
      },
      "companyKeyword": {
        "type": "string",
        "description": "Optional Datagma disambiguation keyword, such as founder, location, or industry.",
        "minLength": 1
      },
      "countryCode": {
        "type": "string",
        "description": "Optional Datagma country code to narrow matching.",
        "minLength": 1
      },
      "firstName": {
        "type": "string",
        "minLength": 1
      },
      "lastName": {
        "type": "string",
        "minLength": 1
      },
      "fullName": {
        "type": "string",
        "minLength": 1
      },
      "companyPremium": {
        "type": "boolean"
      },
      "companyFull": {
        "type": "boolean"
      },
      "companyFrench": {
        "type": "boolean"
      },
      "personFull": {
        "type": "boolean"
      },
      "phoneFull": {
        "type": "boolean"
      },
      "deepTraffic": {
        "type": "boolean"
      },
      "debug": {
        "type": "boolean"
      }
    },
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Native Datagma full-enrichment response. Deepline does not flatten this payload. Use the declared company\_name and domain getters for canonical values.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.company` | `object` | No | — | — |
| `result.company.basic` | `record` | No | — | — |
| `result.company.premium` | `record` | No | — | — |

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

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Native Datagma full-enrichment response. Deepline does not flatten this payload; use the declared company_name and domain getters for canonical values.",
    "properties": {
      "company": {
        "type": "object",
        "properties": {
          "basic": {
            "type": "object",
            "additionalProperties": true
          },
          "premium": {
            "type": "object",
            "additionalProperties": true
          }
        },
        "additionalProperties": true
      }
    },
    "additionalProperties": true
  }
  ```
</details>

## Deepline cost

* Pricing model: `provider_usage` (provider usage).
* Estimated Deepline credits: `0.27` per pricing unit.

## Related documentation

* [Datagma provider guide](https://deepline.com/docs/providers/datagma/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.