Skip to main content
GET
/
v1
/
detection
Get fraud detection history
curl --request GET \
  --url https://api.deepxl.ai/v1/detection \
  --header 'Authorization: Bearer <token>'
{
  "totalCount": 42,
  "count": 1,
  "data": [
    {
      "detectionId": 123,
      "mediaType": "image",
      "fileType": "jpeg",
      "fileName": "document.jpg",
      "fileSize": 231433,
      "model": "document",
      "likelihood": 15.5,
      "fraudSeverity": "low",
      "reasoning": [
        "Document structure appears authentic",
        "No manipulation detected"
      ],
      "modelResults": {
        "technicalChecks": [
          {
            "type": "DOCUMENT_STRUCTURE",
            "status": "PASS",
            "details": "Document structure is consistent"
          }
        ]
      },
      "classification": "authentic",
      "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": "document.jpg",
          "fileSize": 231433,
          "contentType": "image/jpeg",
          "timestamp": 1725795600,
          "timestampISO": "2024-09-08T10:00:00.000000",
          "url": "https://api.deepxl.ai/v1/files/fd_123_document.jpg"
        }
      ]
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

limit
integer
default:25
Required range: 1 <= x <= 100
offset
integer
default:0
Required range: x >= 0
sortBy
string
default:fraudDetectionId
direction
string
default:desc
tagFilter
string
default:""
mediaType
string | null
fileType
string | null
fileName
string | null
model
string | null
minLikelihood
number | null
Required range: 0 <= x <= 100
maxLikelihood
number | null
Required range: 0 <= x <= 100
fraudSeverity
string | null
classification
string | null
minTimestamp
integer | null
Required range: 0 <= x <= 2147483647
maxTimestamp
integer | null
Required range: 0 <= x <= 2147483647

Response

Fraud detection history retrieved successfully

totalCount
integer
required

Total number of records matching the query

count
integer
required

Number of records returned in this page

data
FraudDetection · object[]
required

List of fraud detection records