Email Validator API Concept

1 min read

Base URL #

BaseURL Endpoint https://api-validator.aktiva.co.id/app/v1/
Method GET & POST
Details Postman Collection

 

 

Authentication #

For each request to Email Validator API is required to provide authentication using the API key generated in the Aktiva Email Validator dashboard. You can pass the API key in the request header in the Authorization section.

 

Example using cURL #

curl -H 'Authorization: <API_KEY>' -X GET https://api-validator.aktiva.co.id/app/v1/validate/single

 

Responses #

All data are sent by the API using JSON format. Each response sent from the API contains a status parameter with the value either “Success” or “Failed” indicating whether the request is successful or not.

 

Success Response Example #

HTTP/1.1 200 OK
{
    "msg": "Success validate single email",
    "status": "Success",
    "statusCode": 200,
    "data": {
        "detail": {
            "disposableEmail": false,
            "domainStatus": true,
            "email": "r@richi.my.id",
            "emailFormat": true,
            "emailType": "Profesional",
            "openRelay": true,
            "result": "risky",
            "roleEmail": false,
            "serverStatus": true,
            "timestamp": "2024-05-13T15:35:36.800651+07:00",
            "validationType": "advance"
        },
        "email": "r@richi.my.id",
        "type": "advance",
        "uuid": "50d035b8-c9bc-4cb1-91c0-64db8a2b687c",
        "valid": "risky"
    }
}

 

 

Error Response Example #

HTTP/1.1 401 Unauthorized

{
    "msg": "Not authorized",
    "status": "Failed",
    "statusCode": 401,
    "data": {
        "msg": "not authorized to access this route"
    }
}

 

 

HTTP Status Codes #

Status Code Name Description
200 OK Request successful
400 Bad Request Request requirements not fulfilled
401 Unauthorized Invalid API Key
404 Not Found Resource not found
500 Internal Server Error Something is wrong with our services
Apakah dokumentasi ini membantu?
Updated on December 19, 2024