Create verification
curl --request POST \
--url https://api.txcloud.io/v1/identity/verify \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"document_front": "aSDinaTvuI8gbWludGxpZnk=",
"country": "MA",
"document_back": "aSDinaTvuI8gbWludGxpZnk=",
"selfie": "aSDinaTvuI8gbWludGxpZnk=",
"checks": [
"ocr",
"face_match",
"liveness",
"fraud"
],
"mode": "sync",
"webhook_url": "<string>",
"metadata": {}
}
'import requests
url = "https://api.txcloud.io/v1/identity/verify"
payload = {
"document_front": "aSDinaTvuI8gbWludGxpZnk=",
"country": "MA",
"document_back": "aSDinaTvuI8gbWludGxpZnk=",
"selfie": "aSDinaTvuI8gbWludGxpZnk=",
"checks": ["ocr", "face_match", "liveness", "fraud"],
"mode": "sync",
"webhook_url": "<string>",
"metadata": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
document_front: 'aSDinaTvuI8gbWludGxpZnk=',
country: 'MA',
document_back: 'aSDinaTvuI8gbWludGxpZnk=',
selfie: 'aSDinaTvuI8gbWludGxpZnk=',
checks: ['ocr', 'face_match', 'liveness', 'fraud'],
mode: 'sync',
webhook_url: '<string>',
metadata: {}
})
};
fetch('https://api.txcloud.io/v1/identity/verify', 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.txcloud.io/v1/identity/verify",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'document_front' => 'aSDinaTvuI8gbWludGxpZnk=',
'country' => 'MA',
'document_back' => 'aSDinaTvuI8gbWludGxpZnk=',
'selfie' => 'aSDinaTvuI8gbWludGxpZnk=',
'checks' => [
'ocr',
'face_match',
'liveness',
'fraud'
],
'mode' => 'sync',
'webhook_url' => '<string>',
'metadata' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.txcloud.io/v1/identity/verify"
payload := strings.NewReader("{\n \"document_front\": \"aSDinaTvuI8gbWludGxpZnk=\",\n \"country\": \"MA\",\n \"document_back\": \"aSDinaTvuI8gbWludGxpZnk=\",\n \"selfie\": \"aSDinaTvuI8gbWludGxpZnk=\",\n \"checks\": [\n \"ocr\",\n \"face_match\",\n \"liveness\",\n \"fraud\"\n ],\n \"mode\": \"sync\",\n \"webhook_url\": \"<string>\",\n \"metadata\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
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.txcloud.io/v1/identity/verify")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"document_front\": \"aSDinaTvuI8gbWludGxpZnk=\",\n \"country\": \"MA\",\n \"document_back\": \"aSDinaTvuI8gbWludGxpZnk=\",\n \"selfie\": \"aSDinaTvuI8gbWludGxpZnk=\",\n \"checks\": [\n \"ocr\",\n \"face_match\",\n \"liveness\",\n \"fraud\"\n ],\n \"mode\": \"sync\",\n \"webhook_url\": \"<string>\",\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.txcloud.io/v1/identity/verify")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"document_front\": \"aSDinaTvuI8gbWludGxpZnk=\",\n \"country\": \"MA\",\n \"document_back\": \"aSDinaTvuI8gbWludGxpZnk=\",\n \"selfie\": \"aSDinaTvuI8gbWludGxpZnk=\",\n \"checks\": [\n \"ocr\",\n \"face_match\",\n \"liveness\",\n \"fraud\"\n ],\n \"mode\": \"sync\",\n \"webhook_url\": \"<string>\",\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "ver_a1b2c3d4e5f6",
"object": "identity.verification",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"status": "pending",
"document_type": "<string>",
"country": "<string>",
"extracted_data": {
"document_number": "AE123456",
"first_name": "Mohammed",
"last_name": "El Amrani",
"first_name_arabic": "<string>",
"last_name_arabic": "<string>",
"date_of_birth": "2023-12-25",
"gender": "M",
"nationality": "<string>",
"issue_date": "2023-12-25",
"expiry_date": "2023-12-25",
"address": "<string>",
"place_of_birth": "<string>",
"mrz": "<string>",
"field_confidences": {}
},
"checks": {
"ocr": {
"status": "passed",
"confidence": 0.5
},
"face_match": {
"status": "passed",
"confidence": 0.5,
"similarity_score": 123,
"threshold": 123
},
"liveness": {
"status": "passed",
"confidence": 0.5,
"is_live": true,
"spoof_probability": 123
},
"fraud": {
"status": "passed",
"confidence": 0.5,
"tampering_detected": true,
"signals": [
"<string>"
]
},
"duplicate": {
"status": "passed",
"confidence": 0.5
}
},
"risk_score": 500,
"risk_level": "low",
"fraud_signals": [
{
"code": "<string>",
"severity": "low",
"message": "<string>"
}
],
"metadata": {}
}{
"id": "<string>",
"object": "identity.verification",
"status": "pending",
"created_at": "2023-11-07T05:31:56Z"
}{
"error": {
"code": "<string>",
"message": "<string>",
"type": "<string>"
}
}{
"error": {}
}{
"error": {}
}{
"error": {}
}Verification
Create verification
Performs a full identity verification including document OCR, face matching, liveness detection, and fraud checks.
Checks Available:
ocr- Extract data from documentface_match- Compare selfie to document photoliveness- Detect if selfie is a live personfraud- Check for document tamperingduplicate- Check for duplicate submissions
Processing Modes:
sync- Wait for results (default, up to 30s)async- Return immediately, results via webhook
POST
/
identity
/
verify
Create verification
curl --request POST \
--url https://api.txcloud.io/v1/identity/verify \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"document_front": "aSDinaTvuI8gbWludGxpZnk=",
"country": "MA",
"document_back": "aSDinaTvuI8gbWludGxpZnk=",
"selfie": "aSDinaTvuI8gbWludGxpZnk=",
"checks": [
"ocr",
"face_match",
"liveness",
"fraud"
],
"mode": "sync",
"webhook_url": "<string>",
"metadata": {}
}
'import requests
url = "https://api.txcloud.io/v1/identity/verify"
payload = {
"document_front": "aSDinaTvuI8gbWludGxpZnk=",
"country": "MA",
"document_back": "aSDinaTvuI8gbWludGxpZnk=",
"selfie": "aSDinaTvuI8gbWludGxpZnk=",
"checks": ["ocr", "face_match", "liveness", "fraud"],
"mode": "sync",
"webhook_url": "<string>",
"metadata": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
document_front: 'aSDinaTvuI8gbWludGxpZnk=',
country: 'MA',
document_back: 'aSDinaTvuI8gbWludGxpZnk=',
selfie: 'aSDinaTvuI8gbWludGxpZnk=',
checks: ['ocr', 'face_match', 'liveness', 'fraud'],
mode: 'sync',
webhook_url: '<string>',
metadata: {}
})
};
fetch('https://api.txcloud.io/v1/identity/verify', 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.txcloud.io/v1/identity/verify",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'document_front' => 'aSDinaTvuI8gbWludGxpZnk=',
'country' => 'MA',
'document_back' => 'aSDinaTvuI8gbWludGxpZnk=',
'selfie' => 'aSDinaTvuI8gbWludGxpZnk=',
'checks' => [
'ocr',
'face_match',
'liveness',
'fraud'
],
'mode' => 'sync',
'webhook_url' => '<string>',
'metadata' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.txcloud.io/v1/identity/verify"
payload := strings.NewReader("{\n \"document_front\": \"aSDinaTvuI8gbWludGxpZnk=\",\n \"country\": \"MA\",\n \"document_back\": \"aSDinaTvuI8gbWludGxpZnk=\",\n \"selfie\": \"aSDinaTvuI8gbWludGxpZnk=\",\n \"checks\": [\n \"ocr\",\n \"face_match\",\n \"liveness\",\n \"fraud\"\n ],\n \"mode\": \"sync\",\n \"webhook_url\": \"<string>\",\n \"metadata\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
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.txcloud.io/v1/identity/verify")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"document_front\": \"aSDinaTvuI8gbWludGxpZnk=\",\n \"country\": \"MA\",\n \"document_back\": \"aSDinaTvuI8gbWludGxpZnk=\",\n \"selfie\": \"aSDinaTvuI8gbWludGxpZnk=\",\n \"checks\": [\n \"ocr\",\n \"face_match\",\n \"liveness\",\n \"fraud\"\n ],\n \"mode\": \"sync\",\n \"webhook_url\": \"<string>\",\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.txcloud.io/v1/identity/verify")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"document_front\": \"aSDinaTvuI8gbWludGxpZnk=\",\n \"country\": \"MA\",\n \"document_back\": \"aSDinaTvuI8gbWludGxpZnk=\",\n \"selfie\": \"aSDinaTvuI8gbWludGxpZnk=\",\n \"checks\": [\n \"ocr\",\n \"face_match\",\n \"liveness\",\n \"fraud\"\n ],\n \"mode\": \"sync\",\n \"webhook_url\": \"<string>\",\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "ver_a1b2c3d4e5f6",
"object": "identity.verification",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"status": "pending",
"document_type": "<string>",
"country": "<string>",
"extracted_data": {
"document_number": "AE123456",
"first_name": "Mohammed",
"last_name": "El Amrani",
"first_name_arabic": "<string>",
"last_name_arabic": "<string>",
"date_of_birth": "2023-12-25",
"gender": "M",
"nationality": "<string>",
"issue_date": "2023-12-25",
"expiry_date": "2023-12-25",
"address": "<string>",
"place_of_birth": "<string>",
"mrz": "<string>",
"field_confidences": {}
},
"checks": {
"ocr": {
"status": "passed",
"confidence": 0.5
},
"face_match": {
"status": "passed",
"confidence": 0.5,
"similarity_score": 123,
"threshold": 123
},
"liveness": {
"status": "passed",
"confidence": 0.5,
"is_live": true,
"spoof_probability": 123
},
"fraud": {
"status": "passed",
"confidence": 0.5,
"tampering_detected": true,
"signals": [
"<string>"
]
},
"duplicate": {
"status": "passed",
"confidence": 0.5
}
},
"risk_score": 500,
"risk_level": "low",
"fraud_signals": [
{
"code": "<string>",
"severity": "low",
"message": "<string>"
}
],
"metadata": {}
}{
"id": "<string>",
"object": "identity.verification",
"status": "pending",
"created_at": "2023-11-07T05:31:56Z"
}{
"error": {
"code": "<string>",
"message": "<string>",
"type": "<string>"
}
}{
"error": {}
}{
"error": {}
}{
"error": {}
}Authorizations
API key as Bearer token
Body
application/jsonmultipart/form-data
Base64 encoded front of document
Available options:
cin, cni, passport, permit, residence_card Pattern:
^[A-Z]{2}$Example:
"MA"
Base64 encoded back of document
Base64 encoded selfie image
Available options:
ocr, face_match, liveness, fraud, duplicate Available options:
sync, async Webhook URL for async results
Custom metadata
Response
Verification completed (sync mode)
Example:
"ver_a1b2c3d4e5f6"
Available options:
identity.verification Available options:
pending, verified, rejected, review, expired, error Show child attributes
Show child attributes
Show child attributes
Show child attributes
Required range:
0 <= x <= 1000Available options:
low, medium, high, critical Show child attributes
Show child attributes