Submit one or more fraud reports for evaluation and processing.
This endpoint accepts a batch of reports and processes each independently. Each report will receive a separate status in the response, enabling partial success scenarios where some reports succeed while others fail.
Response statuses per report
Each item in the reports array of the response will have a status:
reported: The fraud report was successfully processed and recorded. ThereportIdfield will contain the ID that was assigned to the report.error: The report could not be processed. Thedetailsfield will contain the reason, such as:- "The categories [...] are not valid."
- "The specified sessionId was not found."
- "The verification is in a state that cannot be reported."
- "A report already exists for this session."
- "An unexpected error occurred..."
API key
Full request path signed with the shared secret key
{
"reports": [
{
"sessionId": "d4f37a0d-2858-4270-aa74-0be2a78cadcb",
"categories": [
"document_is_manipulated"
],
"comment": "Right side of the document appears to be cut off"
},
{
"sessionId": "cef3dc5b-4af1-476f-b75d-708dea4b7582",
"categories": [
"injected_media"
],
"comment": "Media is injected"
}
]
}{
"reports": [
{
"sessionId": "d4f37a0d-2858-4270-aa74-0be2a78cadcb",
"categories": [
"document_is_manipulated"
],
"comment": "Right side of the document appears to be cut off"
}
]
}Request body model for submitting one or more fraud reports.
List of fraud reports to submit.
Represents a single fraud report within a submission request.
The unique identifier of the Veriff session being reported.
List of fraud category codes associated with this report.
A fraud category code (obtainable from /fraud-categories).
Optional additional details or context about the fraud report (max 500 characters recommended).
The unique identifier of the user who creates the report.
Successful Response
{
"reports": [
{
"sessionId": "d4f37a0d-2858-4270-aa74-0be2a78cadcb",
"reportId": "a565f8b9-9c0a-4e8e-95c4-94c4b51e150e",
"status": "reported"
}
]
}{
"reports": [
{
"sessionId": "d4f37a0d-2858-4270-aa74-0be2a78cadcb",
"reportId": "a565f8b9-9c0a-4e8e-95c4-94c4b51e150e",
"status": "reported"
},
{
"sessionId": "cef3dc5b-4af1-476f-b75d-708dea4b7582",
"reportId": "3a8d086a-bd10-4e66-ba29-a4d2671d0b49",
"status": "error",
"details": "The verification is in a state that cannot be reported."
}
]
}{
"reports": [
{
"sessionId": "cef3dc5b-4af1-476f-b75d-708dea4b7582",
"reportId": "3a8d086a-bd10-4e66-ba29-a4d2671d0b49",
"status": "error",
"details": "The verification is in a state that cannot be reported."
}
]
}Response model for fraud report submission, providing both detailed per-item results and summary statistics for the batch operation.
Detailed results for each individual report submission, including status and error details if applicable.
Represents the processing result for a single fraud report within a batch submission.
The session ID corresponding to this report result.
The unique ID assigned to the successfully processed fraud report. Null if processing failed.
The processing status of this individual report ('reported' or 'error').
Provides error details if the status is 'error', otherwise null.
Total number of reports received and processed in this request batch.
Number of reports that were successfully submitted and recorded.
Number of reports that failed validation or processing.
Bad Request. Possible reasons: Invalid categories, invalid session state, report already exists.
Generic error response structure.
A machine-readable error code indicating the type of error.
A human-readable message explaining the error.
Unauthorized. Possible reasons: Invalid API key or signature.
{
"code": "1803",
"message": "Integration with the API key '6ee9e344-20a6-439d-bf21-b6610db63ad6' was not found."
}Generic error response structure.
A machine-readable error code indicating the type of error.
A human-readable message explaining the error.
Unprocessable Entity. Input validation failed.
{
"code": "UNPROCESSABLE_ENTITY",
"message": "Validation failed: reports: Field required"
}Generic error response structure.
A machine-readable error code indicating the type of error.
A human-readable message explaining the error.
Too Many Requests. Rate limit exceeded.
{
"code": "RATE_LIMIT_EXCEEDED",
"message": "Limit exceeded: 1000 per minute"
}Generic error response structure.
A machine-readable error code indicating the type of error.
A human-readable message explaining the error.
Internal Server Error. An unexpected error occurred.
{
"code": "INTERNAL_SERVER_ERROR",
"message": "An unexpected error occurred."
}Generic error response structure.
A machine-readable error code indicating the type of error.
A human-readable message explaining the error.
Changelog
Date | Description |
|---|---|
Nov 6, 2025 | "Article Versioning" changed to "Changelog" |
Oct 3, 2025 | Note about pre-release removed |
Sep 18, 2025 | Name of the article changed |
Mar 12, 2025 | Documentation published |