This endpoint is to get bulk validation data/status

Endpoint details

Endpoint	https://api-validator.aktiva.co.id/app/v1/validate/bulk
Method	GET
Details	Postman Collection

 

Request query parameters

Parameter	Type	Details
uuid	string[uuid]	The bulk validation unique ID that you want to retrieve the data

 

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.downloadLink	string	The link of bulk validation results
data.detail.name	string	The name of the bulk validation
data.detail.percentage	float	The percentage of bulk validation progress
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

 

 

Response example

Success get information

HTTP/1.1 200 OK

{
    "msg": "Success get bulk validation data",
    "status": "Success",
    "statusCode": 200,
    "data": {
        "detail": {
            "downloadLink": "https://aktiva-relay.ap-south-1.linodeobjects.com/email-validator/public/e865e844-03ce-4093-9cc6-26ee90bfff42/result/8195044a-fe42-45de-b4ae-f1488b86ce43.csv",
            "name": "Test Bulk Validate",
            "percentage": 100,
            "status": "validated",
            "uuid": "8195044a-fe42-45de-b4ae-f1488b86ce43",
            "validationType": "advance"
        }
    }
}

 

Error unauthorized

HTTP/1.1 401 Unauthorized

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

 

Error not found

HTTP/1.1 404 Not Found
 
{
    "msg": "Bulk validation data not found",
    "status": "Failed",
    "statusCode": 404,
    "data": {
        "msg": "Bulk validation data not found"
    }
}

 

Error invalid type of query parameter

HTTP/1.1 400 Bad Request

{
    "msg": "Validation error",
    "status": "Failed",
    "statusCode": 400,
    "data": {
        "detail": "invalid UUID length: 0",
        "message": "Request Body \"uuid\" is required"
    }
}