API ReferenceReports

Create a report

Report a transaction with incorrect fields.

Complete guide: Reports.

Headers

X-Api-KeystringRequired
X-Application-IdstringRequired

Request

This endpoint expects an object.
transaction_idstringRequired>=1 character

The unique identifier of the transaction

descriptionstringRequired

A description of what is wrong in the transaction

fieldslist of stringsRequired

A list of the fields that are incorrect

Response

The newly created report

transaction_idstring>=1 character

The unique identifier of the transaction

descriptionstring

A description of what is wrong in the transaction

fieldslist of strings

A list of the fields that are incorrect

idstring

A generated unique identifier for the report.

created_atdatetime

The date and time when the report was created.

statusenum

The status of the report.

  • open: a newly created report
  • pending: the report is being investigated
  • rejected: the original enrichment output was deemed correct or we couldn’t resolve it, check rejection_reason
  • resolved: the issue has been resolved
Allowed values:
rejection_reasonstringOptional

If the report was rejected, an explanation for the rejection.

Errors