API docs by Redocly

Dangerous Goods Prediction API (1.0.0)

Download OpenAPI specification:

API that returns a machine-learning prediction score indicating the likelihood that a postal item contains dangerous or prohibited goods.

Get dangerous goods prediction score

Returns a prediction score between 0 and 1 for a given mail item. A higher value indicates higher likelihood of the item being dangerous.

Request Body schema: application/json
required
SecurityToken
required
string

API security token

ItemId
required
string

Unique identifier of the mail item

Responses

Request samples

Content type
application/json
{
  • "SecurityToken": "A0B216AD-2AE6-4D56-BEAE-6AF3436C5E95",
  • "ItemId": "SK621932176LV"
}

Response samples

Content type
application/json
Example
{
  • "Message": "Prediction fetched",
  • "Prediction": 0.999266
}