Verify Document

POST /liveness/verify-document

POST https://api.prod.verisoul.ai/liveness/verify-document

Headers

Name	Type	Description
x-api-key*	string	authorization token

Request Body

Name	Type	Description
session_id*	string	secure session token

For detailed explanations on decision, risk_score and signals see Verify and Enroll page.

Verisoul frequently adds new scores, data and intelligence to our API endpoints. However, we will not remove existing fields without advance warning.

200 Success

{
    "metadata": {
        "project_id": "00000000-0000-0000-0000-000000000001",
        "session_id": "000d1d87-0538-415b-bfda-557b281e73cf",
        "referring_session_id": null,
        "request_id": "59d3d49e-9fed-4163-bcbe-9d935b4de9c7",
        "timestamp": "2024-10-13T19:25:49.491Z"
    },
    "decision": "Fake",
    "risk_score": 100,
    "risk_flags": [
        "moderate_ip_velocity",
        "repeat_face",
        "repeat_id"
    ],
    "document_signals": {
        "id_age": 30,
        "face_age_estimate": "over30",
        "id_face_match_score": 100,
        "id_barcode_status": "no_barcode_specified_by_template",
        "id_face_status": "likely_original_face",
        "id_text_status": "likely_original_text",
        "is_id_digital_spoof": "likely_physical_id",
        "is_full_id_captured": "full_id_detected",
        "id_validity": "likely_authentic_id"
    },
    "device_network_signals": {
        "ip_document_country_mismatch": false,
        "device_risk": false,
        "proxy": false,
        "vpn": false,
        "datacenter": false,
        "tor": false,
        "spoofed_ip": false,
        "recent_fraud_ip": false,
        "device_network_mismatch": false
    },
    "referring_session_signals": {
        "impossible_travel": false,
        "ip_mismatch": false,
        "user_agent_mismatch": false
    },
    "document_data": {
        "template_info": {
            "document_country_code": "US",
            "document_country": "United States of America",
            "document_state": null,
            "template_type": "passport"
        },
        "user_data": {
            "first_name": "Mike",
            "last_name": "Williams",
            "date_of_birth": "1994-03-16",
            "date_of_expiration": "2034-01-15",
            "date_of_issue": "2024-01-16",
            "id_number": "A01234567",
            "id_number2": null,
            "address": null
        },
        "photo_urls": {
            "face": "https://storage.googleapis.com/facematch-prod/000d1d87-0538-415b-bfda-557b281e73cf/face.jpg?X-Goog-Algorithm=GOOG4-RSA-SHA256...",
            "id_scan_front": "https://storage.googleapis.com/facematch-prod/000d1d87-0538-415b-bfda-557b281e73cf/id_scan_front.jpg?X-Goog-Algorithm=GOOG4-RSA-SHA256..."
        }
    },
    "session_data": {
        "network": {
            "ip_address": "104.28.97.27",
            "service_provider": "AT&T Corp.",
            "connection_type": "isp"
        },
        "location": {
            "continent": "NA",
            "country_code": "US",
            "state": "Texas",
            "city": "Austin",
            "zip_code": "78799",
            "timezone": "America/Chicago",
            "latitude": 30.2672,
            "longitude": -97.7431
        },
        "browser": {
            "type": "Chrome",
            "version": "128.0.0.0",
            "language": "en-US",
            "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/128.0.0.0 Safari/537.36"
        },
        "device": {
            "category": "desktop",
            "type": "Mac",
            "os": "macOS",
            "cpu_cores": 12,
            "memory": 8,
            "gpu": "Apple, ANGLE Metal Renderer: Apple M2 Pro, Unspecified Version"
        }
    },
    "matches": {
        "num_accounts_linked": 1,
        "accounts_linked": [
            {
                "account_id": "[e-mail]",
                "match_types": [
                    "face",
                    "document_name"
                ]
            }
        ]
    }
}

200 ID Scan Failed

{
    "request_id": "d1cd4a64-1d27-44f4-842f-baf10dd077b5",
    "success": false,
    "error": "Session is complete but ID can failed."
}

200 Incomplete session

{
    "request_id": "ed08dacf-a476-4488-bfc9-567715c035f6",
    "success": false,
    "error": "Session is started but not complete."
}

401 Unauthorized

{
    "message": "Invalid API Key",
    "error": "Unauthorized",
    "statusCode": 401
}