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

# NeverBounce API reference

> API reference for the NeverBounce plugin in Corsair: every `neverbounce.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).

## Single

### check

`single.check`

Verify one email address as it comes in, such as a form signup (valid, invalid, disposable, catchall or unknown); uses one verification credit. NeverBounce may lock the account if this is looped over an existing list; lists belong in its bulk jobs

**Risk:** `read`

```ts theme={null}
await corsair.neverbounce.api.single.check({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `email` | `string` | Yes | Email address to verify, including invalid addresses for syntax checking |
| `address_info` | `number` | No | Include address details (default 0) |
| `credits_info` | `number` | No | Include credit details (default 0) |
| `timeout` | `number` | No | Maximum verification time in seconds |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `status` | `success` | Yes | — |
| `result` | `string \| null` | No | — |
| `flags` | `string[] \| null` | No | — |
| `suggested_correction` | `string \| null` | No | — |
| `address_info` | `object \| null` | No | — |
| `credits_info` | `object \| null` | No | — |
| `execution_time` | `number \| null` | No | — |

> [accordion] address\_info full type
>
> ```ts theme={null}
> {
>   original_email?: string | null,
>   normalized_email?: string | null,
>   addr?: string | null,
>   alias?: string | null,
>   host?: string | null,
>   fqdn?: string | null,
>   domain?: string | null,
>   subdomain?: string | null,
>   tld?: string | null
> } | null
> ```

> [accordion] credits\_info full type
>
> ```ts theme={null}
> {
>   paid_credits_used?: number | null,
>   free_credits_used?: number | null,
>   paid_credits_remaining?: number | null,
>   free_credits_remaining?: number | null
> } | null
> ```

***


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