ID Intelligence

Introduction
Welcome to the Document Intelligence 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, and precise face extraction where 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, 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.
Please read more about functionalities in relevant pages as mentioned below :- 
﻿Data Extraction﻿﻿
﻿Face Extraction﻿﻿
﻿Image Quality Analysis﻿﻿
﻿ID Classification﻿﻿
Overall,  ID Intelligence offers a comprehensive solution for extracting data from ID cards, analyzing image quality, extracting faces. Its capabilities make it suitable for a wide range of applications, including identity verification, document processing, fraud detection, and compliance procedures.
API Details
API Endpoint
Production
Pre-Production
POST https://api.signzy.app/api/v3/vision/documentIntellegence
POST https://api.signzy.app/api/v3/vision/documentIntellegence
﻿
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
JSON
{
    "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",
    "performImageQualityAnalysis": true,
    "performIdClassification": true,
    "performIdExtraction": true,
    "performFaceExtraction": true,
    "imageQualityThreshold": 0.9
}
{
    "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",
    "performImageQualityAnalysis": true,
    "performIdClassification": true,
    "performIdExtraction": true,
    "performFaceExtraction": true,
    "imageQualityThreshold": 0.9
}
﻿
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
performImageQualityAnalysis
Boolean
Need to perform quality analysis or not
Optional
performIdClassification
Boolean
Need to perform id classification or not
Optional
performIdExtraction
Boolean
Need to perform id extraction or not
Optional
performFaceExtraction
Boolean
Need to perform face extraction or not
Optional
imageQualityThreshold
Float
Threshold value to set the minimum required criteria
Optional
Response Cases
200
401
422
400
409
// Success Response
{
  "results": {
    "predictedIddTypeBack": "Resident Id Card Side B",
    "idExpired": "True",
    "extractedFields": {
      "firstName": "<firstName?",
      "lastName": "<lastName?",
      "names": "<names?",
      "address": "<address?",
      "number": "<number?",
      "DOB": "<DOB>",
      "issuingState": "<issuingState>",
      "expiryDate": "<expiryDate>",
      "nationality": "<nationality>",
      "gender": "<gender>",
      "additionalData": {
	      // this object changes based on the id given
      }
    },
    "faceUrl": "",
    "imageQualityBack": {
      "qualityScores": {
        "textQuality": {
          "valid": "yes",
          "score": "1.0"
        },
        "brightness": {
          "valid": "yes",
          "score": "1.0"
        },
        "sharpness": {
          "valid": "yes",
          "score": "1.0"
        },
        "compressionQuality": {
          "valid": "no",
          "score": "0.71"
        }
      },
      "score": "0.71",
      "summary": "reject",
      "msg": "done",
      "status": "200",
      "imageQuality": "low"
    },
     "imageQualityFront": {
      "qualityScores": {
        "textQuality": {
          "valid": "yes",
          "score": "1.0"
        },
        "brightness": {
          "valid": "yes",
          "score": "1.0"
        },
        "sharpness": {
          "valid": "yes",
          "score": "1.0"
        },
        "compressionQuality": {
          "valid": "no",
          "score": "0.71"
        }
      },
      "score": "0.71",
      "summary": "reject",
      "msg": "done",
      "status": "200",
      "imageQuality": "low"
    }
  }
}
// Success Response
{
  "results": {
    "predictedIddTypeBack": "Resident Id Card Side B",
    "idExpired": "True",
    "extractedFields": {
      "firstName": "<firstName?",
      "lastName": "<lastName?",
      "names": "<names?",
      "address": "<address?",
      "number": "<number?",
      "DOB": "<DOB>",
      "issuingState": "<issuingState>",
      "expiryDate": "<expiryDate>",
      "nationality": "<nationality>",
      "gender": "<gender>",
      "additionalData": {
	      // this object changes based on the id given
      }
    },
    "faceUrl": "",
    "imageQualityBack": {
      "qualityScores": {
        "textQuality": {
          "valid": "yes",
          "score": "1.0"
        },
        "brightness": {
          "valid": "yes",
          "score": "1.0"
        },
        "sharpness": {
          "valid": "yes",
          "score": "1.0"
        },
        "compressionQuality": {
          "valid": "no",
          "score": "0.71"
        }
      },
      "score": "0.71",
      "summary": "reject",
      "msg": "done",
      "status": "200",
      "imageQuality": "low"
    },
     "imageQualityFront": {
      "qualityScores": {
        "textQuality": {
          "valid": "yes",
          "score": "1.0"
        },
        "brightness": {
          "valid": "yes",
          "score": "1.0"
        },
        "sharpness": {
          "valid": "yes",
          "score": "1.0"
        },
        "compressionQuality": {
          "valid": "no",
          "score": "0.71"
        }
      },
      "score": "0.71",
      "summary": "reject",
      "msg": "done",
      "status": "200",
      "imageQuality": "low"
    }
  }
}
﻿
Response Body Parameters
Output
Data Type
Description
predictedIdTypeFront
string
Predicted type of the ID document front side
predictedIdTypeBack
string
Predicted type of the ID document back side
idExpired
boolean
Indicates if the ID document is expired
faceUrl
string
URL to the extracted face image from the ID document
extractedFields Object
This object changes based on the id given as input
Output
Data Type
Description
firstName
string
First name extracted from the ID document
lastName
string
Last name extracted from the ID document
names
string
Full name extracted from the ID document
address
string
Address extracted from the ID document
number
string
Document number extracted from the ID document
DOB
string
Date of Birth extracted from the ID document (format: DD/MM/YYYY)
issuingState
string
Issuing state or country of the ID document
expiryDate
string
Expiry date of the ID document (format: DD/MM/YYYY)
nationality
string
Nationality of the person as per the ID document
gender
string
Gender of the person as per the ID document
additionalData Object 
Output
Data Type
Description
documentName
string
Name of the document type with country and year
dateOfExpiryCheckdigit
string
Check digit for the date of expiry
remainderterm
string
Remaining term of the document in years
age
string
Age of the document holder
finalCheckdigit
string
Final check digit of the MRZ
mrzStrings
string
MRZ (Machine Readable Zone) strings extracted from the ID document
dateOfBirthCheckdigit
string
Check digit for the date of birth
nationalityCode
string
Nationality code of the document holder
documentNumberCheckdigit
string
Check digit for the document number
documentClassCode
string
Document class code
optionalData
string
Optional data extracted from the ID document
optionalDataCheckdigit
string
Check digit for the optional data
mrzType
string
Type of MRZ (e.g., ID-3)
fullNationality
string
Nationality of the document holder in full text
dateOfIssue
string
Date of issue of the ID document (format: DD/MM/YYYY)
yearsSinceIssue
string
Number of years since the ID document was issued
imageQualityFront Object
Output
Data Type
Description
textQualityValid
string
Validity of text quality (yes/no) for the front side of the ID document
textQualityScore
string
Score of text quality for the front side of the ID document
brightnessValid
string
Validity of brightness (yes/no) for the front side of the ID document
brightnessScore
string
Score of brightness for the front side of the ID document
sharpnessValid
string
Validity of sharpness (yes/no) for the front side of the ID document
sharpnessScore
string
Score of sharpness for the front side of the ID document
compressionQualityValid
string
Validity of compression quality (yes/no) for the front side of the ID document
compressionQualityScore
string
Score of compression quality for the front side of the ID document
qualityScore
string
Overall quality score for the front side of the ID document
summary
string
Summary of the quality assessment for the front side of the ID document
msg
string
Message regarding the quality assessment for the front side of the ID document
status
string
Status code for the quality assessment of the front side of the ID document
imageQuality
string
Overall image quality for the front side of the ID document (e.g., high)
imageQualityBack Object
Output
Data Type
Description
textQualityValid
string
Validity of text quality (yes/no) for the back side of the ID document
textQualityScore
string
Score of text quality for the back side of the ID document
brightnessValid
string
Validity of brightness (yes/no) for the back side of the ID document
brightnessScore
string
Score of brightness for the back side of the ID document
sharpnessValid
string
Validity of sharpness (yes/no) for the back side of the ID document
sharpnessScore
string
Score of sharpness for the back side of the ID document
compressionQualityValid
string
Validity of compression quality (yes/no) for the back side of the ID document
compressionQualityScore
string
Score of compression quality for the back side of the ID document
qualityScore
string
Overall quality score for the back side of the ID document
summary
string
Summary of the quality assessment for the back side of the ID document
msg
string
Message regarding the quality assessment for the back side of the ID document
status
string
Status code for the quality assessment of the back side of the ID document
imageQuality
string
Overall image quality for the back side of the ID document (e.g., high)
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!
﻿

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.

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
performImageQualityAnalysis	Boolean	Need to perform quality analysis or not	Optional
performIdClassification	Boolean	Need to perform id classification or not	Optional
performIdExtraction	Boolean	Need to perform id extraction or not	Optional
performFaceExtraction	Boolean	Need to perform face extraction or not	Optional
imageQualityThreshold	Float	Threshold value to set the minimum required criteria	Optional

Output	Data Type	Description
predictedIdTypeFront	string	Predicted type of the ID document front side
predictedIdTypeBack	string	Predicted type of the ID document back side
idExpired	boolean	Indicates if the ID document is expired
faceUrl	string	URL to the extracted face image from the ID document

Output	Data Type	Description
firstName	string	First name extracted from the ID document
lastName	string	Last name extracted from the ID document
names	string	Full name extracted from the ID document
address	string	Address extracted from the ID document
number	string	Document number extracted from the ID document
DOB	string	Date of Birth extracted from the ID document (format: DD/MM/YYYY)
issuingState	string	Issuing state or country of the ID document
expiryDate	string	Expiry date of the ID document (format: DD/MM/YYYY)
nationality	string	Nationality of the person as per the ID document
gender	string	Gender of the person as per the ID document

Output	Data Type	Description
documentName	string	Name of the document type with country and year
dateOfExpiryCheckdigit	string	Check digit for the date of expiry
remainderterm	string	Remaining term of the document in years
age	string	Age of the document holder
finalCheckdigit	string	Final check digit of the MRZ
mrzStrings	string	MRZ (Machine Readable Zone) strings extracted from the ID document
dateOfBirthCheckdigit	string	Check digit for the date of birth
nationalityCode	string	Nationality code of the document holder
documentNumberCheckdigit	string	Check digit for the document number
documentClassCode	string	Document class code
optionalData	string	Optional data extracted from the ID document
optionalDataCheckdigit	string	Check digit for the optional data
mrzType	string	Type of MRZ (e.g., ID-3)
fullNationality	string	Nationality of the document holder in full text
dateOfIssue	string	Date of issue of the ID document (format: DD/MM/YYYY)
yearsSinceIssue	string	Number of years since the ID document was issued

Output	Data Type	Description
textQualityValid	string	Validity of text quality (yes/no) for the front side of the ID document
textQualityScore	string	Score of text quality for the front side of the ID document
brightnessValid	string	Validity of brightness (yes/no) for the front side of the ID document
brightnessScore	string	Score of brightness for the front side of the ID document
sharpnessValid	string	Validity of sharpness (yes/no) for the front side of the ID document
sharpnessScore	string	Score of sharpness for the front side of the ID document
compressionQualityValid	string	Validity of compression quality (yes/no) for the front side of the ID document
compressionQualityScore	string	Score of compression quality for the front side of the ID document
qualityScore	string	Overall quality score for the front side of the ID document
summary	string	Summary of the quality assessment for the front side of the ID document
msg	string	Message regarding the quality assessment for the front side of the ID document
status	string	Status code for the quality assessment of the front side of the ID document
imageQuality	string	Overall image quality for the front side of the ID document (e.g., high)

Output	Data Type	Description
textQualityValid	string	Validity of text quality (yes/no) for the back side of the ID document
textQualityScore	string	Score of text quality for the back side of the ID document
brightnessValid	string	Validity of brightness (yes/no) for the back side of the ID document
brightnessScore	string	Score of brightness for the back side of the ID document
sharpnessValid	string	Validity of sharpness (yes/no) for the back side of the ID document
sharpnessScore	string	Score of sharpness for the back side of the ID document
compressionQualityValid	string	Validity of compression quality (yes/no) for the back side of the ID document
compressionQualityScore	string	Score of compression quality for the back side of the ID document
qualityScore	string	Overall quality score for the back side of the ID document
summary	string	Summary of the quality assessment for the back side of the ID document
msg	string	Message regarding the quality assessment for the back side of the ID document
status	string	Status code for the quality assessment of the back side of the ID document
imageQuality	string	Overall image quality for the back side of the ID document (e.g., high)

Did this page help you?

Country and its Valid Documents

Data Extraction