Skip to main content
POST
/
v1
/
analysis
Analyze Document
curl --request POST \
  --url https://api.deepxl.ai/v1/analysis \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form 'model=<string>' \
  --form file='@example-file' \
  --form 'companyId=<string>' \
  --form 'companyName=<string>' \
  --form 'customerId=<string>' \
  --form 'customerName=<string>' \
  --form 'documentId=<string>'
{
  "result": {
    "analysisId": 456,
    "fileName": "passport.jpg",
    "size": 657421,
    "mediaType": "image",
    "fileType": "jpeg",
    "fileCreatedOn": 1725798857.356944,
    "model": "us-id-model",
    "timestamp": 1725798857.356944,
    "likelihood": 99.9,
    "reasoning": [
      "Image manipulation check detected potential tampering..."
    ],
    "classification": "verified",
    "fraudSeverity": "Confirmed Fraud",
    "modelVersion": "1.1.0",
    "heatmapBase64": "data:image/png;base64,iVBORw0KGgoAAAANS...",
    "modelResults": {
      "technicalChecks": [
        {
          "type": "DOCUMENT_CLASSIFIER",
          "status": "PASS",
          "details": "Document contains a photograph of a person...",
          "likelihood": 0.01
        },
        {
          "type": "IMAGE_MANIPULATION",
          "status": "FAIL",
          "details": "Potential image manipulation detected...",
          "likelihood": 0
        }
      ]
    }
  }
}

Authorizations

Authorization
string
header
required

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

Body

multipart/form-data
model
string
required

AI model to use for analysis. Available models: us-id-model, document-model, object-model

file
file
required
companyId
string | null

Optional company identifier for tracking

companyName
string | null

Optional company name for tracking

customerId
string | null

Optional customer identifier for tracking

customerName
string | null

Optional customer name for tracking

documentId
string | null

Optional document identifier for tracking

Response

Analysis completed successfully

result
AnalysisResponse · object
required