This endpoint is to perform bulk email validation requests.
For this endpoint, you need to prepare the file either with format CSV or TXT that contains the email you want to validate with maximum size of 500KB
Endpoint details #
| Endpoint | https://api-validator.aktiva.co.id/app/v1/validate/bulk |
|---|---|
| Method | POST |
| Details | Postman Collection |
Request form data #
| Parameter | Type | Description |
| name | string | Custom name of the bulk validation that will be processed |
| type | string[basic/advance] | The type of validation will be used for related bulk validation |
| file | file[csv/txt] | The file that contains the email will be processed |
Response parameters #
| Parameter | Type | Description |
| msg | string | Response message |
| status | string[Success/Failed] | Response status |
| statusCode | HTTP status code | HTTP status code related to response |
| data.detail.fileFormat | string[csv/txt] | The format of the provided file |
| data.detail.name | string | The name of the bulk validation |
| data.detail.status | string[validating/validated/error] | The current status of bulk validation |
| data.detail.uuid | string[uuid] | The unique ID to identify the bulk validation data |
| data.detail.validationType | string[basic/advance] | The validation type that will be used to process the bulk validation |
| data.message | string | Additional response message |
Response example #
Success validating email #
HTTP/1.1 200 OK
{
"msg": "Starting validation process",
"status": "Success",
"statusCode": 200,
"data": {
"detail": {
"fileFormat": "txt",
"name": "Test Bulk Validate",
"status": "validating",
"uuid": "8195044a-fe42-45de-b4ae-f1488b86ce42",
"validationType": "advance"
},
"message": "Bulk data will be processed"
}
}
Error exceeded limit #
HTTP/1.1 400 Bad Request
{
"msg": "Upload file exceeded limit",
"status": "Failed",
"statusCode": 400,
"data": {
"limit": 500000,
"uploaded": 559999
}
}
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
}
