Perform a single validation request to our API
Endpoint details #
| Endpoint | https://api-validator.aktiva.co.id/app/v1/validate/single |
|---|---|
| Method | GET |
| Details | Postman Collection |
Request query parameters #
| Parameter | Type | Details |
|---|---|---|
| string[email] | Email address that you want to validate | |
| type | string[basic/advance] | Validation type |
Response parameters #
| Parameter | Type | Details |
|---|---|---|
| msg | string | Response message |
| status | string[Success/Failed] | Response status |
| statusCode | HTTP status code | HTTP status code related to response |
| data.email | string[email] | Email address that you sent to validate |
| data.type | string[basic/advance] | Validation type |
| data.uuid | string[uuid] | Unique ID to identify the validation data |
| data.valid | string[valid/invalid/risky] | Validation result |
| data.detail.disposableEmail | bool | Result of disposable email check |
| data.detail.domainStatus | bool | The result of the domain status check, make sure that the domain truly exists or not |
| data.detail.email | string[email] | Email address that you sent to validate |
| data.detail.emailFormat | bool | The result of the email format check, make sure that the email fulfills the valid email address format |
| data.detail.emailType | string[Free Email/Profesional] | The result of the email type check indicates whether the email is publicly available or owned by a personal/organizational |
| data.detail.openRelay | bool | The result of the MX server open relay/accept all check |
| data.detail.roleEmail | bool | Result of role email check |
| data.detail.serverStatus | bool | The result of the MX record availability in the domain |
| data.detail.validationType | string[basic/advance] | Validation type |
| data.detail.timestamp | string[timestamp] | Timestamp of when the request is created |
Response example #
Success validating email #
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 unauthorized #
HTTP/1.1 401 Unauthorized
{
"msg": "Not authorized",
"status": "Failed",
"statusCode": 401,
"data": {
"msg": "not authorized to access this route"
}
}
Error bad request #
HTTP/1.1 400 Bad Request
{
"msg": "Validation error",
"status": "Failed",
"statusCode": 400,
"data": {
"detail": "Query parameter \"email\" is required"
}
}
Error Not enough advance quota #
HTTP/1.1 400 Bad Request
{
"msg": "Company do not have advance validation quota",
"status": "Failed",
"statusCode": 400
}
Error Not enough basic quota #
HTTP/1.1 400 Bad Request
{
"msg": "Company do not have basic validation quota",
"status": "Failed",
"statusCode": 400
}
