Skip to main content
POST
/
v1
/
detection
Analyze a file for fraud detection
curl --request POST \
  --url https://api.deepxl.ai/v1/detection \
  --header 'Content-Type: multipart/form-data' \
  --header 'x-api-key: <api-key>' \
  --form 'model=<string>' \
  --form 'file=<string>' \
  --form 'tags={}' \
  --form 'country=<string>'
{
  "result": {
    "detectionId": 2,
    "mediaType": "image",
    "fileType": "jpeg",
    "fileName": "bank_statement.jpg",
    "fileSize": 245678,
    "model": "document",
    "likelihood": 85.2,
    "fraudSeverity": "high",
    "country": "us",
    "reasoning": [
      "Potential manipulation detected in text region",
      "Font inconsistencies found"
    ],
    "modelResults": {
      "technicalChecks": [
        {
          "type": "IMAGE_MANIPULATION",
          "status": "FAIL",
          "details": "Detected potential manipulation",
          "likelihood": 0.85
        }
      ]
    },
    "classification": "suspicious",
    "timestamp": 1725795600,
    "timestampISO": "2024-09-08T10:00:00.000000",
    "tags": [
      {
        "name": "customerId",
        "value": "9999"
      },
      {
        "name": "customerName",
        "value": "Acme Corp"
      },
      {
        "name": "documentId",
        "value": "DOC-2024-001"
      },
      {
        "name": "companyName",
        "value": "DeepXL"
      },
      {
        "name": "companyId",
        "value": "COMP-001"
      }
    ],
    "files": [
      {
        "category": "original_file",
        "fileName": "bank_statement.jpg",
        "fileSize": 245678,
        "contentType": "image/jpeg",
        "timestamp": 1725795600,
        "timestampISO": "2024-09-08T10:00:00.000000",
        "url": "https://api.deepxl.ai/v1/files/fd_2_bank_statement.jpg"
      },
      {
        "category": "heatmap",
        "fileName": "fd_2_heatmap_1.png",
        "fileSize": 45678,
        "contentType": "image/png",
        "timestamp": 1725795600,
        "timestampISO": "2024-09-08T10:00:00.000000",
        "url": "https://api.deepxl.ai/v1/files/fd_2_heatmap_1.png"
      }
    ]
  }
}

Authorizations

​
x-api-key
string
header
required

API key created in the dashboard

Body

multipart/form-data
​
model
string
required

Model to use for analysis; Available models: document, object

​
file
string
required
​
tags
string | null
default:{}

Optional JSON object with key-value pairs for organizing and querying results. Example: {"customerId":"9999","customerName":"Acme Corp","documentId":"DOC-2024-001","companyName":"DeepXL","companyId":"COMP-001"}. Common keys: customerId, customerName, documentId, companyName, companyId.

​
country
string | null

Optional country hint. Supported values: us, mx, br. Defaults to us when omitted or invalid.

Response

Analysis completed successfully

​
result
FraudDetection · object
required

The fraud detection result