M360 Customer API documentation

POST getBlacklistChecksByBatchId

https://m360soft.com/api/customer/v2/getBlacklistChecksByBatchId

Gets the status of a previously scheduled blacklist check batch. This allows you to check if the batch is still processing or if the results are ready.

Request parameters

NameTypeDescription
batchId string A guid representing the batch ID of the blacklist check. This ID is returned when you schedule a blacklist check. Required, Uuid.
testing bool Setting this value to true will result in a response populated only with syntactically correct test data which can be used to test the API integration. While your account is in testing mode the value of this parameter is always true and cannot be overridden. Optional.

Response

The data of the response is a BlacklistCheckBatchResult object This is the data object of the response of the scheduleBlacklistCheck and getBlacklistChecksByBatchId API endpoints.
It contains BlacklistCheckResult

Examples

200 OK POST https://m360soft.com/api/customer/v2/getBlacklistChecksByBatchId
Request 
POST https://m360soft.com/api/customer/v2/getBlacklistChecksByBatchIdContent-Type: application/json

{
    "batchId": "bc883c8b-46d3-ef73-924d-23005e7e8e13"
}
Response application/json 
{
    "data": {
        "batchId": "bc883c8b-46d3-ef73-924d-23005e7e8e13",
        "createdAt": "2024-10-02T13:23:10",
        "batchSize": 3,
        "result": null,
        "status": "queued",
        "availableTokens": 1297
    },
    "meta": {
        "success": true
    }
}
200 OK POST https://m360soft.com/api/customer/v2/getBlacklistChecksByBatchId
Request 
POST https://m360soft.com/api/customer/v2/getBlacklistChecksByBatchIdContent-Type: application/json

{
    "batchId": "bc883c8b-46d3-ef73-924d-23005e7e8e13"
}
Response application/json 
{
    "data": {
        "batchId": "bc883c8b-46d3-ef73-924d-23005e7e8e13",
        "createdAt": "2024-10-02T13:23:10",
        "batchSize": 3,
        "result": [
            {
                "createdAt": "2025-01-01T12:00:00+00:00",
                "imei": "566171972540345",
                "result": "green"
            },
            {
                "createdAt": "2025-01-01T12:00:00+00:00",
                "imei": "446416547821353",
                "result": "red"
            }
        ],
        "status": "successful",
        "availableTokens": 1298
    },
    "meta": {
        "success": true
    }
}