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 curl location 'https //api preproduction signzy app/api/v3/us/document intelligence advance' \\ \ header 'authorization < auth token >' \\ \ header 'content type application/json' \\ \ data '{ "fronturl" "https //persist signzy tech/api/files/982342417/download/e320a58db7a74f43234383297239847239e4e569ac3fd7dc6a26434 jpeg", "backurl" "https //persist signzy tech/api/files/98823423196/download/dde1afa0519a43a6bbf2342397849872344d5f934f5ab2b7949f8b jpeg", "country" "united states", "idtype" "driving license" }' pre production curl location 'https //api preproduction signzy app/api/v3/us/document intelligence advance' \\ \ header 'authorization < auth token >' \\ \ header 'content type application/json' \\ \ data '{ "fronturl" "https //persist signzy tech/api/files/982342417/download/e320a58db7a74f43234383297239847239e4e569ac3fd7dc6a26434 jpeg", "backurl" "https //persist signzy tech/api/files/98823423196/download/dde1afa0519a43a6bbf2342397849872344d5f934f5ab2b7949f8b jpeg", "country" "united states", "idtype" "driving license" }' 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 true false 241,158false 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 body 200 { "results" { "completestatus" { "detailsoptical" { "doctype" "true", "expiry" "true", "imageqa" "false", "mrz" "none", "overallstatus" "false", "pagescount" 2, "security" "false", "text" "true", "vds" "none" }, "optical" "false", "overallstatus" "false", "portrait" "none", "rfid" "none" }, "imagequality" { "result" false, "frontidcheck" { "imagefocus" true, "imageglares" "na", "portrait" true, "bounds" "na", "perspective" true, "imageresolution" true }, "backidcheck" { "imagefocus" true, "imageglares" "na", "portrait" false, "bounds" "na", "perspective" true, "imageresolution" true } }, "authenticitycheck" { "frontauthenticitychecklist" { "image pattern" \[ { "elementresult" true, "elementdiagnose" "pass", "elementtype" "blank", "image" "https //persist sample png", "etalonimage" "https //persist sample png" }, { "elementresult" true, "elementdiagnose" "pass", "elementtype" "blank", "image" "https //persist sample png", "etalonimage" "https //persist sample png", { "elementresult" true, "elementdiagnose" "pass", "elementtype" "blank", "image" "https //persist sample png", "etalonimage" "https //persist sample png" } ], "photoembedtype" \[ { "elementresult" true, "elementdiagnose" "pass", "elementtype" "blank", "image" null, "etalonimage" null }, { "elementresult" true, "elementdiagnose" "pass", "elementtype" "face presence", "image" null, "etalonimage" null } ] }, "backauthenticitychecklist" { "image pattern" \[ { "elementresult" false, "elementdiagnose" "fixed pattern error", "elementtype" "blank", "image" "https //persist sample png", "etalonimage" "https //persist sample png" } ] } }, "extractedfields" { "remainderterm" "31", "documentnumber" "xxxxxx", "dateofexpiry" "dd/mm/yyyy", "sex" "m", "names" "john doe", "surnameandgivennames" "john doe", "addressstate" "ontario", "issuingstatename" "canada", "issuingstatecode" "can", "yearssinceissue" "2", "ageatissue" "50", "age" "52", "inventorynumber" "xxxx", "height" "173 cm", "lastname" "doe", "surname" "john", "dateofbirth" "dd/mm/yyyy", "documentdiscriminator" "xxxx", "dlclass" "g", "dateofissue" "dd/mm/yyyy", "addresspostalcode" "m2k0b2", "addressjurisdictioncode" "on", "addresscity" "north york", "address" "xxxxxx", "firstname" "john", "givennames" "doe" }, "predictedidtypefront" { "documentname" "canada ontario driving licence (2012)", "fdsidlist" { "icaocode" "can", "dcountryname" "canada", "ddescription" "driving license", "dformat" 0, "dmrz" false, "dstatecode" "on", "dstatename" "ontario", "dtype" 49, "dyear" "2012", "isdeprecated" false }, "p" 0 8089022636413574 }, "predictedidtypeback" { "documentname" "canada ontario driving licence (2012) side b", "fdsidlist" { "icaocode" "can", "dcountryname" "canada", "ddescription" "driving license", "dformat" 0, "dmrz" false, "dstatecode" "on", "dstatename" "ontario", "dtype" 49, "dyear" "2012", "isdeprecated" false }, "p" 0 875654697418213 }, "graphicfields" { "fieldlist" \[ { "fieldtype" "portrait", "value" "https //persist sample png", "source" "visual", "containertype" "visual graphics" }, { "fieldtype" "signature", "value" "https //persist sample png", "source" "visual", "containertype" "visual graphics" }, { "fieldtype" "ghost portrait", "value" "https //persist sample png", "source" "visual", "containertype" "visual graphics" }, { "fieldtype" "bar code", "value" "https //persist sample png", "source" "visual", "containertype" "visual graphics" }, { "fieldtype" "cropped document", "value" "https //persist sample png", "source" "visual", "containertype" "document image" }, { "fieldtype" "cropped document", "value" "https //persist sample png", "source" "visual", "containertype" "document image" } ] } } } 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" { "name" "error", "message" "input validation error required field(s) missing fronturl", "status" 400, "reason" "validation error", "type" "bad request", "statuscode" 400 } } //when country given does not matches with the country detected on the id card { "error" { "name" "error", "message" "given country is not valid", "status" 400, "reason" "validation error", "type" "bad request", "statuscode" 400 } } //when document type does not matches with the idtype given { "error" { "name" "error", "message" "id type is not valid for the given country", "status" 400, "reason" "validation error", "type" "bad request", "statuscode" 400 } } { "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 202,100false 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 completestatus 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 imagequality 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 authenticitycheck 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 graphicfields 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 predictedidtypefront and predictedidtypeback 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 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 idexpired 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 extractedfields 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 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 error response parameters 283,520 false true left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type unhandled content type left unhandled content type unhandled content type left unhandled content type left unhandled content type left unhandled content type unhandled content type left unhandled content type left unhandled content type left unhandled content type 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!