Global Document Verification

Global Document Verification service processes identity documents, extracting information and performing checks such as image quality, document type, data integrity, document validity, and authenticity points, to ensure truthfulness and quality.

Section: globalDocVerification

Required parameter: files (any document images)

Fields and rules

Check out the examples, rules, and attributes for the service to function.

Schema

Attribute	Type	Description
data	object	Object containing the main data.
data.documentCategory	string	Document category.
data.documentType	string	Document type and version.
data.documentNumber	string	Document number.
data.name	string	Holder's full name.
data.sex	string	Holder's sex.
data.birthDate	string	Holder's birth date.
data.birthPlace	string	Holder's place of birth.
data.nationality	string	Holder's nationality.
data.nationalityCode	string	Holder's nationality code.
data.address	string	Holder's complete address.
data.issueState	string	Document issuing state or country.
data.issueStateCode	string	Issuing state/country code (ISO 3166-1 alpha-3).
data.authority	string	Document issuing authority.
data.issueDate	string	Document issue date.
data.expirationDate	string	Document expiration date.
data.validations.overallStatus	Status	Overall validations status.
data.validations.authenticityCheck	object	Document authenticity checks.
data.validations.authenticityCheck.status	Status	Overall authenticity check status.
data.validations.authenticityCheck.{documentSide}	object	Results of authenticity checks performed on each document side. {documentSide} can be front or back.
data.validations.authenticityCheck.{documentSide}.result	Status	Overall authenticity check status for the corresponding image.
data.validations.authenticityCheck.{documentSide}.imagePattern.result	Status	Status of the presence/absence verification of image patterns.
data.validations.authenticityCheck.{documentSide}.photoEmbedType.result	Status	Status of the embedded photo verification.
data.validations.authenticityCheck.{documentSide}.barcodeFormatCheck.result	Status	Status of the barcode format verification.
data.validations.documentType	object	Document type checks .
data.validations.documentType.validityStatus	Status	Document type check status.
data.validations.textFieldsCheck	object	Document text fields checks.
data.validations.textFieldsCheck.status	Status	Overall text fields check status (cross-comparison of different sources, dates and check digits verification).
data.validations.textFieldsCheck.mrz	Status	MRZ integrity verification status.
data.validations.textFieldsCheck.documentExpiry.result	Status	Document expiry verification status.
data.validations.imageQualityCheck	object	Image quality checks.
data.validations.imageQualityCheck.status	Status	Overall image quality verification status.
data.validations.imageQualityCheck.{documentSide}	object	Results of image quality checks performed on each document side. {documentSide} can be front or back.
data.validations.imageQualityCheck.{documentSide}.result	Status	Overall image quality check status for the corresponding image.
data.validations.imageQualityCheck.{documentSide}.imageColorness	Status	Indicates if the image is colorless.
data.validations.imageQualityCheck.{documentSide}.imageFocus	Status	Indicates whether the image is in focus.
data.validations.imageQualityCheck.{documentSide}.bounds	Status	Indicates if the document is not fully present in the image.
data.validations.imageQualityCheck.{documentSide}.imageGlares	Status	Indicates the presence of glare on the image.
data.validations.imageQualityCheck.{documentSide}.perspective	Status	Indicates if the document in the image has perspective distortion above threshold.
data.validations.imageQualityCheck.{documentSide}.portrait	Status	Indicates if the portrait is present.
data.validations.imageQualityCheck.{documentSide}.imageResolution	Status	Indicates if the image resolution is below the threshold.
statusCode	string	Refers to the status of this specific query, not the entire transaction. Check our status guide

Example

{
    "data": {
        "documentCategory": "DRIVER_LICENSE",
        "documentType": "United Kingdom - Driver License (2021) #1",
        "documentNumber": "XXXXXXXXXXXXXXXX",
        "name": "JANE DOE",
        "sex": "F",
        "birthDate": "11/05/1993",
        "birthPlace": "UNITED KINGDOM",
        "nationality": "UNITED KINGDOM",
        "nationalityCode": "GBR",
        "address": "14 Meadow Lane, Nottingham, NGX XHQ",
        "issueState": "UNITED KINGDOM",
        "issueStateCode": "GBR",
        "authority": "DVLA",
        "issueDate": "01/04/2022",
        "expirationDate": "01/04/2032",
        "validations": {
            "overallStatus": 1,
            "authenticityCheck": {
                "status": 1,
                "back": {
                    "result": 1,
                    "imagePattern": {
                        "result": 1,
                    }
                },
                "front": {
                    "result": 1,
                    "imagePattern": {
                        "result": 1,
                    },
                    "photoEmbedType": {
                        "result": 1,
                    }
                }
            },
            "documentType": {
                "validityStatus": 1
            },
            "textFieldsCheck": {
                "status": 1,
                "mrz": 2,
                "documentExpiry": {
                    "result": 1,
                }
            },
            "imageQualityCheck": {
                "status": 1,
                "back": {
                    "result": 1,
                    "imageColorness": 2,
                    "imageFocus": 1,
                    "screenCapture": 2,
                    "bounds": 1,
                    "imageGlares": 1,
                    "perspective": 1,
                    "portrait": 2,
                    "imageResolution": 1
                },
                "front": {
                    "result": 1,
                    "imageColorness": 2,
                    "imageFocus": 1,
                    "screenCapture": 2,
                    "bounds": 1,
                    "imageGlares": 0,
                    "perspective": 1,
                    "portrait": 1,
                    "imageResolution": 1
                }
            }
        }
    },
    "statusCode": "01"
}

Validations Rules

Rule	Description
Validate document fields	Indicates whether all fields extracted from the document are valid.
Validate document authenticity	Indicates whether all verified authenticity points are valid.

The date format used is dd/MM/yyyy.

• dd = two-digit day

• MM = two-digit month

• yyyy = four-digit year

Returned and undocumented fields are for internal use only.

Status

When the document verification service is used, some statuses regarding what was analyzed may be returned:

Value	Description
0	Check was performed and result is negative.
1	Check was performed and result is positive.
2	Check was not performed.