Get fraud categories

Prev
Get
/v1/feedback/fraud-categories

Returns a list of available fraud categories that can be reported via POST /feedback/fraud-reports.

This pre-release API is currently active for select few customers. Requests to the API URL will not return data if you are not part of the trial. We will expand availability in near future to all customers.

Header parameters
VRF-AUTH-CLIENT
stringRequired

API key

VRF-HMAC-SIGNATURE
stringRequired

Full request path signed with the shared secret key

Responses
200

Successful Response

possible_fraud_categories_and_descriptions
{
  "categories": [
    {
      "category": "document_is_manipulated",
      "description": "Document is manipulated"
    },
    {
      "category": "document_shown_from_screen",
      "description": "Document is shown from screen"
    },
    {
      "category": "document_is_printed_copy",
      "description": "Document is a printed out copy"
    },
    {
      "category": "selfie_shown_from_screen",
      "description": "Selfie is shown from screen"
    },
    {
      "category": "selfie_is_manipulated",
      "description": "Selfie is manipulated"
    },
    {
      "category": "selfie_document_portrait_mismatch",
      "description": "Selfie does not match document portrait"
    },
    {
      "category": "injected_media",
      "description": "Media is injected"
    }
  ]
}
Expand All
object

Response model containing the list of available fraud categories.

categories
Array of object (FraudCategory)

List of available fraud categories.

object
category
string

Machine-readable code for the fraud category.

Exampledocument_is_manipulated
description
string

Human-readable description of the category.

ExampleDocument appears to be digitally altered or forged.
401

Unauthorized. Possible reasons: invalid API key or signature.

invalidApiKey
{
  "code": "1803",
  "message": "Integration with the API key '6ee9e344-20a6-439d-bf21-b6610db63ad6' was not found."
}
object

Generic error response structure.

code
string

A machine-readable error code indicating the type of error.

message
string

A human-readable message explaining the error.

429

Too Many Requests. Rate limit exceeded.

rateLimitExceeded
{
  "code": "RATE_LIMIT_EXCEEDED",
  "message": "Limit exceeded: 1000 per minute"
}
object

Generic error response structure.

code
string

A machine-readable error code indicating the type of error.

message
string

A human-readable message explaining the error.

500

Internal Server Error. An unexpected error occurred.

internalServerError
{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "An unexpected error occurred."
}
object

Generic error response structure.

code
string

A machine-readable error code indicating the type of error.

message
string

A human-readable message explaining the error.