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 docid\ rrmk1inoagyatwnkmpfh6 face extraction docid zteelpbdbifok3bjfzyr image quality analysis docid\ o4ws8kg6vicjggwl bznt id classification docid 6sytgdkfakxivnvgyials 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 post https //api signzy app/api/v3/vision/documentintellegence pre production post https //api preproduction 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 { "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 // 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" { &#x9; // 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" } } } 401 // auth token is invalid { "message" "invalid authentication credentials" } 422 //unable to process request body { "error" { "name" "error", "message" "unproccesable entity", "status" 422, "statuscode" 422 } } 400 //when back side is not valid { "error" { "statuscode" 400, "status" 400, "name" "error", "message" "please provide a valid back side of the document" } } //when fornt side is not valid { "error" { "statuscode" 400, "status" 400, "name" "error", "message" "please provide a valid front side of the document" } } //if any of the required fields is missing { "error" { "message" "invalid input", "status" 400, "statuscode" 400, "name" "error" } } //when country given does not matches with the country detected on the id card { "error" { "statuscode" 400, "status" 400, "name" "error", "message" "invalid country given" } } //when document type does not matches with the idtype given { "error" { "statuscode" 400, "status" 400, "name" "error", "message" "invalid document type given" } } { "error" { "statuscode" 400, "name" "error", "message" "id type not matching with the specified", "status" 400 } } 409 //error in service from upstream { "error" { "reason" "error from upstream", "status" 409, "message" "upstream down", "type" "conflict", "statuscode" 409, "name" "error" } } 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 help\@signzy com 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!