Know Your Customer
...
ID OCR
Global

ID Intelligence Advance

Overview

The Global Doc Intelligence Advance API is designed to analyze and verify identification documents effectively. It provides tools for authenticating ID documents by performing advanced checks such as ID classification, data extraction, and face extraction, alongside assessing image quality. This API supports businesses in verifying the authenticity of documents crucial for customer onboarding and compliance with corporate policies. It offers a structured approach to streamline the validation process, helping reduce manual verification workload and enhance operational efficiency.

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.

Use Case

1. Financial Sector Onboarding and KYC Compliance: Banks and financial institutions use the API for customer onboarding and KYC compliance, automating document verification and data extraction to meet regulatory requirements efficiently.

2. Insurance Claims and Policy Management: Insurance companies apply the API to authenticate ID documents in claims processing and policy issuance, reducing fraud and streamlining operations.

3. Rental and Lease Agreements: Real estate agencies use the API to verify tenant IDs, ensuring validity and compliance in rental agreements.

4. Travel and Immigration Services: Travel and immigration services utilize the API for document verification, improving security and compliance with travel regulations.

5. E-Commerce Identity Verification: E-commerce platforms integrate the API to verify seller identities, securing transactions and reducing fraudulent activities.

API Details

Request Body

Production
Pre-Production


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

Country of issuance of the ID.

Mandatory

idType

String

Type of the ID (e.g., "Id Card").

Mandatory

Response Body

200
401
422
400
409


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

completeStatus

Parameter Name

Type

Description

completeStatus

Object

Overall status and details of various checks performed on the document.

completeStatus.detailsOptical

Object

Detailed optical check results.

completeStatus.detailsOptical.docType

String

Status of document type verification.

True: Check passed ,False: Check failed

completeStatus.detailsOptical.expiry

String

Status of expiry date verification.

True: Check passed ,False: Check failed None/NA : Check was not done ( depends on ID type)

completeStatus.detailsOptical.imageQA

String

Status of image quality assessment.

True: Check passed ,False: Check failed

completeStatus.detailsOptical.mrz

String

Status of MRZ (Machine-Readable Zone) check.

True: Check passed ,False: Check failed None/NA : Check was not done ( depends on ID type)

completeStatus.detailsOptical.overallStatus

String

Overall status of optical checks.

True: Check passed ,False: Check failed

completeStatus.detailsOptical.pagesCount

Number

Number of pages in the document.

completeStatus.detailsOptical.security

String

Status of security features check.

True: Check passed ,False: Check failed

completeStatus.detailsOptical.text

String

Status of text verification.

True: Check passed ,False: Check failed

completeStatus.detailsOptical.vds

String

Status of VDS (Visible Digital Seal) check.

True: Check passed ,False: Check failed None/NA : Check was not done ( depends on ID type)

completeStatus.optical

String

Overall optical status.

True: Check passed ,False: Check failed

completeStatus.overallStatus

String

Overall status of document intelligence.

True: Check passed ,False: Check failed

This status serves as the primary indicator for the outcome of document intelligence

completeStatus.portrait

String

Status of portrait verification.

True: Check passed ,False: Check failed None/NA : Check was not done ( depends on ID type)

completeStatus.rfid

String

Status of RFID (Radio-Frequency Identification) check.

True: Check passed ,False: Check failed None/NA : Check was not done ( depends on ID type)

imageQuality

Parameter Name

Type

Description

imageQuality

Object

Results of image quality checks.

imageQuality.result

Boolean

Overall result of image quality assessment.

imageQuality.frontIdCheck

Object

Detailed results of front ID image quality checks.

imageQuality.frontIdCheck.ImageGlares

Boolean

Status of image glare check.

imageQuality.frontIdCheck.ImageFocus

Boolean

Status of image focus check.

imageQuality.frontIdCheck.ImageResolution

Boolean

Status of image resolution check.

imageQuality.frontIdCheck.ImageColorness

String

Status of image colorness check.

imageQuality.frontIdCheck.Perspective

Boolean

Status of image perspective check.

imageQuality.frontIdCheck.Bounds

Boolean

Status of image bounds check.

imageQuality.frontIdCheck.Portrait

Boolean

Status of portrait image check.

imageQuality.frontIdCheck.Brightness

String

Status of image brightness check.

authenticityCheck

Parameter Name

Type

Description

authenticityCheck

Object

Results of authenticity checks.

authenticityCheck.ocrSecurityText

Object

Results of OCR (Optical Character Recognition) security text check.

authenticityCheck.ocrSecurityText.ElementResult

Boolean

Result of OCR security text check.

authenticityCheck.ocrSecurityText.ElementDiagnose

String

Diagnosis of OCR security text check.

authenticityCheck.imagePattern

Object

Results of image pattern check.

authenticityCheck.imagePattern.ElementResult

Boolean

Result of image pattern check.

authenticityCheck.imagePattern.ElementDiagnose

String

Diagnosis of image pattern check.

authenticityCheck.imagePattern.ElementType

String

Type of image pattern check.

authenticityCheck.imagePattern.Image

String

URL of the image pattern check result.

authenticityCheck.imagePattern.EtalonImage

String

URL of the etalon image used for comparison.

authenticityCheck.photoEmbedType

Object

Results of photo embed type check.

authenticityCheck.photoEmbedType.ElementResult

Boolean

Result of photo embed type check.

authenticityCheck.photoEmbedType.ElementDiagnose

String

Diagnosis of photo embed type check.

authenticityCheck.photoEmbedType.ElementType

String

Type of photo embed type check.

graphicFields

Parameter Name

Type

Description

graphicFields

Object

Details of graphic fields extracted from the document.

graphicFields.fieldList

Array

List of extracted graphic fields.

graphicFields.fieldList[].fieldName

String

Name of the extracted field.

graphicFields.fieldList[].fieldType

String

Type of the extracted field.

graphicFields.fieldList[].value

String

Value of the extracted field.

graphicFields.fieldList[].source

String

Source of the extracted field.

graphicFields.fieldList[].containerType

String

Container type of the extracted field.

predictedIdTypeFront and predictedIdTypeBack

Parameter Name

Type

Description

predictedIdTypeFront

Object

Predicted ID type for the front side of the document.

predictedIdTypeFront.DocumentName

String

Predicted Document of the front id

predictedIdTypeFront.FDSISList

Object

This object contains the details of the front document

predictedIdTypeFront.FDSISList.ICAOCode

String

ICAO Code of the country

predictedIdTypeFront.FDSISList.dCountryName

String

Name of the country

predictedIdTypeFront.FDSISList.dDescription

String

Description of the Id

predictedIdTypeFront.FDSISList.dFormat

String



predictedIdTypeFront.FDSISList.dMRZ

Boolean

If mrz is present in the document

predictedIdTypeFront.FDSISList.dType

Number

Type of document

predictedIdTypeFront.FDSISList.dYear

String

Year of issue

ipredictedIdTypeFront.FDSISList.sDeprecated

Boolean

if this id is deprecated

predictedIdTypeFront.P

Float

Probability of likelihood of the predicted document

predictedIdTypeBack

Object

Predicted ID type for the back side of the document.

predictedIdTypeBack.DocumentName

String

Predicted Document of the back id

predictedIdTypeBack.FDSISList

Object

This object contains the details of the back document

predictedIdTypeBack.FDSISList.ICAOCode

String

ICAO Code of the country

predictedIdTypeBack.FDSISList.dCountryName

String

Name of the country

predictedIdTypeBack.FDSISList.dDescription

String

Description of the Id

predictedIdTypeBack.FDSISList.dFormat

Number



predictedIdTypeBack.FDSISList.dMRZ

Boolean

If mrz is present in the document

predictedIdTypeBack.FDSISList.dType

Number

Type of document

predictedIdTypeBack.FDSISList.dYear

String

Year of issue

ipredictedIdTypeBack.FDSISList.sDeprecated

Boolean

if this id is deprecated

predictedIdTypeBack.P

Float

Probability of likelihood of the predicted document

idExpired

Parameter Name

Type

Description

idExpired

String

Status indicating whether the ID has expired.

True: id is expired, False: id is not expired

extractedFields

Parameter Name

Type

Description

extractedFields

Object

Fields extracted from the document.

extractedFields.firstName

String

Extracted first name.

extractedFields.lastName

String

Extracted last name.

extractedFields.names

String

Extracted full name.

extractedFields.address

String

Extracted address.

extractedFields.number

String

Extracted ID number.

extractedFields.DOB

String

Extracted date of birth.

extractedFields.issuingState

String

Extracted issuing state.

extractedFields.expiryDate

String

Extracted expiry date.

extractedFields.nationality

String

Extracted nationality.

extractedFields.gender

String

Extracted gender.

extractedFields.documentName

String

Name of the document.

extractedFields.remainderterm

String

Remaining term of the document.

extractedFields.dlRestrictionCode

String

Driving license restriction code.

extractedFields.yearsSinceIssue

String

Number of years since the document was issued.

extractedFields.ageAtIssue

String

Age at the time of document issue.

extractedFields.age

String

Current age.

extractedFields.height

String

Height of the document holder.

extractedFields.weight

String

Weight of the document holder.

extractedFields.eyesColor

String

Eye color of the document holder.

extractedFields.dlClass

String

Class of the driving license.

extractedFields.dlEndorsed

String

Endorsements on the driving license.

extractedFields.dateOfIssue

String

Date of issue of the document.

extractedFields.dlIssType

String

Type of driving license issuance.

extractedFields.addressPostalCode

String

Postal code of the address.

extractedFields.addressJurisdictionCode

String

Jurisdiction code of the address.

extractedFields.addressCity

String

City of the address.

extractedFields.addressStreet

String

Street of the address.

extractedFields.documentDiscriminator

String

Document discriminator number.





Error Response Parameters

Parameter

Description

error

This parameter contains the error.

error.name

the error name.

error.message

the error message.

error.status

Status of the api

error.reason

Reason for error

error.type

Type of the error

error.statusCode

Request Status code from Signzy



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!