Report outcomes · Antiro Docs

POST https://api.antiro.io/v1/outcomes

Body parameters#

Identify the order with order_id or assessment_id, and send verdict, outcome or both.

order_id string: Your order number, as you sent it to the order check.
assessment_id string: The id from the order check, instead of order_id.
verdict genuine | fake: What your confirmation team found.
outcome delivered | returned | cancelled: The shipping status of the order.

Example request#

POST /v1/outcomes

curl https://api.antiro.io/v1/outcomes \
  -H "X-API-Key: $ANTIRO_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "order_id": "1042", "verdict": "fake" }'

Response#

A successful report answers 201 Created.

order_id string: Antiro’s id for the order. It is not your order number.
verdict string: The verdict you sent.
recorded boolean: true when Antiro recorded the verdict.
outcome string: The shipping status, when you sent one.

201 Created

{
  "order_id": "94074eb2-6c23-42e0-92f9-9f865cf88452",
  "verdict": "fake",
  "recorded": true
}

What Antiro learns from#

verdict is the strongest signal you can send, so report fake orders with it. delivered also tells Antiro the order was genuine. returned and cancelled are stored, but they do not mark an order as fake.