Skip to main content
POST
/
v1
/
verification
Verify user with their ID and selfie
curl --request POST \
  --url https://api.deepxl.ai/v1/verification \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form idFile='@example-file' \
  --form selfieFile='@example-file' \
  --form 'tags={}'
{
  "result": {
    "verificationId": 457,
    "idFileType": "jpeg",
    "idFileName": "passport.jpg",
    "idFileSize": 234567,
    "selfieFileType": "jpeg",
    "selfieFileName": "live_selfie.jpg",
    "selfieFileSize": 112233,
    "model": "verification",
    "verified": true,
    "modelResults": {
      "technicalChecks": [
        {
          "type": "FACE_MATCH",
          "status": "PASS",
          "confidence": 0.97,
          "details": "Face match confidence: 97%"
        },
        {
          "type": "LIVENESS",
          "status": "PASS",
          "confidence": 0.99,
          "details": "Liveness check passed"
        },
        {
          "type": "ID_QUALITY",
          "status": "PASS",
          "confidence": 0.92,
          "details": "ID document quality is acceptable"
        }
      ]
    },
    "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": "id",
        "fileName": "passport.jpg",
        "fileSize": 234567,
        "contentType": "image/jpeg",
        "timestamp": 1725795600,
        "timestampISO": "2024-09-08T10:00:00.000000",
        "url": "https://api.deepxl.ai/v1/files/v_id_457_passport.jpg"
      },
      {
        "category": "face",
        "fileName": "live_selfie.jpg",
        "fileSize": 112233,
        "contentType": "image/jpeg",
        "timestamp": 1725795600,
        "timestampISO": "2024-09-08T10:00:00.000000",
        "url": "https://api.deepxl.ai/v1/files/v_face_457_live_selfie.jpg"
      }
    ]
  }
}

Authorizations

Authorization
string
header
required

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

Body

multipart/form-data
idFile
file
required
selfieFile
file
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.

Response

Verification completed successfully

result
Verification · object
required

The verification result