curl --request POST \
--url https://api.deepxl.ai/v1/verification \
--header 'Content-Type: multipart/form-data' \
--header 'x-api-key: <api-key>' \
--form 'idFile=<string>' \
--form 'selfieFile=<string>' \
--form 'tags={}' \
--form 'country=<string>'import requests
url = "https://api.deepxl.ai/v1/verification"
payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"idFile\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"selfieFile\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"tags\"\r\n\r\n{}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"country\"\r\n\r\n<string>\r\n-----011000010111000001101001--"
headers = {
"x-api-key": "<api-key>",
"Content-Type": "multipart/form-data"
}
response = requests.post(url, data=payload, headers=headers)
print(response.text)const form = new FormData();
form.append('idFile', '<string>');
form.append('selfieFile', '<string>');
form.append('tags', '{}');
form.append('country', '<string>');
const options = {method: 'POST', headers: {'x-api-key': '<api-key>'}};
options.body = form;
fetch('https://api.deepxl.ai/v1/verification', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.deepxl.ai/v1/verification",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"idFile\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"selfieFile\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"tags\"\r\n\r\n{}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"country\"\r\n\r\n<string>\r\n-----011000010111000001101001--",
CURLOPT_HTTPHEADER => [
"Content-Type: multipart/form-data",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.deepxl.ai/v1/verification"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"idFile\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"selfieFile\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"tags\"\r\n\r\n{}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"country\"\r\n\r\n<string>\r\n-----011000010111000001101001--")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.deepxl.ai/v1/verification")
.header("x-api-key", "<api-key>")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"idFile\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"selfieFile\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"tags\"\r\n\r\n{}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"country\"\r\n\r\n<string>\r\n-----011000010111000001101001--")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.deepxl.ai/v1/verification")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"idFile\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"selfieFile\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"tags\"\r\n\r\n{}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"country\"\r\n\r\n<string>\r\n-----011000010111000001101001--"
response = http.request(request)
puts response.read_body{
"result": {
"verificationId": 457,
"idFileType": "jpeg",
"idFileName": "passport.jpg",
"idFileSize": 234567,
"selfieFileType": "jpeg",
"selfieFileName": "live_selfie.jpg",
"selfieFileSize": 112233,
"model": "verification",
"country": "us",
"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"
}
]
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Verify user with their ID and selfie
Verify a user’s identity by uploading an ID document and a selfie.
The system compares the face in the ID with the selfie and performs liveness checks to ensure the person is real.
Required Files:
idFile- ID document image or PDF (driver license, passport, etc.)selfieFile- Selfie still image or selfie video (e.g. mp4, mov, webm), same field name for both
Tags Parameter: Pass optional metadata as a JSON object to organize and filter your verification results.
Recommended tag fields:
| Field | Description | Example |
|---|---|---|
customerId | Your customer’s unique identifier | "9999" |
customerName | Customer or account name | "Acme Corp" |
documentId | Your internal document reference | "DOC-2024-001" |
companyName | Company name | "DeepXL" |
companyId | Company identifier | "COMP-001" |
Example tags value: {"customerId":"9999","customerName":"Acme Corp","documentId":"DOC-2024-001","companyName":"DeepXL","companyId":"COMP-001"}
You can filter results by tags using the GET endpoint: ?tagFilter=customerId=9999
curl --request POST \
--url https://api.deepxl.ai/v1/verification \
--header 'Content-Type: multipart/form-data' \
--header 'x-api-key: <api-key>' \
--form 'idFile=<string>' \
--form 'selfieFile=<string>' \
--form 'tags={}' \
--form 'country=<string>'import requests
url = "https://api.deepxl.ai/v1/verification"
payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"idFile\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"selfieFile\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"tags\"\r\n\r\n{}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"country\"\r\n\r\n<string>\r\n-----011000010111000001101001--"
headers = {
"x-api-key": "<api-key>",
"Content-Type": "multipart/form-data"
}
response = requests.post(url, data=payload, headers=headers)
print(response.text)const form = new FormData();
form.append('idFile', '<string>');
form.append('selfieFile', '<string>');
form.append('tags', '{}');
form.append('country', '<string>');
const options = {method: 'POST', headers: {'x-api-key': '<api-key>'}};
options.body = form;
fetch('https://api.deepxl.ai/v1/verification', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.deepxl.ai/v1/verification",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"idFile\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"selfieFile\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"tags\"\r\n\r\n{}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"country\"\r\n\r\n<string>\r\n-----011000010111000001101001--",
CURLOPT_HTTPHEADER => [
"Content-Type: multipart/form-data",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.deepxl.ai/v1/verification"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"idFile\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"selfieFile\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"tags\"\r\n\r\n{}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"country\"\r\n\r\n<string>\r\n-----011000010111000001101001--")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.deepxl.ai/v1/verification")
.header("x-api-key", "<api-key>")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"idFile\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"selfieFile\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"tags\"\r\n\r\n{}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"country\"\r\n\r\n<string>\r\n-----011000010111000001101001--")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.deepxl.ai/v1/verification")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"idFile\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"selfieFile\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"tags\"\r\n\r\n{}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"country\"\r\n\r\n<string>\r\n-----011000010111000001101001--"
response = http.request(request)
puts response.read_body{
"result": {
"verificationId": 457,
"idFileType": "jpeg",
"idFileName": "passport.jpg",
"idFileSize": 234567,
"selfieFileType": "jpeg",
"selfieFileName": "live_selfie.jpg",
"selfieFileSize": 112233,
"model": "verification",
"country": "us",
"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"
}
]
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
API key created in the dashboard
Body
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.
Optional country hint. Supported values: us, mx, br. Defaults to us when omitted or invalid.
Response
Verification completed successfully
The verification result
Show child attributes
Show child attributes
Was this page helpful?