> ## 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: Full Enrichment

> Enrich a person and their company from an email, LinkedIn profile or name plus company, or a company from its name or website.

Enrich a person and their company from an email, LinkedIn profile or name plus company, or a company from its name or website.

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

## 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_full_enrichment',
  {
    "data": "example",
    "companyKeyword": "software companies hiring engineers",
    "countryCode": "example"
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute datagma_full_enrichment --input '{
  "data": "example",
  "companyKeyword": "software companies hiring engineers",
  "countryCode": "example"
}' --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": {
    "phone": {
      "workPhones": [
        {
          "value": "example"
        }
      ],
      "mobiles": [
        {
          "value": "example"
        }
      ]
    },
    "email": {
      "status": "example",
      "email": "jane.doe@example.com"
    },
    "person": {
      "basic": {
        "name": "Example",
        "firstName": "Jane",
        "lastName": "Doe"
      },
      "data": {
        "name": "Example",
        "position": "example",
        "currentCompany": {
          "name": "Example",
          "link": "example"
        }
      }
    }
  }
}
```

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

## Input reference

You can enrich an email address, a LinkedIn profile, or a full name with a company name to get info about the person and his company, Or you can send a company name, website, or SIREN number to get only company info.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.data` | `string` | No | — | You can submit a professional email address or a LinkedIn profile URL to get info about a person and his company. A successful person response costs two credits. You can also submit a company name, a website, or a Siren if you only want information about the company with this parameter. Note: If you don't have an email address or Linkedin Profile, and if you still want information about the person, you can use the couple Full Name + Company Name, see below) |
| `payload.companyKeyword` | `string` | No | — | When you are looking for company informations using the data parameter. If you think several companies with the same name exist, you can submit us a keyword (like a part of the address, the name of the founder, or the industry), and our AI will pick the most probable company. |
| `payload.countryCode` | `string` | No | — | Allow you to have accurate results. Indicate to Datagma crawler exactly where to search to reduce the risk of giving a namesake. |
| `payload.firstName` | `string` | No | — | Replace the data parameter if you don't use it. (Must be used with lastName and company). |
| `payload.lastName` | `string` | No | — | Replace the data parameter if you don't use it. (Must be used with firstName and company). |
| `payload.fullName` | `string` | No | — | Instead of input firstname, lastname. You can input full name here |
| `payload.companyPremium` | `boolean` | No | `false` | To get the LinkedIn information about the enriched person's company. |
| `payload.companyFull` | `boolean` | No | `false` | To get financial information about the company of the enriched person. |
| `payload.companyFrench` | `boolean` | No | `false` | To get the information of the SIREN directory if the company is French. |
| `payload.personFull` | `boolean` | No | — | To get the full profile of the person(education, past experiences...). |
| `payload.phoneFull` | `boolean` | No | — | Cell phone number. Please use this endpoint to find phones only if you do not have your prospect's social profile or email. If you have them, please use the Search endpoint instead. |
| `payload.deepTraffic` | `boolean` | No | — | Give you information about the website's traffic, (Traffic by country, similar websites, traffic by sources... ) |
| `payload.debug` | `boolean` | No | — | By defaut Datagma filters what we consider junk results, thanks to the debug mode, you can access to this junk result |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "You can enrich an email address, a LinkedIn profile, or a full name with a company name to get info about the person and his company, Or you can send a company name, website, or SIREN number to get only company info.",
    "properties": {
      "data": {
        "type": "string",
        "description": "You can submit a professional email address or a LinkedIn profile URL to get info about a person and his company. A successful person response costs two credits. You can also submit a company name, a website, or a Siren if you only want information about the company with this parameter. Note: If you don't have an email address or Linkedin Profile, and if you still want information about the person, you can use the couple Full Name + Company Name, see below)"
      },
      "companyKeyword": {
        "type": "string",
        "description": "When you are looking for company informations using the data parameter. If you think several companies with the same name exist, you can submit us a keyword (like a part of the address, the name of the founder, or the industry), and our AI will pick the most probable company."
      },
      "countryCode": {
        "type": "string",
        "description": "Allow you to have accurate results. Indicate to Datagma crawler exactly where to search to reduce the risk of giving a namesake."
      },
      "firstName": {
        "type": "string",
        "description": "Replace the data parameter if you don't use it. (Must be used with lastName and company)."
      },
      "lastName": {
        "type": "string",
        "description": "Replace the data parameter if you don't use it. (Must be used with firstName and company)."
      },
      "fullName": {
        "type": "string",
        "description": "Instead of input firstname, lastname. You can input full name here"
      },
      "companyPremium": {
        "type": "boolean",
        "description": "To get the LinkedIn information about the enriched person's company.",
        "default": false
      },
      "companyFull": {
        "type": "boolean",
        "description": "To get financial information about the company of the enriched person.",
        "default": false
      },
      "companyFrench": {
        "type": "boolean",
        "description": "To get the information of the SIREN directory if the company is French.",
        "default": false
      },
      "personFull": {
        "type": "boolean",
        "description": "To get the full profile of the person(education, past experiences...)."
      },
      "phoneFull": {
        "type": "boolean",
        "description": "Cell phone number. Please use this endpoint to find phones only if you do not have your prospect's social profile or email. If you have them, please use the Search endpoint instead."
      },
      "deepTraffic": {
        "type": "boolean",
        "description": "Give you information about the website's traffic, (Traffic by country, similar websites, traffic by sources... )"
      },
      "debug": {
        "type": "boolean",
        "description": "By defaut Datagma filters what we consider junk results, thanks to the debug mode, you can access to this junk result"
      }
    },
    "required": [],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.phone` | `object` | No | — | — |
| `result.data.phone.workPhones` | `array` | No | — | — |
| `result.data.phone.workPhones[].value` | `string` | No | — | — |
| `result.data.phone.mobiles` | `array` | No | — | — |
| `result.data.phone.mobiles[].value` | `string` | No | — | — |
| `result.data.email` | `object` | No | — | — |
| `result.data.email.status` | `string` | No | — | — |
| `result.data.email.email` | `string` | No | — | — |
| `result.data.person` | `object` | No | — | — |
| `result.data.person.basic` | `object` | No | — | — |
| `result.data.person.basic.name` | `string` | No | — | — |
| `result.data.person.basic.firstName` | `string` | No | — | — |
| `result.data.person.basic.lastName` | `string` | No | — | — |
| `result.data.person.basic.location` | `string` | No | — | — |
| `result.data.person.basic.jobTitle` | `string` | No | — | — |
| `result.data.person.basic.company` | `string` | No | — | — |
| `result.data.person.basic.linkedInUrl` | `string` | No | — | — |
| `result.data.person.basic.extractedRole` | `string` | No | — | — |
| `result.data.person.basic.extractedSeniority` | `string` | No | — | — |
| `result.data.person.basic.extractedGender` | `string` | No | — | — |
| `result.data.person.basic.dateDeNaissanceFormate` | `string` | No | — | — |
| `result.data.person.basic.age` | `string` | No | — | — |
| `result.data.person.basic.personConfidenceScore` | `number` | No | — | Format: `float`. |
| `result.data.person.basic.employeeJobScore` | `number` | No | — | Format: `float`. |
| `result.data.person.basic.employeeCompanyScore` | `number` | No | — | Format: `float`. |
| `result.data.person.data` | `object` | No | — | — |
| `result.data.person.data.name` | `string` | No | — | — |
| `result.data.person.data.position` | `string` | No | — | — |
| `result.data.person.data.currentCompany` | `object` | No | — | — |
| `result.data.person.data.currentCompany.name` | `string` | No | — | — |
| `result.data.person.data.currentCompany.link` | `string` | No | — | — |
| `result.data.person.data.avatar` | `string` | No | — | — |
| `result.data.person.data.about` | `string` | No | — | — |
| `result.data.person.data.city` | `string` | No | — | — |
| `result.data.person.data.educationsDetails` | `string` | No | — | — |
| `result.data.person.data.posts` | `array` | No | — | — |
| `result.data.person.data.posts[].image` | `string` | No | — | — |
| `result.data.person.data.posts[].title` | `string` | No | — | — |
| `result.data.person.data.posts[].attribuion` | `string` | No | — | — |
| `result.data.person.data.experience` | `array` | No | — | — |
| `result.data.person.data.experience[].company` | `string` | No | — | — |
| `result.data.person.data.experience[].duration` | `string` | No | — | — |
| `result.data.person.data.experience[].positions` | `array` | No | — | — |
| `result.data.person.data.experience[].positions[].title` | `string` | No | — | — |
| `result.data.person.data.experience[].positions[].meta` | `string` | No | — | — |
| `result.data.person.data.experience[].title` | `string` | No | — | — |
| `result.data.person.data.experience[].subtitle` | `string` | No | — | — |
| `result.data.person.data.experience[].location` | `string` | No | — | — |
| `result.data.person.data.experience[].description` | `string` | No | — | — |

The table shows the first 50 fields. Use the live contract below for every field.

> [!NOTE]
>
> This output schema is too large for an inline display. Read the complete live contract with `deepline describe datagma_full_enrichment --json`.

## Deepline cost

* Pricing model: `provider_usage` (provider usage).
* Estimated Deepline credits: `0.14` 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.