Table of Contents

Clearout

Active with remarks
This application needs additional settings. Please follow the documentation below to create your own connection.

Clearout

The Clearout modules allow you to verify different kinds of email addresses in your Clearout account.

Getting Started with Clearout

Prerequisites

A Clearout account

In order to use Clearout with Boost.space Integrator, it is necessary to have a Clearout account. If you do not have one, you can create a Clearout account at app.clearout.io/register.

	Note
	The module dialog fields that are displayed in bold (in the Boost.space Integrator scenario, not in this documentation article) are mandatory!

Connecting Clearout to Boost.space Integrator

To connect your Clearout account to Boost.space Integrator you need to obtain the API Key from your Clearout account and insert it in the Create a connection dialog in the Boost.space Integrator module.

Login to your Clearout account.
Click your Profile Icon > Generate API Token.
Copy the API Token to your clipboard.
Go to Boost.space Integrator and open the Clearout module’s Create a connection dialog.
In the Connection name field, enter a name for the connection.
In the API Key field, enter the API token copied in step 3 and click Continue.

The connection has been established.

Action

Verify Email Address

Verifies the given email address in real-time.

Connection	Establish a connection to your Clearout account.
Email Address	Enter the email address you want to verify.
Limit	(Optional) Enter the request wait time in seconds. The maximum wait time allowed is 180 seconds. The default value is 130 seconds.

Verify Email Address for Business Email

Verifies given email address as business (work) address or not.

Connection	Establish a connection to your Clearout account.
Email Address	Enter the email address you want to verify the business account.
Limit	(Optional) Enter the request wait time in seconds. The maximum wait time allowed is 110 seconds. The default value is 90 seconds.

Verify Email Address for Disposable

Verifies given email address as disposable (temporarily) address or not.

Connection	Establish a connection to your Clearout account.
Email Address	Enter the email address you want to verify for disposable.
Limit	(Optional) Enter the request wait time in seconds. The maximum wait time allowed is 110 seconds. The default value is 90 seconds.

Verify Email Address for Role

Verifies the given email address as role (group) address or not.

Connection	Establish a connection to your Clearout account.
Email Address	Enter the email address you want to verify the role account.
Limit	(Optional) Enter the request wait time in seconds. The maximum wait time allowed is 110 seconds. The default value is 90 seconds.

Verify Email Address for CatchAll

Verifies the given email address as a catch-all address or not.

Connection	Establish a connection to your Clearout account.
Email Address	Enter the email address you want to verify for CatchAll.
Limit	(Optional) Enter the request wait time in seconds. The maximum wait time allowed is 110 seconds. The default value is 90 seconds.

Get Available Credits

Gets authorized credits for an authorized API call.

Connection

Establish a connection to your Clearout account.

Find Domain MX

Finds the MX record for the domain.

Connection	Establish a connection to your Clearout account.
Domain Name	Enter the domain name for which you want to find the MX records.
Limit	(Optional) Enter the request wait time in seconds. The maximum wait time allowed is 110 seconds. The default value is 90 seconds.

Find Domain Whois Record

Finds the whois record for the domain.

Connection	Establish a connection to your Clearout account.
Domain Name	Enter the domain name for which you want to find the whois record.
Limit	(Optional) Enter the request wait time in seconds. The maximum wait time allowed is 110 seconds. The default value is 90 seconds.

Find Domain Expiry

Finds the domain expiry date from who is record.

Connection	Establish a connection to your Clearout account.
Domain Name	Enter the domain name for which you want to find the expiry date.
Limit	(Optional) Enter the request wait time in seconds. The maximum wait time allowed is 110 seconds. The default value is 90 seconds.

Universal

Make an API Call

Performs an arbitrary authorized API call.

Connection

Establish a connection to your Clearout account.

URL

Enter a path relative to https://api.clearout.io/v2. For example: /email_verify/instant

	Note
	For the list of available endpoints, refer to the Clearout API Documentation.

Method

Select the HTTP method you want to use:

GET

to retrieve information for an entry.

POST

to create a new entry.

PUT

to update/replace an existing entry.

PATCH

to make a partial entry update.

DELETE

to delete an entry.

Headers

Enter the desired request headers. You don’t have to add authorization headers; we already did that for you.

Query String

Enter the request query string.

Body

Enter the body content for your API call.

Example of Use – Get Available Credits

The following API call returns the available credits from your Clearout account:

URL:

/email_verify/getcredits

Method:

GET

The result can be found in the module’s Output under Bundle > Body > data > credits.

In our example, available credits in the account were returned: