AcyChecker
  • AcyChecker documentation
  • WordPress & Joomla Plugin
    • AcyChecker Plugin WordPress & Joomla
    • Dashboard
    • Clean my database
    • Block on registration
    • Tests
    • Configuration
  • API Documentation
    • Get remaining credits
    • Check a single email address
    • Check a batch of email addresses
Powered by GitBook
On this page
  • Check emails per batch with a CSV
  • Check emails per batch with a JSON
  • Get a list of your batches results
  • Get the batch's results
  1. API Documentation

Check a batch of email addresses

You can either check your email addresses with an JSON input or a CSV input

Check emails per batch with a CSV

POST https://api.acychecker.com/api/v1/bulk_verify

This endpoint allows you to test multiple email addresses. The results won't be returned right away. There are three methods to get the results: - the results can be consulted on a specific page (this is always available, the URL is given to you when creating the batch) - by email when the batch is tested (in this case you must provide a callback_email) - the results can be posted to an URL of your choice (in this case you must provide a callback_url) The results are removed and cannot be recovered after one month.

Headers

Name
Type
Description

API-KEY*

string

Your API key

Source*

string

The name of your app, "My app" for example.

Content-Type*

string

multipart/form-data

Request Body

Name
Type
Description

emails*

file

A CSV file without quotes, with all the email addresses to test (one per line)

{
    // Response
}
{
    // Response
}
{
    // Response
}
{
    // Response
}
{
    // Response
}

Check emails per batch with a JSON

POST https://api.acychecker.com/api/v1/bulk_verify

This endpoint allows you to test multiple email addresses. The results won't be returned right away. There are three methods to get the results: - the results can be consulted on a specific page (this is always available, the URL is given to you when creating the batch) - by email when the batch is tested (in this case you must provide a callback_email) - the results can be posted to an URL of your choice (in this case you must provide a callback_url) The results are removed and cannot be recovered after one month.

Headers

Name
Type
Description

API-KEY*

string

Your API key

Source*

string

The name of your app, "My app" for example.

Content-Type*

string

application/json

Request Body

Name
Type
Description

fileType

string

The type of the export file, must be either JSON or CSV, if nothing is set default is JSON

callbackEmail

string

An email address to which the results will be sent when the tests are finished

callbackUrl

string

An url called when the batch is finished

emails*

string

Must be a json encoded array of email addresses, for example:["john@example.com", "lola@example.com"]

{
    "test_id": 875,
    "url_result": "https://api.acychecker.com/api/v1/bulk_result/875"
}
{
    "message": "There are no emails in the list"
}
{
    "message": "Too many requests"
}
{
    "message": "Not enough credits to do this batch"
}
{
    "message": "Could not process request, please verify that you use the latest version."
}

Get a list of your batches results

GET https://api.acychecker.com/api/v1/bulk_result/{id}

Query Parameters

Name
Type
Description

id*

integer

The ID of the batch you want the results for

Headers

Name
Type
Description

API-KEY*

string

Your API key

{
    // Response
}
{
    // Response
}
{
    // Response
}
{
    // Response
}

Get the batch's results

GET /api/v1/bulk_result/{id}

No matter the method chosen to get the results (sent to an email, a callback URL, or manually), the results will always be available for one month.

Path Parameters

Name
Type
Description

id*

integer

The ID given to you when you created the batch

Headers

Name
Type
Description

API-KEY*

string

Your API key

{
    "message": "The test is still in progress. Currently handled 20 / 200",
    "data": [],
    "status": "in_progress",
    "tested_emails": 20,
    "total_emails": 200,
    "progress": "10%"
}

OR

{
    "message": "",
    "data": [
        "results": [
            {
                "email": "address1@example.com",
                "valid": true,
                "disposable": false,
                "free": false,
                "role": false,
                "d_exists": true,
                "suggestions": [],
                "exists": "valid",
                "accept_all": false
            },
            {
                "email": "address2@example.com",
                "valid": true,
                "disposable": false,
                "free": true,
                "role": false,
                "d_exists": true,
                "suggestions": [],
                "exists": "possible",
                "accept_all": true
            }
        ]
    ]
}
{
    "message": "You can't access this result",
    "data": []
}
{
    "message": "No result found",
    "data": []
}

OR

{
    "message": "The content of the result can't be found.",
    "data": []
}
{
    "message": "Too many requests"
}

PreviousCheck a single email address

Last updated 1 year ago