Get Journey Results

overview and purpose overview the get journey results api allows clients to retrieve the detailed results of a completed kyc journey if a callback url was provided during the journey configuration, the results are automatically sent to that url alternatively, clients can use this api to fetch the journey results directly purpose the purpose of this api is to provide clients with comprehensive results of a user's kyc journey, including journey status, document intelligence, face match and liveness, and any errors encountered this information is crucial for clients to review and make informed decisions based on the kyc data api details request parametersinput journey id and authorization token to identify and authenticate the request output includes journeyid, flowid, user data (consent, country, idtype, document and face images), verification results (face match score, liveliness score, image quality, document intelligence), and any errors encountered api request preproduction curl location 'https //api preproduction signzy app/api/v3/otk service/get journey/1234556' \\ \ header 'authorization \<auth token>' \\ \ header 'content type application/json' \\ \ data '' api response structure { "flow" { "flowid" "\<flow id>", "version" 1 }, "processingconfig" { "callbackurl" "https //callback url", "authkeyforcallback" "\<auth key>", "redirecttime" 10, "language" "en", "successredirecturl" "", "failureredirecturl" "", "journeylinkvalidity" 3600, "journeysessionexpiry" 600, }, "captureddata" { "images" { "frontdoc" "https //persist signzy tech/sample1 jpeg", "backdoc" "https //persist signzy tech/sample2 jpeg", "selfie" "https //persist signzy tech/sample3 jpeg" }, "consent" true, // consent on 1st instruction page "livenessconsent" false, // consent on selfie analysis instruction page "country" "us", // country selected by user "idtype" "driving license" // document selected by user }, "matchpercentage" { "dateofbirthmatch" "na", "addressmatch" "na", "fullnamematch" "na" }, "documentintelligence" { "completestatus" { "detailsoptical" { "doctype" "true", "expiry" "true", "imageqa" "false", "mrz" "none", "overallstatus" "true", "pagescount" 2, "security" "true", "text" "true", "vds" "none" }, "optical" "true", "overallstatus" "true", // overall result of document intelligence "message" "document validated successfully",// depends on the overall staus and flag triggered "severity" "na", // flag triggered severity "portrait" "none", "rfid" "none" }, "imagequality" { "result" false, "frontidcheck" { "imageglares" false, "imagefocus" true, "imageresolution" false, "imagecolorness" "na", "perspective" true, "bounds" true, "portrait" true, "brightness" "na" }, "backidcheck" { "imageglares" false, "imagefocus" true, "imageresolution" false, "imagecolorness" "na", "perspective" true, "bounds" true, "portrait" true, "brightness" "na" } }, "extractedfielderrors" \[], // contains details about ocr issues and any mismatches between data extracted from ocr and data from the barcode/mrz "authenticitycheck" { "frontauthenticitychecklist" { "photoembedtype" \[ { "elementresult" true, "elementdiagnose" "pass", "elementtype" "face presence", "image" null, "etalonimage" null } ], "image pattern" \[ { "elementresult" true, "elementdiagnose" "pass", "elementtype" "blank", "image" "https //persist signzy tech/api/files/979758139/download/74e88976d2f34f31af205db4a14ec8d5f65cf348df5147a18e2a4bfa2ef27427 png", "etalonimage" "https //persist signzy tech/api/files/979758140/download/1a52df165f6945a78e53f15a38d7d43b6175b8acf95e44429bc574fab89c2009 png" } ], "liveness" \[ { "elementresult" true, "elementdiagnose" "pass", "elementtype" "liveness electronic device", "image" null, "etalonimage" null } ] }, "backauthenticitychecklist" { "image pattern" \[ { "elementresult" true, "elementdiagnose" "pass", "elementtype" "blank", "image" "https //persist signzy tech/api/files/979758145/download/01ee3f2e4b47441793dbeab0fe855f3c2895a920592140e98e61dae206032380 png", "etalonimage" "https //persist signzy tech/api/files/979758146/download/95c43da026204281a5e799d97873026a05059bedc05043238999d3670a744ab5 png" }, { "elementresult" true, "elementdiagnose" "pass", "elementtype" "contact chip classification", "image" "https //persist signzy tech/api/files/979758144/download/426a5e427b7c4abea5d6f7ba7386272eb5b3396711e6448bb4b1fc9100f4ff96 png", "etalonimage" "https //persist signzy tech/api/files/979758147/download/1059678e44c9439b9c45bec2c95f54fdc68370993da64129a1aa62ee8d8e369e png" } ] } }, "graphicfields" { "fieldlist" \[ \[ { "fieldtype" "portrait", "value" "https //persist signzy tech/sample6 png", "docside" "front", "source" "visual", "containertype" "visual graphics" } ], \[ { "fieldtype" "signature", "value" "https //persist signzy tech/sample7 png", "docside" "front", "source" "visual", "containertype" "visual graphics" } ], \[ { "fieldtype" "ghost portrait", "value" "https //persist signzy tech/sample8 png", "docside" "front", "source" "visual", "containertype" "visual graphics" } ], \[ { "fieldtype" "signature", "value" "https //persist signzy tech/api/files/979758129/download/6350a71b93624d9ea44bd20e931ecae11b3e354d411d43c8b70715ca0b54a97c png", "docside" "front", "source" "visual", "containertype" "visual graphics" } ], \[ { "fieldtype" "ghost portrait", "value" "https //persist signzy tech/api/files/979758128/download/563086621ab1420ba0d9265facd2ad8661a0c75f2eaa49c3aabdeb558a64c3da png", "docside" "front", "source" "visual", "containertype" "visual graphics" } ], \[ { "fieldtype" "cropped document", "value" "https //persist signzy tech/api/files/979758135/download/baa0ae2446c046f197e4c868700ced3a41ef5f21ec744d87a12b06ee40631fb1 png", "docside" "front", "source" "visual", "containertype" "document image" }, { "fieldtype" "cropped document", "value" "https //persist signzy tech/api/files/979758136/download/6961e7acd86741d7876302647f44f9b4b456d18f0cd0434fbb50ed3e208611b5 png", "docside" "back", "source" "visual", "containertype" "document image" } ] ] ] }, "predictedidtypefront" { "documentname" "united arab emirates resident id card (2021) (golden card) #2", "fdsidlist" { "icaocode" "are", "dcountryname" "united arab emirates", "ddescription" "resident identity card", "dformat" 0, "dmrz" false, "dtype" 224, "dyear" "2021", "isdeprecated" false }, "p" 0 9670456647872925 }, "predictedidtypeback" { "documentname" "united arab emirates resident id card (2021) (golden card) side b", "fdsidlist" { "icaocode" "are", "dcountryname" "united arab emirates", "ddescription" "resident identity card", "dformat" 0, "dmrz" true, "dtype" 224, "dyear" "2021", "isdeprecated" false }, "p" 0 9594634771347045 }, "idexpired" "false", "extractedfields" { "remainderterm" "29", "dl endorsed" "none", "document class code" "il", "remainderterm" "98", "issuing state name" "united arab emirates", "age at issue" "24", "age" "26", "names" "john doe", "surname and given names" "اجو", "final checkdigit" "", "nationality code" "ind", "date of expiry checkdigit" "1", "date of expiry" "dd/mm/yyyy", "date of birth checkdigit" "7", "mrz strings" "xxxxxxxxxxx", "issuing state code" "are", "document number" "123456789", "document number checkdigit" "0", "sex" "ذكر", "date of birth" "dd/mm/yyyy", "optional data checkdigit" "3", "identity card number" "xxxxxxx", "optional data" "xxxxx", "nationality" "india", "years since issue" "1", "date of issue" "dd/mm/yyyy", "place of issue" "دبي", "profession" "بدون عمل", "firstname" "john doe", "given names" "john doe", "lastname" "doe", "surname" "doe", "mrz type" "id 1" }, "attempts" 2 // attempt number of document analysis }, "selfieanalysis" { "passiveliveliness" { "status" "200", "liveness" true, "score" 0 99 }, "facematch" { "status" "200", "verified" true, "message" "verification completed with positive result", "matchpercentage" "99 00%" }, "additionalfacechecks" { "maskdetection" { "status" "200", "result" { "found" false, "confidence" 0 } }, "facecoverdetection" { "status" "200", "result" { "isfacecovered" false, "facegears" \[] } } }, "attempts" 3 }, " id" "\<unique db id>", "clientid" "\<client id>", "userid" "\<user id>", "journeyid" "\<journey id >", "currentstatus" "completed", "step" "complete", "message" "journey completed", "callbacksent" true, "mobilestatus" false, "userinfo" { "phonenumber" "", "externalreferenceid" "", "dateofbirth" "", "emailaddress" "", "name" { "firstname" "", "lastname" "" }, "address" { "street" "", "street2" "", "city" "", "region" "", "postalcode" "", "country" "" }, "id" { "idtype" "", "country" "" } }, //external api ( based on flow configuration) "externalapiresponses" \[ { "api" "resident id card verification", "input" { "emirates id number" "\<eid number>", "date of birth" "\<dob>", "current nationality" "india" }, "response" { "emiratesidnumber" \<eid number>, "dateofbirth" "\<dob>", "currentnationality" "india", "issuedate" "\<date>", "expirydate" "\<date>", "eidcardnumber" "\<number>", "overallstatus" "true" // based on response } } ], "ipaddresses" { "\<ip address>" { "asn" "\<asn>", "isp" "\<isp>", "countrycode" "ind", "region" "maharashtra", "city" "mumbai", "organization" "\<organization>", "latitude" "19 76", "longitude" "72 87", "iscrawler" "false", "timezone" "ist, asia/kolkata", "mobile" "false", "host" "\<host>", "proxy" "false", "vpn" "false", "tor" "false", "recentabuse" "false", "botstatus" "false", "fraudscore" "0", "address" "\<address> } } "createdat" 1721541339746, "startedat" 1721541345038, "completedat" 1721541398034, " deleted" false, "deletiontimelimit" 1576800, // set based on automatic data deletion setting "updatedat" "2024 07 21t05 56 38 041z", " v" 0 } } } response body parameters result 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 true left unhandled content type true left unhandled content type true left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type result captureddata 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 result documentintelligence object 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 false left unhandled content type false 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 two objects contain the image quality check results for the uploaded identity documents frontidcheck – returned when the front side of the id document is uploaded backidcheck – returned only if the back side of the id document is also uploaded each object provides detailed insights into the quality and validation of the respective document side 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 two objects contain the predicted id type results for the uploaded identity documents predictedidtypefront – returns analysis for front side of the id document predictedidtypeback – returns analysis for back side of the id document if given each object provides detailed insights into the quality and validation of the respective document side 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 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 object the values extracted depends on the id card submitted 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 documentintelligence attempts 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 selfieanalysis object passiveliveliness 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 facematch 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 additionalfacechecks 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 selfieanalysis attempts 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 ipaddresses object ip address true falseleft false unhandled content type false unhandled content type left false unhandled content type left false unhandled content type false unhandled content type left false unhandled content type left false unhandled content type false unhandled content type left false unhandled content type left false unhandled content type false unhandled content type left false unhandled content type left false unhandled content type false unhandled content type left false unhandled content type left false unhandled content type false unhandled content type left false unhandled content type left false unhandled content type false unhandled content type left false unhandled content type left false unhandled content type false unhandled content type left false unhandled content type left false unhandled content type false unhandled content type left false unhandled content type left false unhandled content type false unhandled content type left false unhandled content type left false unhandled content type false unhandled content type left false unhandled content type left false unhandled content type false unhandled content type left false unhandled content type left false unhandled content type false unhandled content type left false unhandled content type left false unhandled content type false unhandled content type left false unhandled content type left false unhandled content type false unhandled content type left false unhandled content type left false unhandled content type false unhandled content type left false unhandled content type left false unhandled content type false unhandled content type left false unhandled content type left false unhandled content type false unhandled content type left false unhandled content type left false unhandled content type false unhandled content type left false unhandled content type left false unhandled content type false unhandled content type left false unhandled content type by utilizing the get journey results api, clients can efficiently retrieve and review detailed kyc journey results, ensuring compliance and making informed decisions based on accurate verification data 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!