ID Intelligence Advance

Overview

Welcome to the Global ID Intelligence Advance API, a comprehensive solution engineered to revolutionize your data processing and verification needs. This advanced tool utilizes cutting-edge machine learning and image analysis technologies, enabling efficient extraction of data from various identity documents, sophisticated ID classification, detailed image quality analysis, precise face extraction and authenticity checks wherever applicable.

The primary aim of this API is to enhance the operational workflow within your organization. By automating complex tasks such as data extraction, document verification, and compliance assurance, the Document Intelligence API allows for a substantial reduction in manual effort, heightened accuracy, authenticity checks and robust security.

Importantly, the broad versatility of this API makes it an invaluable asset across various industries, from banking, healthcare, and insurance to real estate and government services. By integrating our API, these sectors can witness a significant improvement in operational efficiency, risk management, and decision-making processes.

API Details

API Endpoint

POST https://api.signzy.app/api/v3/vision/document-intellegence-advance

Headers

Name	Value	Required	Description
Content-Type	application/json	Yes	The type of content that the request body contains.
Authorization	XXXXXXXXXXX	Yes	An authentication token to authorize the request. Reach out to the Signzy support team to get one created.

Request Data

{
    "fontUrl": "https://persist.signzy.tech/api/files/790221639/download/f144f2a322ac4126977538cdfa4e9eb9cdef222445ee428fab869a743136f81d.jpg",
    "backUrl": "https://preproduction-persist.signzy.tech/api/files/37487415/download/e989d80855954a6893c0c345cced4cbf94a8b37a5d9a469a8e6d9986a4166912.jpg",
    "country": "United Arab Emirates",
    "idType": "Id Card"
}

Supported countries and their document type

Please click here

Request Body Parameters

Note: Either one of frontUrl or backURL needs to be passed while making the API call.

Parameter	Data type	Description	Required
fontUrl	String	A URL of the image. Acceptable image format TIFF/TIF, JPEG/JPG, PNG, PDF(maximum 1 pages)	Mandatory
backUrl	String	A URL of the image. Acceptable image format TIFF/TIF, JPEG/JPG, PNG, PDF(maximum 1 pages)	Mandatory
country	String	Name of the country	Mandatory
idType	String	Type of the id	Mandatory

Response Cases

// Success Response
{
    "results": {
        "completeStatus": {
            "detailsOptical": {
                "docType": "True",
                "expiry": "True",
                "imageQA": "False",
                "mrz": "None",
                "overallStatus": "False",
                "pagesCount": 2,
                "security": "False",
                "text": "True",
                "vds": "None"
            },
            "optical": "False",
            "overallStatus": "False",
            "portrait": "None",
            "rfid": "None"
        },
        "imageQuality": {
            "result": false,
            "frontIdCheck": {
                "ImageFocus": true,
                "ImageGlares": "NA",
                "Portrait": true,
                "Bounds": "NA",
                "Perspective": true,
                "ImageResolution": true
            },
            "backIdCheck": {
                "ImageFocus": true,
                "ImageGlares": "NA",
                "Portrait": false,
                "Bounds": "NA",
                "Perspective": true,
                "ImageResolution": true
            }
        },
        "authenticityCheck": {
            "frontAuthenticityCheckList": {
                "IMAGE_PATTERN": [
                    {
                        "ElementResult": true,
                        "ElementDiagnose": "PASS",
                        "ElementType": "BLANK",
                        "Image": "https://persist.sample.png",
                        "EtalonImage": "https://persist.sample.png"
                    },
                    {
                        "ElementResult": true,
                        "ElementDiagnose": "PASS",
                        "ElementType": "BLANK",
                        "Image": "https://persist.sample.png",
                        "EtalonImage": "https://persist.sample.png",
                    {
                        "ElementResult": true,
                        "ElementDiagnose": "PASS",
                        "ElementType": "BLANK",
                        "Image": "https://persist.sample.png",
                        "EtalonImage": "https://persist.sample.png"
                    }
                ],
                "photoEmbedType": [
                    {
                        "ElementResult": true,
                        "ElementDiagnose": "PASS",
                        "ElementType": "BLANK",
                        "Image": null,
                        "EtalonImage": null
                    },
                    {
                        "ElementResult": true,
                        "ElementDiagnose": "PASS",
                        "ElementType": "FACE_PRESENCE",
                        "Image": null,
                        "EtalonImage": null
                    }
                ]
            },
            "backAuthenticityCheckList": {
                "IMAGE_PATTERN": [
                    {
                        "ElementResult": false,
                        "ElementDiagnose": "FIXED_PATTERN_ERROR",
                        "ElementType": "BLANK",
                        "Image": "https://persist.sample.png",
                        "EtalonImage": "https://persist.sample.png"
                    }
                ]
            }
        },
        "extractedFields": {
            "remainderterm": "31",
            "documentNumber": "XXXXXX",
            "dateOfExpiry": "dd/mm/yyyy",
            "sex": "M",
            "names": "John DOe",
            "surnameAndGivenNames": "John Doe",
            "addressState": "Ontario",
            "issuingStateName": "Canada",
            "issuingStateCode": "CAN",
            "yearsSinceIssue": "2",
            "ageAtIssue": "50",
            "age": "52",
            "inventoryNumber": "XXXX",
            "height": "173 cm",
            "lastName": "Doe",
            "surname": "john",
            "dateOfBirth": "dd/mm/yyyy",
            "documentDiscriminator": "XXXX",
            "dlClass": "G",
            "dateOfIssue": "dd/mm/yyyy",
            "addressPostalCode": "M2K0B2",
            "addressJurisdictionCode": "ON",
            "addressCity": "NORTH YORK",
            "address": "XXXXXX",
            "firstName": "John",
            "givenNames": "Doe"
    },
        "predictedIdTypeFront": {
            "DocumentName": "Canada - Ontario Driving Licence (2012)",
            "FDSIDList": {
                "ICAOCode": "CAN",
                "dCountryName": "Canada",
                "dDescription": "Driving License",
                "dFormat": 0,
                "dMRZ": false,
                "dStateCode": "ON",
                "dStateName": "Ontario",
                "dType": 49,
                "dYear": "2012",
                "isDeprecated": false
            },
            "P": 0.8089022636413574
        },
        "predictedIdTypeBack": {
            "DocumentName": "Canada - Ontario Driving Licence (2012) Side B",
            "FDSIDList": {
                "ICAOCode": "CAN",
                "dCountryName": "Canada",
                "dDescription": "Driving License",
                "dFormat": 0,
                "dMRZ": false,
                "dStateCode": "ON",
                "dStateName": "Ontario",
                "dType": 49,
                "dYear": "2012",
                "isDeprecated": false
            },
            "P": 0.875654697418213
        },
        "graphicFields": {
            "fieldList": [
                {
                    "fieldType": "PORTRAIT",
                    "value": "https://persist.sample.png",
                    "source": "VISUAL",
                    "containerType": "VISUAL_GRAPHICS"
                },
                {
                    "fieldType": "SIGNATURE",
                    "value": "https://persist.sample.png",
                    "source": "VISUAL",
                    "containerType": "VISUAL_GRAPHICS"
                },
                {
                    "fieldType": "GHOST_PORTRAIT",
                    "value": "https://persist.sample.png",
                    "source": "VISUAL",
                    "containerType": "VISUAL_GRAPHICS"
                },
                {
                    "fieldType": "BAR_CODE",
                    "value": "https://persist.sample.png",
                    "source": "VISUAL",
                    "containerType": "VISUAL_GRAPHICS"
                },
                {
                    "fieldType": "CROPPED_DOCUMENT",
                    "value": "https://persist.sample.png",
                    "source": "VISUAL",
                    "containerType": "DOCUMENT_IMAGE"
                },
                {
                    "fieldType": "CROPPED_DOCUMENT",
                    "value": "https://persist.sample.png",
                    "source": "VISUAL",
                    "containerType": "DOCUMENT_IMAGE"
                }
            ]
        }
    }
}

Response Body Parameters

Output	Data Type	Description
completeStatus	object	Results of advanced checks on the ID document.
imageQuality	object	Assessment of the image quality.
authenticityCheck	object	Results of authenticity checks. More here
graphicFields	object	List of visual fields extracted from the ID. More here
predictedIdTypeFront	object	Predicted type of the ID based on the front image. More here
predictedIdTypeBack	object	Predicted type of the ID based on the back image. More here
extractedFields	object	Detailed fields extracted from the ID. This object contains all the different fields extracted from the ID Card given as input

advanceCheck

Parameter	Data Type	Description
completeStatus	Object	Contains detailed status of various document checks
authenticityCheck	Object	Provides results and descriptions of authenticity checks performed

completeStatus

This gives the overall authenticity output of the ID given as input

Parameter	Data Type	Description
detailsOptical	Object	Specific optical checks details
optical	Boolean	Indicates if overall optical check is passed
overallStatus	Boolean	General status across all checks
portrait	String	Status of portrait check, if applicable
rfid	String	Status of RFID chip reading check, if applicable
stopList	String	Status of stop list check, if applicable

detailsOptical

Parameter	Data Type
docType	Boolean
expiry	Boolean
imageQA	Boolean
mrz	Boolean
overallStatus	Boolean
pagesCount	Integer
security	Boolean
text	Boolean
vds	String

authenticityCheck

Parameter	Data Type	Description
result	Boolean	Result of the authenticity check
type	String	Description of the authenticity check performed

extractedFields

This object changes based on the id given as input.

Parameter	Data Type	Description
firstName	String	Extracted first name of the ID holder
lastName	String	Extracted last name of the ID holder
names	String	Full name as extracted from the document
address	String	Extracted address, if available
number	String	Document number
DOB	Date	Date of birth of the ID holder
issuingState	String	State or entity that issued the document
expiryDate	Date	Expiry date of the document
nationality	String	Nationality code extracted from the document
gender	String	Gender of the ID holder
additionalData	Object	Various additional data related to the document, varying based on the ID

imageQualityFront

Parameter	Data Type	Description
qualityScores	Object	Specific scores related to aspects of the image quality
score	Float	Overall score for the front image quality
summary	String	Summary status of the front image quality
msg	String	Additional message about the image quality
status	Integer	HTTP status code for the image quality request
imageQuality	String	Qualitative assessment of image quality (e.g., high, medium, low)
frontUrl	URL	URL to the front image of the document

imageQualityBack

Parameter	Data Type	Description
qualityScores	Object	Specific scores related to aspects of the image quality
score	Float	Overall score for the back image quality
summary	String	Summary status of the back image quality
msg	String	Additional message about the image quality
status	Integer	HTTP status code for the image quality request
imageQuality	String	Qualitative assessment of image quality (e.g., high, medium, low)
frontUrl	URL	URL to the front image of the document

General Information

Parameter	Data Type	Description
predictedIdTypeFront	String	Predicted type of ID from the front side
predictedIdTypeBack	String	Predicted type of ID from the back side, if applicable
idExpired	Boolean	Indicates if the ID has expired based on the data
faceUrl	URL	URL to the face image extracted from the document
imageQualityBack	Object	Details about the quality of the back image of the document, if applicable

Getting help

Please feel free to contact us if you have any questions, require clarification, or have ideas for how to make the documents or any of our services better.

You can reach out to us at [email protected]. We strive to provide prompt and reliable assistance, ensuring your queries are addressed effectively.

We value your feedback and are committed to making your experience smooth and enjoyable. Our team is dedicated to assisting you with any needs you may have. Thank you for choosing our services. We look forward to helping you!