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 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 { "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 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 s tatus 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 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!