Skip to main content
GET
/
v1
/
verification
List verification history
curl --request GET \
  --url https://api.deepxl.ai/v1/verification \
  --header 'x-api-key: <api-key>'
{
  "totalCount": 89,
  "count": 1,
  "data": [
    {
      "verificationId": 456,
      "idFileType": "jpeg",
      "idFileName": "drivers_license.jpg",
      "idFileSize": 156789,
      "selfieFileType": "jpeg",
      "selfieFileName": "selfie.jpg",
      "selfieFileSize": 89012,
      "model": "verification",
      "country": "us",
      "verified": true,
      "modelResults": {
        "technicalChecks": [
          {
            "type": "FACE_MATCH",
            "status": "PASS",
            "confidence": 0.95,
            "details": "Face match confidence: 95%"
          },
          {
            "type": "LIVENESS",
            "status": "PASS",
            "confidence": 0.98,
            "details": "Liveness check passed"
          }
        ]
      },
      "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": "drivers_license.jpg",
          "fileSize": 156789,
          "contentType": "image/jpeg",
          "timestamp": 1725795600,
          "timestampISO": "2024-09-08T10:00:00.000000",
          "url": "https://api.deepxl.ai/v1/files/v_id_456_drivers_license.jpg"
        },
        {
          "category": "face",
          "fileName": "selfie.jpg",
          "fileSize": 89012,
          "contentType": "image/jpeg",
          "timestamp": 1725795600,
          "timestampISO": "2024-09-08T10:00:00.000000",
          "url": "https://api.deepxl.ai/v1/files/v_face_456_selfie.jpg"
        }
      ]
    }
  ]
}

Authorizations

​
x-api-key
string
header
required

API key created in the dashboard

Query Parameters

​
limit
integer
default:25
Required range: 1 <= x <= 100
​
offset
integer
default:0
Required range: x >= 0
​
sortBy
string
default:verificationId
​
direction
string
default:desc
​
tagFilter
string
default:""
​
idFileName
string | null
​
idFileType
string | null
​
selfieFileName
string | null
​
selfieFileType
string | null
​
minIdFileSize
integer | null
Required range: x >= 0
​
maxIdFileSize
integer | null
Required range: x >= 0
​
minSelfieFileSize
integer | null
Required range: x >= 0
​
maxSelfieFileSize
integer | null
Required range: x >= 0
​
verified
boolean | null
​
minTimestamp
integer | null
Required range: 0 <= x <= 2147483647
​
maxTimestamp
integer | null
Required range: 0 <= x <= 2147483647

Response

Verification history retrieved successfully

​
totalCount
integer
required

Total number of records matching the query

​
count
integer
required

Number of records returned in this page

​
data
Verification · object[]
required

List of verification records