Global Document Verification 2

This endpoint allows users verify their documents using our SDK.

Upon calling the endpoint, users will receive a verification link. Opening this link will direct them to the SDK for verification. After completing verification, they must save the reference number found in the link. Copying and storing this reference is essential.

Test data:

{
"custom_name": "Olamide",
"redirect_url": "https://api.prembly.com/",
"reference": "038292hdgogs832"
}

Request Header

Request URL

📘

Post: https://api.prembly.com/identitypass/verification/global/document-check-v2

Request Body for Request URL

Sample Response For Post Request

{
    "status": true,
    "detail": "Verification Successful",
    "response_code": "00",
    "data": {
        "verification_link": "https://example.com/abcdefghijklmnopqr"
    },
    "verification": {
        "status": "VERIFIED",
        "reference": "31c0012-0f0a-40b6-b29f-d923dbfc82"
    },
    "widget_info": {},
    "session": {},
    "endpoint_name": "Document Verification V2"
}

Response URL

Get: <https://api.prembly.com/identitypass/verification/global/document-check-v2-get-result>

Request Body for Response URL

Get Request

{
 
    "reference": "71a2e5-fec3-4af4-82b9-711c5505adf6"
}

Sample Response for Get Request

{
    "status": true,
    "detail": "Verification Successful",
    "response_code": "00",
    "data": {
        "activated_at": "2020-10-28T11:48:49.148Z",
        "closed_at": "2020-10-28T11:56:40.556Z",
        "created_at": "2020-10-28T11:47:56.507Z",
        "created_by": "API",
        "current_step": "SUBMITTED",
        "device_info": {
            "browser": "Safari 18.3.1",
            "country": "Nigeria",
            "geolocation": "0.0000000,0.0000000",
            "ip": "100.000.00.00",
            "ip_location": "3.00,0.0",
            "isp": "FISL",
            "os": "iPhone 18.3.2",
            "user_agent": "Mozilla/5.0 (iPhone; CPU iPhone OS 18_3_2 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/18.3.1 Mobile/15E148 Safari/604.1",
            "vpn": false
        },
        "documents": [
            {
                "asf_breakdown": {
                    "detail_check": "PASSED",
                    "document_integrity": "PASSED",
                    "image_composition": "PASSED",
                    "photo_check": "FLAGGED"
                },
                "asf_checked": true,
                "created_at": "2020-03-28T11:54:51.732Z",
                "document_id": "3475834h4y5873454",
                "document_index": 0,
                "extracted": {
                    "age_at_issue": "50",
                    "authority": "LAGOS",
                    "birth_date": "01/01/1975",
                    "birth_place": "LAGOS",
                    "class": "P",
                    "country": "Nigeria",
                    "country_code": "NGA",
                    "document_number": "00000000",
                    "document_type": "Passport",
                    "expiry_date": "10/01/2030",
                    "first_name": "JOHN",
                    "full_name": "JOHN DOE",
                    "gender": "M",
                    "given_name": "DOE",
                    "id_number": "A00000000",
                    "issue_date": "01/01/2025",
                    "last_name": "DOE",
                    "nationality": "NIGERIAN",
                    "years_since_issue": "1"
                },
                "identity_document_type": "PASSPORT",
                "ocr": true,
                "submitted_data": {
                    "address": {
                        "country": "NGA",
                        "full_address": "Ikeja Mall",
                        "post_code": "",
                        "state": "Lagos",
                        "street_address": "Another street at Ikeja",
                        "street_address_2": "",
                        "street_address_3": "",
                        "suburb": "Akure",
                        "was_validated": true
                    },
                    "card_access_number": null,
                    "country_code": "NGA",
                    "date_of_birth": "1975-01-01",
                    "date_of_expiry": "2030-01-10",
                    "document_number": "A00000000",
                    "document_type": "Passport",
                    "edited_fields": [
                        "address"
                    ],
                    "empty_fields": {
                        "middle_name": true
                    },
                    "first_name": "DOe",
                    "id_number": "12345678901",
                    "last_name": "Doe",
                    "middle_name": null,
                    "passport_number": "A00000000",
                    "tax_number": null
                },
                "updated_at": "2025-03-28T11:54:51.732Z",
                "face_photo": {
                    "url": "http://example.com/face-image-url",
                    "size": 5680,
                    "content_type": "image/jpeg"
                },
                "front_document": {
                    "url": "http://example.com/face-image-url",
                    "size": 152656,
                    "content_type": "image/jpeg"
                },
                "original_front_document": {
                    "url": "http://example.com/face-image-url",
                    "size": 128032,
                    "content_type": "image/jpeg"
                },
                "signature_photo": {
                    "url": "http://example.com/face-image-url",
                    "size": 51216,
                    "content_type": "image/jpeg"
                },
                "mrz_data": {
                    "validation": "FALSE"
                }
            }
        ],
        "flow_type": "NORMAL2",
        "likeness_overall": "Fail",
        "liveness_attempts": [
            {
                "actions": [
                    "SMILE"
                ],
                "result": true,
                "session_id": "3a06eda0-556f-4e06-b682-98ae356f28c3",
                "video": {
                    "url": "http://example.com/face-video-url",
                    "size": 1511536,
                    "content_type": "video/webm"
                }
            }
        ],
        "name": "Olamide",
        "reference": "71c2a2e5-fec3-4af4-82b9-711c505adf6",
        "results": {
            "documents": "FLAGGED",
            "facematch": "FLAGGED",
            "liveness": "PASSED",
            "overall": "FLAGGED"
        },
        "spoof_result": "Low Risk",
        "status": "COMPLETE",
        "transaction_id": "HJSHGGD67376373JKS",
        "user_details": {
            "address": {
                "country": "NGA",
                "full_address": "Address at Ikeja",
                "post_code": "",
                "state": "Lagos",
                "street_address": "Ikeja",
                "street_address_2": "",
                "street_address_3": "",
                "suburb": "Ikeja",
                "was_validated": true
            },
            "card_access_number": null,
            "country_code": "NGA",
            "date_of_birth": "1975-01-01",
            "date_of_expiry": "2030-01-10",
            "document_number": "A00000000",
            "document_type": "Passport",
            "edited_fields": [
                "address"
            ],
            "empty_fields": {
                "middle_name": true
            },
            "first_name": "Jogn",
            "id_number": "12345678901",
            "last_name": "Doe",
            "middle_name": null,
            "passport_number": "A00000000",
            "tax_number": null
        },
        "facematch_best_frame": {
            "url": "http://example.com/face-image-url",
            "size": 56288,
            "content_type": "image/jpeg"
        },
        "default_language": "en-AU",
        "doc_only": false,
        "computed_statistics": {
            "steps": [
                {
                    "name": "PRIVACY",
                    "start_time": "2025-03-28T11:50:43.941Z",
                    "total_duration_seconds": 251
                },
                {
                    "name": "ID_INFORMATION",
                    "start_time": "2025-03-28T11:54:55.417Z",
                    "total_duration_seconds": 51
                },
                {
                    "name": "FACE_MATCH_CAPTURE",
                    "start_time": "2025-03-28T11:55:47.344Z",
                    "total_duration_seconds": 22
                },
                {
                    "name": "SUBMITTED",
                    "start_time": "2025-03-28T11:56:10.104Z",
                    "total_duration_seconds": 0
                }
            ],
            "total_duration_seconds": 324,
            "total_duration_excl_privacy_seconds": 73
        },
        "likeness_features": {
            "forehead": "Fail",
            "jaw": "Fail",
            "left_brow": "Fail",
            "left_cheek": "Fail",
            "left_eye": "Fail",
            "middle_forehead": "Fail",
            "mouth": "Fail",
            "nose": "Fail",
            "philtrum": "Fail",
            "right_brow": "Fail",
            "right_cheek": "Fail",
            "right_eye": "Fail"
        }
    },
    "service_provider": "prembly"
}