Skip to main content
POST
Analyze a file for fraud detection

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