Document 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.
﻿
API details
Endpoint
Production Environment
POST https://api.signzy.app/api/v3/vision/documentIntellegence
POST https://api.signzy.app/api/v3/vision/documentIntellegence
﻿
Production Environment
POST https://api-preproduction.signzy.app/api/v3/vision/documentIntellegence
POST https://api-preproduction.signzy.app/api/v3/vision/documentIntellegence
﻿
﻿
Request headers 
Name
Value
Required
Description
Content-Type
application/json
Mandatory
The type of content that the request body contains.
Authorization
XXXXXXXXXXXXXXX
Mandatory
An authentication token to authorize the request. Reach out to the Signzy support team to get one created.
﻿
Request body parameters
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
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
}
﻿
﻿
Code samples
Curl
Node.js
Python
Go
curl --location 'https://api-staging.signzy.app/api/v3/vision/documentIntellegence' \
--header 'Content-Type: application/json' \
--header 'Authorization: <Auth Token>' \
--data '{
    "fontUrl": "https://persist.signzy.tech/api/files/790221639/download/f14.jpg",
    "backUrl": "https://preproduction-persist.signzy.tech/api/files/37487415/download/e98.jpg",
    "country": "United Arab Emirates",
    "idType": "Id Card",
    "performImageQualityAnalysis": true,
    "performIdClassification": true,
    "performIdExtraction": true,
    "performFaceExtraction": true,
    "imageQualityThreshold": 0.9
}'
curl --location 'https://api-staging.signzy.app/api/v3/vision/documentIntellegence' \
--header 'Content-Type: application/json' \
--header 'Authorization: <Auth Token>' \
--data '{
    "fontUrl": "https://persist.signzy.tech/api/files/790221639/download/f14.jpg",
    "backUrl": "https://preproduction-persist.signzy.tech/api/files/37487415/download/e98.jpg",
    "country": "United Arab Emirates",
    "idType": "Id Card",
    "performImageQualityAnalysis": true,
    "performIdClassification": true,
    "performIdExtraction": true,
    "performFaceExtraction": true,
    "imageQualityThreshold": 0.9
}'
﻿
﻿
Response body parameters
Parameter
Data Type
Description
results
Object
An object containing the extracted business details.
results.predictedIddTypeBack
String
The type of ID detected on the back side.
results.idExpired
Boolean
Indicates if the ID has expired.
results.extractedFields.firstName
String
The first name of the ID holder.
results.extractedFields.lastName
String
The last name of the ID holder.
results.extractedFields.names
String
Full names of the ID holder.
results.extractedFields.address
String
Address of the ID holder.
results.extractedFields.number
String
Number associated with the ID.
results.extractedFields.DOB
String
Date of Birth of the ID holder.
results.extractedFields.issuingState
String
The state that issued the ID.
results.extractedFields.expiryDate
String
The expiry date of the ID.
results.extractedFields.nationality
String
The nationality of the ID holder.
results.extractedFields.gender
String
The gender of the ID holder.
results.extractedFields.additionalData
Object
Contains additional data that varies by ID.
results.faceUrl
String
URL of the face image associated with the ID.
results.imageQualityBack.qualityScores.textQuality.valid
String
Indicates if the text quality is valid.
results.imageQualityBack.qualityScores.textQuality.score
Float
Score of the text quality.
results.imageQualityBack.qualityScores.brightness.valid
String
Indicates if the brightness measure is valid.
results.imageQualityBack.qualityScores.brightness.score
Float
Score of the brightness quality.
results.imageQualityBack.qualityScores.sharpness.valid
String
Indicates if the sharpness measure is valid.
results.imageQualityBack.qualityScores.sharpness.score
Float
Score of the sharpness quality.
results.imageQualityBack.qualityScores.compressionQuality.valid
String
Indicates if the compression quality is valid.
results.imageQualityBack.qualityScores.compressionQuality.score
Float
Score of the compression quality.
results.imageQualityBack.score
Float
Overall quality score of the image on the back side.
results.imageQualityBack.summary
String
Summary of the image quality analysis (accept/reject).
results.imageQualityBack.msg
String
Message related to the image quality processing.
results.imageQualityBack.status
String
Status code of the image quality processing.
results.imageQualityBack.imageQuality
String
Overall image quality level (high/low).
200
401
422
400
409
//Error in service from upstream
{
    "error": {
        "reason": "Error From Upstream",
        "status": 409,
        "message": "Upstream Down",
        "type": "Conflict",
        "statusCode": 409,
        "name": "error"
    }
}
//Error in service from upstream
{
    "error": {
        "reason": "Error From Upstream",
        "status": 409,
        "message": "Upstream Down",
        "type": "Conflict",
        "statusCode": 409,
        "name": "error"
    }
}
﻿
﻿
Contact Us for Any Assistance
If you have any questions or need assistance, please reach out to our customer support team. You can contact us via email 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!
﻿

TABLE OF CONTENTS

Introduction

API details

Endpoint

Request headers

Request body parameters

Code samples

Response body parameters

Name	Value	Required	Description
Content-Type	application/json	Mandatory	The type of content that the request body contains.
Authorization	XXXXXXXXXXXXXXX	Mandatory	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

Parameter	Data Type	Description
results	Object	An object containing the extracted business details.
results.predictedIddTypeBack	String	The type of ID detected on the back side.
results.idExpired	Boolean	Indicates if the ID has expired.
results.extractedFields.firstName	String	The first name of the ID holder.
results.extractedFields.lastName	String	The last name of the ID holder.
results.extractedFields.names	String	Full names of the ID holder.
results.extractedFields.address	String	Address of the ID holder.
results.extractedFields.number	String	Number associated with the ID.
results.extractedFields.DOB	String	Date of Birth of the ID holder.
results.extractedFields.issuingState	String	The state that issued the ID.
results.extractedFields.expiryDate	String	The expiry date of the ID.
results.extractedFields.nationality	String	The nationality of the ID holder.
results.extractedFields.gender	String	The gender of the ID holder.
results.extractedFields.additionalData	Object	Contains additional data that varies by ID.
results.faceUrl	String	URL of the face image associated with the ID.
results.imageQualityBack.qualityScores.textQuality.valid	String	Indicates if the text quality is valid.
results.imageQualityBack.qualityScores.textQuality.score	Float	Score of the text quality.
results.imageQualityBack.qualityScores.brightness.valid	String	Indicates if the brightness measure is valid.
results.imageQualityBack.qualityScores.brightness.score	Float	Score of the brightness quality.
results.imageQualityBack.qualityScores.sharpness.valid	String	Indicates if the sharpness measure is valid.
results.imageQualityBack.qualityScores.sharpness.score	Float	Score of the sharpness quality.
results.imageQualityBack.qualityScores.compressionQuality.valid	String	Indicates if the compression quality is valid.
results.imageQualityBack.qualityScores.compressionQuality.score	Float	Score of the compression quality.
results.imageQualityBack.score	Float	Overall quality score of the image on the back side.
results.imageQualityBack.summary	String	Summary of the image quality analysis (accept/reject).
results.imageQualityBack.msg	String	Message related to the image quality processing.
results.imageQualityBack.status	String	Status code of the image quality processing.
results.imageQualityBack.imageQuality	String	Overall image quality level (high/low).