# Email Lookup Service

### Features of Email Lookup:

1. **Email Verification**: Checks validity and existence of email addresses.
2. **Domain Insights**: Provides domain details, including MX records and SMTP providers.
3. **Deliverability Score**: Rates the likelihood of email delivery success.
4. **Mailbox Status**: Identifies full mailboxes and accept-all accounts.
5. **WHOIS Data**: Offers registrar and domain registration details.
6. **Typo Detection**: Suggests corrections for potential email typos.
7. **Performance Metrics**: Measures lookup speed and efficiency.
8. **Structured JSON Response**: Ensures easy data integration and parsing.

## insights into deliverability, domain information, and additional email characteristics to enhance communication strategies and data validation processes.

<mark style="color:green;">`POST`</mark> `https://api.localmail.io/v1/lookup/email`

#### Request Body

| Name                                    | Type   | Description                                                                                                                         |
| --------------------------------------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------- |
| email<mark style="color:red;">\*</mark> | String | <p>Format: Must adhere to standard email address formatting, typically local-part\@domain. </p><p>Example: "<user@example.com>"</p> |

{% tabs %}
{% tab title="200: OK " %}

```
{
  "accept_all": "None",
  "did_you_mean": "False",
  "disposable": "False",
  "domain": "exampledomain.io",
  "duration": "2.36",
  "email": "example@exampledomain.io",
  "free": "False",
  "mailbox_full": "None",
  "mx_record": "example.mx.record.com",
  "no_reply": "False",
  "reason": "",
  "role": "False",
  "score": "73",
  "smtp_provider": "exampleprovider.com",
  "state": "Deliverable",
  "user": "example",
  "who_is": {
    "registrar": "Example Registrar",
    "updated_date": "YYYY-MM-DD HH:MM:SS",
    "creation_date": "YYYY-MM-DD HH:MM:SS",
    "expiration_date": "YYYY-MM-DD HH:MM:SS",
    "name_servers": [
      "ns1.example.com",
      "ns2.example.com"
    ],
    "dnssec": ""
  }
}
```

{% endtab %}
{% endtabs %}

### Response Format

The API returns a JSON object with the following fields:

* `accept_all`: Indicates if the domain accepts all emails.
* `did_you_mean`: Suggestion for typos in the email.
* `disposable`: Whether the email is from a disposable service.
* `domain`: Domain of the email.
* `duration`: Time taken for the lookup.
* `email`: Queried email address.
* `free`: If the email belongs to a free email provider.
* `mailbox_full`: Indicates if the mailbox is full.
* `mx_record`: The MX record of the domain.
* `no_reply`: Indicates if it is a no-reply email.
* `reason`: Additional details (if any).
* `role`: If the email is associated with a role account.
* `score`: Deliverability score of the email.
* `smtp_provider`: SMTP provider information.
* `state`: Email status (e.g., Deliverable).
* `user`: Local part of the email.
* `who_is`: WHOIS information for the domain, including registrar, update/creation/expiration dates, name servers, and DNSSEC info.

### Error Responses

* **400 Bad Request**: Invalid phone number format or missing data in the request.
* **401 Unauthorized**: Access token is missing or invalid.
* **404 Not Found**: Phone number not found in the database.
* **500 Internal Server Error**: Unexpected server error.