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

# Email

> Email object structure used in the Email Intelligence endpoints

# Email Type

The Email object is the request body for the [Submit Email](/api-reference/email-intelligence/post) and [Submit Email Batch](/api-reference/email-intelligence/post-batch) endpoints. It contains the email address to analyze, an optional flag to enable identity intelligence, and optional identity claims.

## Structure

| Field                   | Type    | Required | Description                                                                                                                                                    |
| ----------------------- | ------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `email`                 | string  | Yes      | The email address to analyze                                                                                                                                   |
| `identity_intelligence` | boolean | No       | When `true`, enables deeper identity analysis including online presence detection, connected identity discovery, and claims verification. Defaults to `false`. |
| `claims`                | object  | No       | Identity claims to verify against data linked to the email. Only meaningful when `identity_intelligence` is `true`.                                            |

## Claims

Claims represent information your customer has provided that you want to verify against independent data sources. When `identity_intelligence` is enabled, Verisoul matches these claims against identity data linked to the email and reports whether each claim matches, partially matches, or does not match.

| Field        | Type   | Description                                                                                       |
| ------------ | ------ | ------------------------------------------------------------------------------------------------- |
| `name`       | object | The expected name of the email owner. You can provide `first`, `last`, or both.                   |
| `name.first` | string | First name (e.g., `"John"`)                                                                       |
| `name.last`  | string | Last name (e.g., `"Doe"`)                                                                         |
| `phone`      | string | Phone number in a valid format. E.164 is recommended.                                             |
| `country`    | string | Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). |

### Name

You can provide a first name, a last name, or both. Verisoul compares the provided name(s) against names associated with the email across data sources.

```json theme={null}
{ "name": { "first": "John", "last": "Doe" } }
```

```json theme={null}
{ "name": { "first": "John" } }
```

```json theme={null}
{ "name": { "last": "Doe" } }
```

### Phone

Provide the phone number in a standard format. [E.164](https://en.wikipedia.org/wiki/E.164) (international with `+` prefix) is recommended, but national formats are also accepted.

**Examples:**

| Format                  | Example            |
| ----------------------- | ------------------ |
| E.164 (recommended)     | `"+14155551234"`   |
| E.164 with country code | `"+442071234567"`  |
| National (US)           | `"(415) 555-1234"` |
| National (UK)           | `"020 7123 4567"`  |

### Country

Provide the expected country as a two-letter [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code.

**Examples:**

| Code   | Country        |
| ------ | -------------- |
| `"US"` | United States  |
| `"GB"` | United Kingdom |
| `"CA"` | Canada         |
| `"DE"` | Germany        |
| `"JP"` | Japan          |
| `"BR"` | Brazil         |

## Usage

### In Submit Email

Claims and `identity_intelligence` are provided at the top level alongside the email:

```json theme={null}
{
  "email": "john.doe@example.com",
  "identity_intelligence": true,
  "claims": {
    "name": { "first": "John", "last": "Doe" },
    "phone": "+14155551234",
    "country": "US"
  }
}
```

### In Submit Email Batch

`identity_intelligence` is set at the top level and applies to all emails. Claims are provided **per email**, allowing you to verify different identities in a single batch:

```json theme={null}
{
  "emails": [
    {
      "email": "john.doe@example.com",
      "claims": {
        "name": { "first": "John", "last": "Doe" },
        "country": "US"
      }
    },
    {
      "email": "jane@company.com",
      "claims": {
        "name": { "first": "Jane" },
        "phone": "+442071234567"
      }
    }
  ],
  "identity_intelligence": true
}
```