Reoon Articles

https://www.reoon.com/articles/
Admin
Reoon Articles provides a library of practical articles, tutorials, and step-by-step guides designed...
Tokens:23,046
Snippets:195
Trust Score:8.2
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Python: Get bulk verification task results

Source: https://www.reoon.com/articles/api-documentation-of-reoon-email-verifier

Python example for fetching the results of a bulk verification task. Replace the placeholder API key and task_id values. The response is printed as JSON.

```Python
import requests

key = 'your_api_ley'  # Replace it with your actual API key.
task_id = 40675       # Replace it with the task_id obtained from the previous step.

url = f'https://emailverifier.reoon.com/api/v1/get-result-bulk-verification-task/?key={key}&task-id={task_id}'

response = requests.get(url)

print(response.json())

```

--------------------------------

### Example Python response JSON

Source: https://www.reoon.com/articles/api-documentation-of-reoon-email-verifier

Example JSON response from the get-result-bulk-verification-task endpoint showing a completed task with results per email.

```JSON
{
   "count_checked":7,
   "count_total":7,
   "name":"API: Task via API",
   "progress_percentage":100.0,
   "results":{
      "jhon200@outlook.com":{
         "can_connect_smtp":true,
         "domain":"outlook.com",
         "email":"jhon200@outlook.com",
         "has_inbox_full":false,
         "is_catch_all":false,
         "is_deliverable":true,
         "is_disabled":false,
         "is_disposable":false,
         "is_role_account":false,
         "is_safe_to_send":true,
         "is_spamtrap":false,
         "is_valid_syntax":true,
         "mx_accepts_mail":true,
         "mx_records":[
            "outlook-com.olc.protection.outlook.com"
         ],
         "status":"safe",
         "username":"jhon200"
      },
      "test1@yahoo.com":{
         "can_connect_smtp":true,
         "domain":"yahoo.com",
         "email":"test1@yahoo.com",
         "has_inbox_full":false,
         "is_catch_all":false,
         "is_deliverable":false,
         "is_disabled":false,
         "is_disposable":false,
         "is_role_account":false,
         "is_safe_to_send":false,
         "is_spamtrap":"None",
         "is_valid_syntax":true,
         "mx_accepts_mail":true,
         "mx_records":[
            "mta5.am0.yahoodns.net",
            "mta6.am0.yahoodns.net",
            "mta7.am0.yahoodns.net"
         ],
         "status":"invalid",
         "username":"test1"
      },
      ## Data of all other email addresses will be here.
      ## ..........
      ## ..........
   },
   "status":"completed",
   "task_id":"40676"
}

```

--------------------------------

### GET /api/v1/check-account-balance/

Source: https://www.reoon.com/articles/api-documentation-of-reoon-email-verifier

This endpoint allows users to check their current account balance, including remaining daily and instant credits. It requires an API key as a query parameter.

```APIDOC
## [GET] /api/v1/check-account-balance/

### Description
Check the current account balance, including remaining daily and instant credits.

### Method
GET

### Endpoint
https://emailverifier.reoon.com/api/v1/check-account-balance/

### Parameters
#### Query Parameters
- **key** (string) - Required - Your active API key.

### Response
#### Success Response (200)
- **api_status** (string) - Status of the API key (e.g., "active").
- **remaining_daily_credits** (integer) - Remaining daily credits.
- **remaining_instant_credits** (integer) - Remaining instant credits.
- **status** (string) - Status of the request (e.g., "success").

#### Response Example
{
    "api_status": "active",
    "remaining_daily_credits": 150,
    "remaining_instant_credits": 5000,
    "status": "success"
}
```

--------------------------------

### GET get-result-bulk-verification-task

Source: https://www.reoon.com/articles/api-documentation-of-reoon-email-verifier

Python code example for retrieving the results of a bulk email verification task using the Reoon Email Verifier API.

```APIDOC
## [GET] https://emailverifier.reoon.com/api/v1/get-result-bulk-verification-task/

### Description
Retrieves the results of a previously created bulk email verification task. The response includes the overall status of the task and, if completed, the verification results for each email.

### Method
GET

### Endpoint
https://emailverifier.reoon.com/api/v1/get-result-bulk-verification-task/?key=<Your_API_Key>&task_id=<Task_ID>

### Parameters
#### Query Parameters
- **key** (String) - Required - Your active API key.
- **task_id** (String) - Required - The ID of the task obtained from the previous step.

### Request Example
```
https://emailverifier.reoon.com/api/v1/get-result-bulk-verification-task/?key=your_api_key&task_id=40675
```

### Response
#### Success Response (200)
- **task_id** (String) - The ID of the task.
- **name** (String) - The name of the task.
- **status** (String) - The status of the task. Can be 'waiting', 'running', 'completed', 'file_not_found', 'file_loading_error', or another status.
- **count_total** (Integer) - The total number of emails submitted for the task.
- **count_checked** (Integer) - The number of emails checked so far.
- **progress_percentage** (Float) - The percentage of emails checked.
- **results** (Array of Objects) - Present if the task has completed. Each object represents an email and contains verification details.

#### Response Example
```
{
   "count_checked":7,
   "count_total":7,
   "name":"API: Task via API",
   "progress_percentage":100.0,
   "results":{
      "jhon200@outlook.com":{
         "can_connect_smtp":true,
         "domain":"outlook.com",
         "email":"jhon200@outlook.com",
         "has_inbox_full":false,
         "is_catch_all":false,
         "is_deliverable":true,
         "is_disabled":false,
         "is_disposable":false,
         "is_role_account":false,
         "is_safe_to_send":true,
         "is_spamtrap":false,
         "is_valid_syntax":true,
         "mx_accepts_mail":true,
         "mx_records":[
            "outlook-com.olc.protection.outlook.com"
         ],
         "status":"safe",
         "username":"jhon200"
      },
      "test1@yahoo.com":{
         "can_connect_smtp":true,
         "domain":"yahoo.com",
         "email":"test1@yahoo.com",
         "has_inbox_full":false,
         "is_catch_all":false,
         "is_deliverable":false,
         "is_disabled":false,
         "is_disposable":false,
         "is_role_account":false,
         "is_safe_to_send":false,
         "is_spamtrap":"None",
         "is_valid_syntax":true,
         "mx_accepts_mail":true,
         "mx_records":[
            "mta5.am0.yahoodns.net",
            "mta6.am0.yahoodns.net",
            "mta7.am0.yahoodns.net"
         ],
         "status":"invalid",
         "username":"test1"
      }
   },
   "status":"completed",
   "task_id":"40676"
}
```

#### Error Response
- **status** (String) - Will be 'error' if an error occurred.
- **reason** (String) - A description of the error that occurred.
```

--------------------------------

### POST create-bulk-verification-task

Source: https://www.reoon.com/articles/api-documentation-of-reoon-email-verifier

Python example for creating a bulk email verification task using the Reoon Email Verifier API.

```APIDOC
## [POST] https://emailverifier.reoon.com/api/v1/create-bulk-verification-task/

### Description
Creates a bulk email verification task by submitting a list of emails. The system will process the emails to remove duplicates and start verifying them internally.

### Method
POST

### Endpoint
https://emailverifier.reoon.com/api/v1/create-bulk-verification-task/

### Parameters
#### Request Body
- **name** (String) - Optional - The name of the task. Maximum length 25 characters.
- **emails** (Array of Strings) - Required - An array of email addresses to be verified. Up to 50,000 emails can be submitted.
- **key** (String) - Required - The API key. The API key must be active.

### Request Example
{
    "name": "Task Name",
    "emails": ["test1@example.com", "test2@example.com", "test3@example.com"],
    "key": "Your_API_Key"
}

### Response
#### Success Response (201)
- **status** (String) - The status of the request. This will be `success` if the task was created successfully.
- **task_id** - The unique ID of the successfully created task.
- **count_submitted** (Integer) - The number of emails that were submitted.
- **count_duplicates_removed** (Integer) - The number of duplicate emails that were removed.
- **count_rejected_emails** (Integer) - The number of emails that were rejected (not checked) by system for incorrect formatting.
- **count_processing** (Integer) - The number of unique emails that are being processed.

#### Response Example
{
    "status": "success",
    "task_id": 123456,
    "count_submitted": 3,
    "count_duplicates_removed": 0,
    "count_rejected_emails": 0,
    "count_processing": 3
}

#### Error Response
- **status** (String) - The status of the request. This will be `error` if an error occurred.
- **reason** (String) - A description of the error that occurred.

#### Error Response Example
{
    "status": "error",
    "reason": "Error description"
}
```

--------------------------------

### GET /api/v1/verify (Quick Mode)

Source: https://www.reoon.com/articles/api-documentation-of-reoon-email-verifier

This code snippet documents the GET request to the Reoon Email Verifier API for single email verification in QUICK mode. It includes the endpoint URL, query parameters, and the JSON response structure.

```APIDOC
## [GET] https://emailverifier.reoon.com/api/v1/verify

### Description
Verifies a single email address in QUICK mode. This endpoint is ideal for verifying email at its entry level, such as during user registration, to prevent users from registering using temporary/disposable emails. It checks email syntax, disposable/temporary email status, MX validation and records, domain email acceptance, invalid email detection, expired/invalid domain detection, and role account check. Note: Quick Mode does not check individual inbox status.

### Method
GET

### Endpoint
https://emailverifier.reoon.com/api/v1/verify

### Parameters
#### Query Parameters
- **email** (string) - Required - The email address you want to verify. i.e. jhon123@gmail.com
- **key** (string) - Required - One of your API keys created above on this page.
- **mode** (string) - Optional - "quick" (Default is "quick", if not provided).

### Request Example
https://emailverifier.reoon.com/api/v1/verify?email=jhon123@gmail.com&key=<key>&mode=quick

### Response
#### Success Response (200)
- **email** (string) - The email address that was verified.
- **status** (string) - Verification status. All Status: "valid", "invalid", "disposable", "spamtrap"
- **username** (string) - The username part of the email address.
- **domain** (string) - The domain part of the email address.
- **is_valid_syntax** (boolean) - Whether the email syntax is valid.
- **is_disposable** (boolean) - Whether the email is disposable/temporary.
- **is_role_account** (boolean) - Whether the email is a role account.
- **mx_accepts_mail** (boolean) - Whether the MX records accept mail.
- **is_spamtrap** (boolean) - Whether the email is a spamtrap.
- **is_free_email** (boolean) - Whether the email is from a free email provider.
- **mx_records** (array of strings) - List of MX records for the domain.
- **verification_mode** (string) - The verification mode used ("quick").

#### Response Example
{
    "email": "jhon123@gmail.com",
    "status": "valid",   // All Status: "valid", "invalid", "disposable", "spamtrap"
    "username": "jhon123",
    "domain": "gmail.com",
    "is_valid_syntax": true,
    "is_disposable": false,
    "is_role_account": false,
    "mx_accepts_mail": true,
    "is_spamtrap": false,
    "is_free_email": true,
    "mx_records": [
        "gmail-smtp-in.l.google.com",
        "alt1.gmail-smtp-in.l.google.com",
        "alt2.gmail-smtp-in.l.google.com",
        "alt3.gmail-smtp-in.l.google.com",
        "alt4.gmail-smtp-in.l.google.com"
    ],
    "verification_mode": "quick"
}
```

--------------------------------

### Quick Mode API Request URL

Source: https://www.reoon.com/articles/api-documentation-of-reoon-email-verifier

GET request URL for the Reoon Email Verifier API in quick mode. Replace <email> and <key> with your own data. The mode parameter defaults to 'quick' if not provided.

```http
https://emailverifier.reoon.com/api/v1/verify?email=<email>&key=<key>&mode=quick
```

--------------------------------

### Power mode verification JSON response

Source: https://www.reoon.com/articles/api-documentation-of-reoon-email-verifier

Example JSON response from the power mode verification request. Shows the status values, overall score (out of 100), and all boolean verification flags, including MX records and verification mode.

```json
{
    "email": "jhon123@gmail.com",
    "status": "safe",       // All Status: "safe", "invalid", "disabled", "disposable", "inbox_full", "catch_all", "role_account", "spamtrap", "unknown"
    "overall_score": 98,    // Out of 100.
    "username": "jhon123",
    "domain": "gmail.com",
    "is_safe_to_send": true,
    "is_valid_syntax": true,
    "is_disposable": false,
    "is_role_account": false,
    "can_connect_smtp": true,
    "has_inbox_full": false,
    "is_catch_all": false,
    "is_deliverable": true,
    "is_disabled": false,
    "is_spamtrap": false,
    "is_free_email": true,
    "mx_accepts_mail": true,
    "mx_records": [
        "alt3.gmail-smtp-in.l.google.com",
        "alt2.gmail-smtp-in.l.google.com",
        "alt4.gmail-smtp-in.l.google.com",
        "alt1.gmail-smtp-in.l.google.com",
        "gmail-smtp-in.l.google.com"
    ],
    "verification_mode": "power"
}
```

--------------------------------

### GET /api/v1/verify

Source: https://www.reoon.com/articles/api-documentation-of-reoon-email-verifier

This snippet documents the GET request to verify an email address using the power mode of the Reoon Email Verifier API.

```APIDOC
## [GET] https://emailverifier.reoon.com/api/v1/verify

### Description
Verifies an email address using the power mode, which performs a comprehensive check including syntax validation, disposable email detection, MX validation, domain acceptance, role account check, inbox full check, existence check, and catch-all detection.

### Method
GET

### Endpoint
https://emailverifier.reoon.com/api/v1/verify

### Parameters
#### Query Parameters
- **email** (string) - Required - The email address to verify (e.g., jhon123@gmail.com)
- **key** (string) - Required - One of your API keys created on the page
- **mode** (string) - Required - Must be "power"

### Request Example
https://emailverifier.reoon.com/api/v1/verify?email=jhon123@gmail.com&key=YOUR_API_KEY&mode=power

### Response
#### Success Response (200)
- **email** (string) - The email address that was verified
- **status** (string) - Verification status. Possible values: "safe", "invalid", "disabled", "disposable", "inbox_full", "catch_all", "role_account", "spamtrap", "unknown"
- **overall_score** (integer) - Overall score out of 100
- **username** (string) - The username part of the email
- **domain** (string) - The domain part of the email
- **is_safe_to_send** (boolean) - Whether it is safe to send an email to this address
- **is_valid_syntax** (boolean) - Whether the email syntax is valid
- **is_disposable** (boolean) - Whether the email is disposable/temporary
- **is_role_account** (boolean) - Whether the email is a role account
- **can_connect_smtp** (boolean) - Whether SMTP connection is possible
- **has_inbox_full** (boolean) - Whether the inbox is full
- **is_catch_all** (boolean) - Whether the domain is catch-all
- **is_deliverable** (boolean) - Whether the email is deliverable
- **is_disabled** (boolean) - Whether the email is disabled
- **is_spamtrap** (boolean) - Whether the email is a spam trap
- **is_free_email** (boolean) - Whether the email is from a free email provider
- **mx_accepts_mail** (boolean) - Whether the MX records accept mail
- **mx_records** (array of strings) - List of MX records for the domain
- **verification_mode** (string) - The verification mode used ("power")

#### Response Example
{
    "email": "jhon123@gmail.com",
    "status": "safe",
    "overall_score": 98,
    "username": "jhon123",
    "domain": "gmail.com",
    "is_safe_to_send": true,
    "is_valid_syntax": true,
    "is_disposable": false,
    "is_role_account": false,
    "can_connect_smtp": true,
    "has_inbox_full": false,
    "is_catch_all": false,
    "is_deliverable": true,
    "is_disabled": false,
    "is_spamtrap": false,
    "is_free_email": true,
    "mx_accepts_mail": true,
    "mx_records": [
        "alt3.gmail-smtp-in.l.google.com",
        "alt2.gmail-smtp-in.l.google.com",
        "alt4.gmail-smtp-in.l.google.com",
        "alt1.gmail-smtp-in.l.google.com",
        "gmail-smtp-in.l.google.com"
    ],
    "verification_mode": "power"
}
```

--------------------------------

### Quick Mode API Response JSON

Source: https://www.reoon.com/articles/api-documentation-of-reoon-email-verifier

Example JSON response from the quick mode verification. The status field can be 'valid', 'invalid', 'disposable', or 'spamtrap'. The response includes syntax, disposable, role account, MX, and free email flags.

```json
{
    "email": "jhon123@gmail.com",
    "status": "valid",   // All Status: "valid", "invalid", "disposable", "spamtrap"
    "username": "jhon123",
    "domain": "gmail.com",
    "is_valid_syntax": true,
    "is_disposable": false,
    "is_role_account": false,
    "mx_accepts_mail": true,
    "is_spamtrap": false,
    "is_free_email": true,
    "mx_records": [
        "gmail-smtp-in.l.google.com",
        "alt1.gmail-smtp-in.l.google.com",
        "alt2.gmail-smtp-in.l.google.com",
        "alt3.gmail-smtp-in.l.google.com",
        "alt4.gmail-smtp-in.l.google.com"
    ],
    "verification_mode": "quick"
}
```
Tokens:
Raw