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

# Tomba API reference

> API reference for the Tomba plugin in Corsair: every `tomba.api.*` operation with its input and output types, taken from the plugin's Zod schemas.

> [!NOTE]
>
> **New to Corsair?** See [API access](https://docs.corsair.dev/concepts/api.md), [authentication](https://docs.corsair.dev/concepts/auth.md), and [error handling](https://docs.corsair.dev/concepts/error-handling).

## Account

### get

`account.get`

Read the account plan and the remaining search, verification and count credits for this usage window

**Risk:** `read`

```ts theme={null}
await corsair.tomba.api.account.get({});
```

**Input:** *empty object*

The /me body also carries the account `secret_token` and an `intercom_user_jwt`; the endpoint drops both before returning.

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   first_name?: string | null,
>   last_name?: string | null,
>   email?: string | null,
>   country?: string | null,
>   confirmed?: boolean | null,
>   blocked?: boolean | null,
>   deleted?: boolean | null,
>   created_at?: string | null,
>   expired?: string | null,
>   expired_subscription?: string | null,
>   requests?: {
>     domains?: {
>       available: number,
>       used: number
>     } | null,
>     verifications?: {
>       available: number,
>       used: number
>     } | null,
>     count?: {
>       available: number,
>       used: number
>     } | null
>   } | null,
>   credits?: Record<string, {
>     plan?: number | null,
>     used?: number | null,
>     packs?: number | null,
>     remaining?: number | null
>   }> | null
> }
> ```

***

### rateLimits

`account.rateLimits`

Read the per-route request limits on the current plan

**Risk:** `read`

```ts theme={null}
await corsair.tomba.api.account.rateLimits({});
```

**Input:** *empty object*

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object \| null` | No | Limits and usage keyed by route, such as email-finder |

> [accordion] data full type
>
> ```ts theme={null}
> Record<string, {
>   limits?: {
>     rps?: number | null,
>     rpm?: number | null,
>     daily?: number | null
>   } | null,
>   usage?: {
>     rpm_used?: number | null,
>     daily_used?: number | null
>   } | null
> }> | null
> ```

***

## Combined

### find

`combined.find`

Read the person and their company from one email address

**Risk:** `read`

```ts theme={null}
await corsair.tomba.api.combined.find({ email: 'jane.doe@stripe.com' });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `email` | `string` | Yes | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   person?: {
>     name?: {
>       fullName?: string | null,
>       givenName?: string | null,
>       familyName?: string | null
>     } | null,
>     email?: string | null,
>     location?: string | null,
>     gender?: string | null,
>     geo?: {
>       city?: string | null,
>       state?: string | null,
>       country?: string | null,
>       countryCode?: string | null
>     } | null,
>     bio?: string | null,
>     site?: string | null,
>     avatar?: string | null,
>     employment?: {
>       domain?: string | null,
>       name?: string | null,
>       title?: string | null,
>       role?: string | null,
>       subRole?: string | null,
>       seniority?: string | null
>     } | null,
>     facebook?: {
>       handle?: string | null
>     } | null,
>     github?: {
>       handle?: string | null
>     } | null,
>     twitter?: {
>       handle?: string | null
>     } | null,
>     linkedin?: {
>       handle?: string | null
>     } | null,
>     verification?: {
>       date?: string | null,
>       status?: string | null
>     } | null,
>     phone?: boolean | null
>   } | null,
>   company?: {
>     name?: string | null,
>     legalName?: string | null,
>     domain?: string | null,
>     domainAliases?: string[] | null,
>     site?: {
>       phoneNumbers?: string[] | null,
>       emailAddresses?: string[] | null
>     } | null,
>     category?: {
>       sector?: string | null,
>       industryGroup?: string | null,
>       industry?: string | null,
>       subIndustry?: string | null,
>       sicCode?: string | null,
>       naicsCode?: string | null
>     } | null,
>     tags?: string[] | null,
>     description?: string | null,
>     foundedYear?: number | string | null,
>     location?: string | null,
>     geo?: {
>       city?: string | null,
>       state?: string | null,
>       country?: string | null,
>       countryCode?: string | null
>     } | null,
>     logo?: string | null,
>     facebook?: {
>       handle?: string | null
>     } | null,
>     linkedin?: {
>       handle?: string | null
>     } | null,
>     twitter?: {
>       handle?: string | null
>     } | null,
>     type?: string | null,
>     metrics?: {
>       employees?: number | string | null,
>       annualRevenue?: number | string | null,
>       estimatedAnnualRevenue?: number | string | null
>     } | null,
>     tech?: string[] | null
>   } | null
> }
> ```

***

## Company

### find

`company.find`

Read a company profile from its domain

**Risk:** `read`

```ts theme={null}
await corsair.tomba.api.company.find({ domain: 'stripe.com' });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `domain` | `string` | Yes | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   name?: string | null,
>   legalName?: string | null,
>   domain?: string | null,
>   domainAliases?: string[] | null,
>   site?: {
>     phoneNumbers?: string[] | null,
>     emailAddresses?: string[] | null
>   } | null,
>   category?: {
>     sector?: string | null,
>     industryGroup?: string | null,
>     industry?: string | null,
>     subIndustry?: string | null,
>     sicCode?: string | null,
>     naicsCode?: string | null
>   } | null,
>   tags?: string[] | null,
>   description?: string | null,
>   foundedYear?: number | string | null,
>   location?: string | null,
>   geo?: {
>     city?: string | null,
>     state?: string | null,
>     country?: string | null,
>     countryCode?: string | null
>   } | null,
>   logo?: string | null,
>   facebook?: {
>     handle?: string | null
>   } | null,
>   linkedin?: {
>     handle?: string | null
>   } | null,
>   twitter?: {
>     handle?: string | null
>   } | null,
>   type?: string | null,
>   metrics?: {
>     employees?: number | string | null,
>     annualRevenue?: number | string | null,
>     estimatedAnnualRevenue?: number | string | null
>   } | null,
>   tech?: string[] | null
> }
> ```

***

### search

`company.search`

Search the company database with a plain-language query or structured filters, 50 per page

**Risk:** `read`

```ts theme={null}
await corsair.tomba.api.company.search({ query: 'Fintech companies in France' });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `query` | `string` | No | Plain-language query; filters are generated from it and any `filters` sent are ignored |
| `filters` | `object` | No | Structured filters, keyed by field such as industry or location\_city |
| `page` | `number` | No | 50 companies per page |

Sending `query` makes Tomba generate the filters and ignore any `filters` you send. The generated filters come back in `meta.filters` for the next page.

> [accordion] filters full type
>
> ```ts theme={null}
> Record<string, {
>   include?: string[] | null,
>   exclude?: string[] | null
> } | string | string[]>
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean \| null` | No | — |
| `data` | `object` | Yes | — |
| `meta` | `object \| null` | No | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   companies: {
>     name?: string | null,
>     description?: string | null,
>     website_url?: string | null,
>     industry?: string | null,
>     company_size?: string | null,
>     type?: string | null,
>     founded?: number | string | null,
>     country?: string | null,
>     state?: string | null,
>     city?: string | null,
>     street_address?: string | null,
>     postal_code?: string | null,
>     revenue?: number | string | null,
>     total_emails?: number | null,
>     total_similar?: number | null,
>     phone_number?: boolean | null,
>     linkedin_url?: string | null,
>     facebook_url?: string | null,
>     twitter_url?: string | null
>   }[]
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   total?: number | null,
>   page?: number | null,
>   limit?: number | null,
>   pages?: number | null,
>   filters?: Record<string, any> | null
> } | null
> ```

***

## Domain

### emailCount

`domain.emailCount`

How many addresses Tomba holds for a domain, by department and seniority

**Risk:** `read`

```ts theme={null}
await corsair.tomba.api.domain.emailCount({ domain: 'stripe.com', type: 'personal' });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `domain` | `string` | Yes | — |
| `type` | `all \| personal \| generic` | No | Count only one address type; default all |

Costs an email count credit on every call. `type` narrows the count to personal or generic addresses.

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   website_id?: number | null,
>   total?: number | null,
>   personal_emails?: number | null,
>   generic_emails?: number | null,
>   department?: Record<string, number> | null,
>   seniority?: Record<string, number> | null
> }
> ```

***

### emailFormat

`domain.emailFormat`

Read the address patterns a company uses and their share

**Risk:** `read`

```ts theme={null}
await corsair.tomba.api.domain.emailFormat({ domain: 'stripe.com' });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `domain` | `string` | Yes | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object[]` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   format?: string | null,
>   percentage?: number | null
> }[]
> ```

***

### emailSources

`domain.emailSources`

List the public pages where Tomba found an email address, with first and last seen dates

**Risk:** `read`

```ts theme={null}
await corsair.tomba.api.domain.emailSources({ email: 'jane.doe@stripe.com' });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `email` | `string` | Yes | The address whose sources to list |

Takes one email address and lists up to 20 pages it was found on; an empty list arrives with HTTP 201. A 429 here can mean the sources balance is used up.

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object[]` | Yes | Up to 20 pages; empty, with HTTP 201, when there are none |
| `email` | `string \| null` | No | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   uri?: string | null,
>   website_url?: string | null,
>   extracted_on?: string | null,
>   last_seen_on?: string | null,
>   still_on_page?: boolean | null
> }[]
> ```

***

### location

`domain.location`

Where a company's people are, by country

**Risk:** `read`

```ts theme={null}
await corsair.tomba.api.domain.location({ domain: 'stripe.com' });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `domain` | `string` | Yes | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object[]` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   name?: string | null,
>   total?: number | null
> }[]
> ```

***

### similar

`domain.similar`

Find companies similar to a domain, with their industry

**Risk:** `read`

```ts theme={null}
await corsair.tomba.api.domain.similar({ domain: 'stripe.com' });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `domain` | `string` | Yes | — |
| `page` | `number` | No | Default 1 |
| `limit` | `10 \| 20 \| 50 \| 100 \| 150 \| 200 \| 250` | No | Companies per page, default 10; 1 search credit per 10 |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object[]` | Yes | — |
| `meta` | `object \| null` | No | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   website_url?: string | null,
>   name?: string | null,
>   industries?: string | null
> }[]
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   total?: number | null,
>   pageSize?: number | null,
>   current?: number | null,
>   total_pages?: number | null
> } | null
> ```

***

### status

`domain.status`

Read Tomba's reachability verdict for a domain

**Risk:** `read`

```ts theme={null}
await corsair.tomba.api.domain.status({ domain: 'stripe.com' });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `domain` | `string` | Yes | — |

The only route whose answer is not wrapped in `data`: `{ domain, webmail, disposable }`.

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `domain` | `string \| null` | No | — |
| `webmail` | `boolean \| null` | No | — |
| `disposable` | `boolean \| null` | No | — |

***

### suggestions

`domain.suggestions`

Suggest alternative domains related to a company

**Risk:** `read`

```ts theme={null}
await corsair.tomba.api.domain.suggestions({ query: 'stripe' });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `query` | `string` | Yes | Company name or domain to match, such as stripe |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object[]` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   name?: string | null,
>   domain?: string | null,
>   email_count?: number | null
> }[]
> ```

***

### technology

`domain.technology`

Read the technologies a website runs, by category

**Risk:** `read`

```ts theme={null}
await corsair.tomba.api.domain.technology({ domain: 'stripe.com' });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `domain` | `string` | Yes | — |

Not charged, but it needs a positive search balance.

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `domain` | `string \| null` | No | — |
| `data` | `object[] \| null` | No | null when Tomba has no technology data for the domain |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   slug?: string | null,
>   name?: string | null,
>   icon?: string | null,
>   website?: string | null,
>   description?: string | null,
>   categories?: {
>     id?: number | string | null,
>     slug?: string | null,
>     name?: string | null
>   }[] | null
> }[] | null
> ```

***

## Finder

### author

`finder.author`

Find the email of the person who wrote an article

**Risk:** `read`

```ts theme={null}
await corsair.tomba.api.finder.author({ url: 'https://stripe.com/blog/engineering' });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `url` | `string` | Yes | URL of the article |
| `webhook_url` | `string` | No | Also POST the result to this URL when the lookup finishes |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   email?: string | null,
>   first_name?: string | null,
>   last_name?: string | null,
>   full_name?: string | null,
>   company?: string | null,
>   position?: string | null,
>   department?: string | null,
>   country?: string | null,
>   gender?: string | null,
>   linkedin?: string | null,
>   twitter?: string | null,
>   website_url?: string | null,
>   pattern?: string | null,
>   score?: number | null,
>   accept_all?: boolean | null,
>   phone_number?: boolean | null,
>   type?: string | null,
>   verification?: {
>     date?: string | null,
>     status?: string | null
>   } | null,
>   sources?: {
>     uri?: string | null,
>     website_url?: string | null,
>     extracted_on?: string | null,
>     last_seen_on?: string | null,
>     still_on_page?: boolean | null
>   }[] | null,
>   phone_data?: {
>     carrier?: string | null,
>     country_code?: string | null,
>     e164_format?: string | null,
>     intl_format?: string | null,
>     local_format?: string | null,
>     line_type?: string | null
>   }[] | null
> }
> ```

***

### domainSearch

`finder.domainSearch`

List a company's known email addresses with each person's role, department and verification status

**Risk:** `read`

```ts theme={null}
await corsair.tomba.api.finder.domainSearch({ domain: 'stripe.com', limit: 50, department: 'engineering' });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `domain` | `string` | Yes | Company domain, such as stripe.com |
| `page` | `number` | No | Default 1 |
| `limit` | `number` | No | Addresses per page; the credit cost follows this value |
| `department` | `string` | No | Only this department, such as engineering |
| `country` | `string` | No | Two-letter country code |
| `enrich_mobile` | `boolean` | No | Also return phone numbers; costs extra search credits |
| `webhook_url` | `string` | No | Also POST the result to this URL when the lookup finishes |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | Yes | — |
| `meta` | `object \| null` | No | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   organization?: {
>     website_url?: string | null,
>     organization?: string | null,
>     location?: {
>       country?: string | null,
>       city?: string | null,
>       state?: string | null,
>       street_address?: string | null,
>       postal_code?: string | null
>     } | null,
>     social_links?: Record<string, string | null> | null,
>     disposable?: boolean | null,
>     webmail?: boolean | null,
>     phone_number?: boolean | null,
>     industries?: string | null,
>     founded?: number | string | null,
>     company_size?: string | null,
>     company_type?: string | null,
>     revenue?: number | string | null,
>     accept_all?: boolean | null,
>     description?: string | null,
>     pattern?: string | null,
>     total_similar?: number | null,
>     keywords?: string[] | null,
>     last_updated?: string | null
>   } | null,
>   emails: {
>     email?: string | null,
>     first_name?: string | null,
>     last_name?: string | null,
>     full_name?: string | null,
>     company?: string | null,
>     position?: string | null,
>     department?: string | null,
>     country?: string | null,
>     gender?: string | null,
>     linkedin?: string | null,
>     twitter?: string | null,
>     website_url?: string | null,
>     pattern?: string | null,
>     score?: number | null,
>     accept_all?: boolean | null,
>     phone_number?: boolean | null,
>     type?: string | null,
>     verification?: {
>       date?: string | null,
>       status?: string | null
>     } | null,
>     sources?: {
>       uri?: string | null,
>       website_url?: string | null,
>       extracted_on?: string | null,
>       last_seen_on?: string | null,
>       still_on_page?: boolean | null
>     }[] | null,
>     phone_data?: {
>       carrier?: string | null,
>       country_code?: string | null,
>       e164_format?: string | null,
>       intl_format?: string | null,
>       local_format?: string | null,
>       line_type?: string | null
>     }[] | null
>   }[]
> }
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   total?: number | null,
>   pageSize?: number | null,
>   current?: number | null,
>   total_pages?: number | null
> } | null
> ```

***

### email

`finder.email`

Find one person's work email from their name and the company domain or name

**Risk:** `read`

```ts theme={null}
await corsair.tomba.api.finder.email({ domain: 'stripe.com', first_name: 'Jane', last_name: 'Doe' });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `domain` | `string` | No | Company domain, or use `company` |
| `company` | `string` | No | Company name, when the domain is unknown |
| `first_name` | `string` | No | — |
| `last_name` | `string` | No | — |
| `full_name` | `string` | No | Used when first and last are absent |
| `enrich_mobile` | `boolean` | No | Also return phone numbers; costs extra search credits |
| `webhook_url` | `string` | No | Also POST the result to this URL when the lookup finishes |

Pass a `domain` or a `company`, and either `full_name` or `first_name`. A miss answers 200 with a null email, not an error.

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   email?: string | null,
>   first_name?: string | null,
>   last_name?: string | null,
>   full_name?: string | null,
>   company?: string | null,
>   position?: string | null,
>   department?: string | null,
>   country?: string | null,
>   gender?: string | null,
>   linkedin?: string | null,
>   twitter?: string | null,
>   website_url?: string | null,
>   pattern?: string | null,
>   score?: number | null,
>   accept_all?: boolean | null,
>   phone_number?: boolean | null,
>   type?: string | null,
>   verification?: {
>     date?: string | null,
>     status?: string | null
>   } | null,
>   sources?: {
>     uri?: string | null,
>     website_url?: string | null,
>     extracted_on?: string | null,
>     last_seen_on?: string | null,
>     still_on_page?: boolean | null
>   }[] | null,
>   phone_data?: {
>     carrier?: string | null,
>     country_code?: string | null,
>     e164_format?: string | null,
>     intl_format?: string | null,
>     local_format?: string | null,
>     line_type?: string | null
>   }[] | null
> }
> ```

***

### enrich

`finder.enrich`

Turn an email address into a profile: name, role, company and social links

**Risk:** `read`

```ts theme={null}
await corsair.tomba.api.finder.enrich({ email: 'jane.doe@stripe.com' });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `email` | `string` | Yes | — |
| `enrich_mobile` | `boolean` | No | Also return phone numbers; costs extra search credits |
| `webhook_url` | `string` | No | Also POST the result to this URL when the lookup finishes |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   email?: string | null,
>   first_name?: string | null,
>   last_name?: string | null,
>   full_name?: string | null,
>   company?: string | null,
>   position?: string | null,
>   department?: string | null,
>   country?: string | null,
>   gender?: string | null,
>   linkedin?: string | null,
>   twitter?: string | null,
>   website_url?: string | null,
>   pattern?: string | null,
>   score?: number | null,
>   accept_all?: boolean | null,
>   phone_number?: boolean | null,
>   type?: string | null,
>   verification?: {
>     date?: string | null,
>     status?: string | null
>   } | null,
>   sources?: {
>     uri?: string | null,
>     website_url?: string | null,
>     extracted_on?: string | null,
>     last_seen_on?: string | null,
>     still_on_page?: boolean | null
>   }[] | null,
>   phone_data?: {
>     carrier?: string | null,
>     country_code?: string | null,
>     e164_format?: string | null,
>     intl_format?: string | null,
>     local_format?: string | null,
>     line_type?: string | null
>   }[] | null
> }
> ```

***

### linkedin

`finder.linkedin`

Find the work email behind a LinkedIn profile URL

**Risk:** `read`

```ts theme={null}
await corsair.tomba.api.finder.linkedin({ url: 'https://www.linkedin.com/in/jane-doe' });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `url` | `string` | Yes | The LinkedIn profile URL |
| `enrich_mobile` | `boolean` | No | Also return phone numbers; costs extra search credits |
| `full` | `boolean` | No | Return the full record instead of the minimal one |
| `webhook_url` | `string` | No | Also POST the result to this URL when the lookup finishes |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object \| object[]` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   email?: string | null,
>   first_name?: string | null,
>   last_name?: string | null,
>   full_name?: string | null,
>   company?: string | null,
>   position?: string | null,
>   department?: string | null,
>   country?: string | null,
>   gender?: string | null,
>   linkedin?: string | null,
>   twitter?: string | null,
>   website_url?: string | null,
>   pattern?: string | null,
>   score?: number | null,
>   accept_all?: boolean | null,
>   phone_number?: boolean | null,
>   type?: string | null,
>   verification?: {
>     date?: string | null,
>     status?: string | null
>   } | null,
>   sources?: {
>     uri?: string | null,
>     website_url?: string | null,
>     extracted_on?: string | null,
>     last_seen_on?: string | null,
>     still_on_page?: boolean | null
>   }[] | null,
>   phone_data?: {
>     carrier?: string | null,
>     country_code?: string | null,
>     e164_format?: string | null,
>     intl_format?: string | null,
>     local_format?: string | null,
>     line_type?: string | null
>   }[] | null
> } | {
>   email?: string | null,
>   first_name?: string | null,
>   last_name?: string | null,
>   full_name?: string | null,
>   company?: string | null,
>   position?: string | null,
>   department?: string | null,
>   country?: string | null,
>   gender?: string | null,
>   linkedin?: string | null,
>   twitter?: string | null,
>   website_url?: string | null,
>   pattern?: string | null,
>   score?: number | null,
>   accept_all?: boolean | null,
>   phone_number?: boolean | null,
>   type?: string | null,
>   verification?: {
>     date?: string | null,
>     status?: string | null
>   } | null,
>   sources?: {
>     uri?: string | null,
>     website_url?: string | null,
>     extracted_on?: string | null,
>     last_seen_on?: string | null,
>     still_on_page?: boolean | null
>   }[] | null,
>   phone_data?: {
>     carrier?: string | null,
>     country_code?: string | null,
>     e164_format?: string | null,
>     intl_format?: string | null,
>     local_format?: string | null,
>     line_type?: string | null
>   }[] | null
> }[]
> ```

***

### phone

`finder.phone`

Find phone numbers from an email address, a domain or a LinkedIn URL

**Risk:** `read`

```ts theme={null}
await corsair.tomba.api.finder.phone({ email: 'jane.doe@stripe.com' });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `email` | `string` | No | — |
| `domain` | `string` | No | — |
| `linkedin` | `string` | No | — |
| `full` | `boolean` | No | — |
| `webhook_url` | `string` | No | Also POST the result to this URL when the lookup finishes |

Costs more credits than the other lookups. Pass one of `email`, `domain` or `linkedin`.

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object \| object[]` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   email?: string | null,
>   domain?: string | null,
>   valid?: boolean | null,
>   local_format?: string | null,
>   intl_format?: string | null,
>   e164_format?: string | null,
>   rfc3966_format?: string | null,
>   country_code?: string | null,
>   line_type?: string | null,
>   carrier?: string | null,
>   region?: {
>     name?: string | null,
>     code?: string | null
>   } | null,
>   timezones?: string[] | null
> } | {
>   email?: string | null,
>   domain?: string | null,
>   valid?: boolean | null,
>   local_format?: string | null,
>   intl_format?: string | null,
>   e164_format?: string | null,
>   rfc3966_format?: string | null,
>   country_code?: string | null,
>   line_type?: string | null,
>   carrier?: string | null,
>   region?: {
>     name?: string | null,
>     code?: string | null
>   } | null,
>   timezones?: string[] | null
> }[]
> ```

***

## Person

### find

`person.find`

Read a person profile from their work email

**Risk:** `read`

```ts theme={null}
await corsair.tomba.api.person.find({ email: 'jane.doe@stripe.com' });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `email` | `string` | Yes | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   name?: {
>     fullName?: string | null,
>     givenName?: string | null,
>     familyName?: string | null
>   } | null,
>   email?: string | null,
>   location?: string | null,
>   gender?: string | null,
>   geo?: {
>     city?: string | null,
>     state?: string | null,
>     country?: string | null,
>     countryCode?: string | null
>   } | null,
>   bio?: string | null,
>   site?: string | null,
>   avatar?: string | null,
>   employment?: {
>     domain?: string | null,
>     name?: string | null,
>     title?: string | null,
>     role?: string | null,
>     subRole?: string | null,
>     seniority?: string | null
>   } | null,
>   facebook?: {
>     handle?: string | null
>   } | null,
>   github?: {
>     handle?: string | null
>   } | null,
>   twitter?: {
>     handle?: string | null
>   } | null,
>   linkedin?: {
>     handle?: string | null
>   } | null,
>   verification?: {
>     date?: string | null,
>     status?: string | null
>   } | null,
>   phone?: boolean | null
> }
> ```

***

## Verifier

### email

`verifier.email`

Check whether an address can receive mail, with format, MX, SMTP and catch-all results

**Risk:** `read`

```ts theme={null}
await corsair.tomba.api.verifier.email({ email: 'jane.doe@stripe.com' });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `email` | `string` | Yes | — |
| `enrich_mobile` | `boolean` | No | Also return phone numbers; costs extra search credits |
| `webhook_url` | `string` | No | Also POST the result to this URL when the lookup finishes |

The verdict is in `data.email.status` and `data.email.result`; the other fields report the individual checks.

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   email: {
>     email?: string | null,
>     status?: string | null,
>     result?: string | null,
>     score?: number | null,
>     regex?: boolean | null,
>     gibberish?: boolean | null,
>     disposable?: boolean | null,
>     accept_all?: boolean | null,
>     block?: boolean | null,
>     greylisted?: boolean | null,
>     mx_check?: boolean | null,
>     smtp_check?: boolean | null,
>     smtp_server?: boolean | null,
>     smtp_provider?: string | null,
>     mx?: {
>       records?: string[] | null
>     } | null,
>     phone_number?: boolean | null
>   }
> }
> ```

***

### phone

`verifier.phone`

Check a phone number and report its line type and carrier

**Risk:** `read`

```ts theme={null}
await corsair.tomba.api.verifier.phone({ phone: '+14155550132' });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `phone` | `string` | Yes | Number to validate, ideally in E.164 form |
| `country_code` | `string` | No | Two-letter code, used when the number has no country prefix |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object \| object[]` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   email?: string | null,
>   domain?: string | null,
>   valid?: boolean | null,
>   local_format?: string | null,
>   intl_format?: string | null,
>   e164_format?: string | null,
>   rfc3966_format?: string | null,
>   country_code?: string | null,
>   line_type?: string | null,
>   carrier?: string | null,
>   region?: {
>     name?: string | null,
>     code?: string | null
>   } | null,
>   timezones?: string[] | null
> } | {
>   email?: string | null,
>   domain?: string | null,
>   valid?: boolean | null,
>   local_format?: string | null,
>   intl_format?: string | null,
>   e164_format?: string | null,
>   rfc3966_format?: string | null,
>   country_code?: string | null,
>   line_type?: string | null,
>   carrier?: string | null,
>   region?: {
>     name?: string | null,
>     code?: string | null
>   } | null,
>   timezones?: string[] | null
> }[]
> ```

***


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