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 true false 128false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type 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 true false 205false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type extractedfields object this object changes based on the id given as input true falsefalse left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type additionaldata object true falsefalse left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type imagequalityfront object true falsefalse left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type imagequalityback object true falsefalse left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type 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!