New: French documentation now available! Switch to French
curl --request POST \
--url https://api.txcloud.io/v1/identity/verify \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"document_front": "aSDinaTvuI8gbWludGxpZnk=",
"document_type": "cin",
"country": "MA",
"document_back": "aSDinaTvuI8gbWludGxpZnk=",
"selfie": "aSDinaTvuI8gbWludGxpZnk=",
"checks": [
"ocr",
"face_match",
"liveness",
"fraud"
],
"mode": "sync",
"webhook_url": "<string>",
"metadata": {}
}
'{
"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": {}
}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 submissionsProcessing Modes:
sync - Wait for results (default, up to 30s)async - Return immediately, results via webhookcurl --request POST \
--url https://api.txcloud.io/v1/identity/verify \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"document_front": "aSDinaTvuI8gbWludGxpZnk=",
"document_type": "cin",
"country": "MA",
"document_back": "aSDinaTvuI8gbWludGxpZnk=",
"selfie": "aSDinaTvuI8gbWludGxpZnk=",
"checks": [
"ocr",
"face_match",
"liveness",
"fraud"
],
"mode": "sync",
"webhook_url": "<string>",
"metadata": {}
}
'{
"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": {}
}Documentation Index
Fetch the complete documentation index at: https://docs.txcloud.thetekcircle.io/llms.txt
Use this file to discover all available pages before exploring further.
API key as Bearer token
Base64 encoded front of document
cin, cni, passport, permit, residence_card ^[A-Z]{2}$"MA"
Base64 encoded back of document
Base64 encoded selfie image
ocr, face_match, liveness, fraud, duplicate sync, async Webhook URL for async results
Custom metadata
Verification completed (sync mode)
"ver_a1b2c3d4e5f6"
identity.verification pending, verified, rejected, review, expired, error Show child attributes
Show child attributes
0 <= x <= 1000low, medium, high, critical Show child attributes