The Reports API allows you to report incorrect results from the enrichment process and get notified of any corrections that are enacted by our QA team via webhooks. All reports that are submitted are integrated in a feedback loop that continuously that improves our internal databases, models and results.

A report can take between one hour and (less commonly) a few weeks, depending on the complexity of the issue.

Submitting a report

When you encounter a transaction that has incorrect results, you can report it. To submit a report you need to provide a description of what is wrong with the transaction, the fields that are affected and the transaction_id of the transaction in question:

1
curl -X "POST" \
2
    "https://api.ntropy.com/v3/reports" \
3
    -H "Accept: application/json" \
4
    -H "X-API-KEY: cd1H...Wmhl"  \
5
    -H "Content-Type: application/json" \
6
    -d '{
7
        "transaction_id": "xbx8YP14g565Xk",
8
        "description": "lorem ipsum",
9
        "fields": [
10
            ".entities.counterparty"
11
        ]
12
    }'
13
 

1
{
2
  "transaction_id": "xbx8YP14g565Xk",
3
  "description": "lorem ipsum",
4
  "fields": [
5
    ".entities.counterparty"
6
  ],
7
  "id": "a652285d-de1b-4a6f-b6ce-45efa9be7952",
8
  "created_at": "2024-10-03T02:53:30.167953Z",
9
  "status": "open"
10
}

Viewing the progress of the report

When the report is submitted, it is evaluated by our QA team and goes through several stages:

To explicitly check on the status of a report:

1
curl -X "GET" \
2
    "https://api.ntropy.com/v3/reports/a652285d-de1b-4a6f-b6ce-45efa9be7952" \
3
    -H "Accept: application/json" \
4
    -H "X-API-KEY: cd1H...Wmhl"  

1
{
2
  "transaction_id": "xbx8YP14g565Xk",
3
  "description": "lorem ipsum",
4
  "fields": [
5
    ".entities.counterparty"
6
  ],
7
  "id": "a652285d-de1b-4a6f-b6ce-45efa9be7952",
8
  "created_at": "2024-10-03T02:53:30.167953Z",
9
  "status": "open"
10
}