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

# User Verification API Introduction

> Overview of the User Verification API endpoints

The User Verification API provides powerful endpoints for validating user information, including names and email addresses. This API helps you ensure data quality and prevent spam in your applications.

<Note>
  All API endpoints require authentication using an API key in the `X-API-Token` header.
</Note>

## Base URL

```bash theme={null}
https://api.vishodi.com/api/v1
```

## Authentication

All API endpoints require an API key for authentication. Include your API key in the request headers:

```json theme={null}
{
  "X-API-Token": "your-api-key"
}
```

<Card title="Get Your API Key" icon="key" href="https://dashboard.vishodi.com/api">
  Sign up and get your API key from the dashboard
</Card>

## Rate Limits

<CodeGroup>
  ```bash Free Plan theme={null}
  25 requests/month
  ```

  ```bash Basic Plan theme={null}
  30,000 requests/month
  ```

  ```bash Pro Plan theme={null}
  65,000 requests/month
  ```
</CodeGroup>

## Available Endpoints

### User Verification

<CardGroup cols={2}>
  <Card title="First Name Verification" icon="user" href="/user-verification/firstname">
    Validate and detect real/fake first names
  </Card>

  <Card title="Last Name Verification" icon="user" href="/user-verification/lastname">
    Validate and detect real/fake last names
  </Card>

  <Card title="Email Verification" icon="envelope" href="/user-verification/disposable_email">
    Detect disposable/temporary email addresses
  </Card>

  <Card title="Complete Verification" icon="shield" href="/user-verification/complete_verification">
    Validate complete user information
  </Card>
</CardGroup>

## Request Format

All requests should be made using POST method with JSON payload:

```json theme={null}
{
  "model": "user_verification",
  "email": "user@example.com",    // optional
  "firstname": "John",            // optional
  "lastname": "Doe"              // optional
}
```

## Response Format

Successful responses will have a 200 status code and return JSON:

```json theme={null}
{
  "status": "success",
  "received_data": {
    "model": "user_verification",
    "email": "user@example.com",
    "firstname": "John",
    "lastname": "Doe"
  },
  "request_count": 3,
  "email_verification": {
    "emailAddress": "user@example.com",
    "disposable": false,
    "username": "user",
    "domain": "example.com",
    "dnsCheck": "Pass",
    "syntexCheck": "Pass"
  },
  "name_verification": {
    "firstname": {
      "value": "John",
      "prediction": "LABEL_1",
      "confidence": 0.9993
    },
    "lastname": {
      "value": "Doe",
      "prediction": "LABEL_1",
      "confidence": 0.9998
    }
  }
}
```

<Card title="Explore the API Playground" icon="rocket" href="/user-verification-api/endpoint/create">
  Test the API endpoints interactively in our API playground
</Card>

## Error Handling

For detailed information about error responses and how to handle them, see our [Error Handling Guide](/user-verification/errors).

<CardGroup cols={2}>
  <Card title="Error Documentation" icon="triangle-exclamation" href="/user-verification/errors">
    Learn about error codes and troubleshooting
  </Card>

  <Card title="API Playground" icon="flask" href="/user-verification-api/endpoint/create">
    Test API responses in real-time
  </Card>
</CardGroup>