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 endpoint details request type post pre prod environment > https //api signzy app/api/v3/liveness secure/createurl india production environment > https //api signzy app/api/v3/liveness secure/createurl us production environment > https //api signzy app/api/v3/liveness secure/createurl canada production environment > https //api signzy app/api/v3/liveness secure/createurl uae production environment > https //api signzy app/api/v3/liveness secure/createurl 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 parameter name type description flow object object containing flow details flow\ flowid string the unique identifier for the flow flow\ version number the version number of the flow processingconfig object object containing processing configuration details processingconfig callbackurl string the url to which the callback data will be sent processingconfig authkeyforcallback string the authentication key for the callback url processingconfig journeylinkvalidity number the validity period of the journey link in seconds processingconfig journeysessionexpiry number the validy of period of the journey session in seconds default value is 600 ( 10 minutes) processingconfig redirecttime number time in seconds , after which the redirection will happen processingconfig language string this overwrites the selected language in the flow en "english", fr "french", hi "hindi", ru "russian", es "spanish", ch "chinese", dh "dutch", ar "arabic", be "bengali", pg "portuguese", ur "urdu", id "indonesian", gr "germany", jp "japanese", mr "marathi", tl "telugu", tm "tamil", tu "turkish", ko "korean", vm "vietnamese", it "italian", hu "hausa", th "thai", gj "gujarati", ka "kannada", bj "bhojpuri", fp "filipino", bm "burmese", pl "polish", yb "yoruba", od "odia", ml "malayalam", mt "maithili", uk "ukrainian", ep "eastern punjabi", sd "sunda", sh "swahili", wp "western punjabi", wc "wu chinese", yc "yue chinese", jv "javanese", ea "egyptian spoken arabic", ip "iranian persian", sc "southern min chinese", hc "hakka chinese", jc "jinyu chinese", ma "moroccan spoken arabic ", aa "algerian spoken arabic", ss "sudanese spoken arabic", np "nigerian pidgin", xc "xiang chinese" processingconfig successredirecturl string this is the url where user is redirected after redirecttime, when journey is completed processingconfig failureredirecturl string this is the url where user is redirected after redirecttime, when journey is teminated captureddata object object containing captured data details matchpercentage object object containing matching percentages between data extracted and user info prefilled documentintelligence object object containing document intelligence details selfieanalysis object object containing selfie analysis details id string unique database id clientid string id of the client userid string id of the user journeyid string id of the journey currentstatus string current status of the journey not started the journey has not been initiated by the user in progress the user has started the journey but has not completed it yet completed the user has successfully completed the entire journey terminated the journey was forcefully ended after the user exhausted all retry attempts during document analysis abandoned the user did not complete the journey, and the session timed out due to inactivity note a journey can have currentstatus = "completed" even if face match or liveness fails “completed” only means the journey process finished — not that the verification succeeded step string the step in the journey possible values are 'init' 'consent' 'country selection' 'doc selection' 'doc front' 'doc back' 'doc check' 'doc reject' 'liveness consent' 'face capture' 'complete', message string message providing details about the journey status these messages are dependent on the step init journey started consent consent received country selection country selected doc selection document type selected doc front front side of document captured doc back back side of document captured doc check document data successfully extracted liveness consent liveness consent received face capture face successfully captured complete journey completed retries exceeded maximum retries exceeded session timed out session timed out due to inactivity journey expired journey link expired and no longer valid callbacksent boolean indicates if the callback was sent mobilestatus boolean indicates if the mobile status is active userinfo object object containing all prefilled data given when creating journey createdat number timestamp of when the journey was created startedat number timestamp of when the journey was started completedat number timestamp of when the journey was completed updatedat string timestamp of the last update to the journey v number related to database id deleted boolean indicates if the data from signzy system is deleted or not deletiontimelimit number the duration after which the journey data will be automatically deleted from signzy's system this value is derived from the 'automatic data deletion' configuration set in the dashboard ipaddresses object includes the ip address captured during the journey, along with details from the ip quality check for each identified ip address result captureddata object parameter name type description images frontdoc string url of the front side image of the document images backdoc string url of the back side image of the document images selfie string url of the selfie image consent boolean indicates if consent was given by the user country string country selected by the user idtype string type of document selected by the user in the journey livenessconsent boolean indicates if consent was given by the user on the selfie analysis intruction page result documentintelligence object 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 none/na check was not done ( depends on id type, image quality) 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 all optical checks true check passed false check failed completestatus detailsoptical pagescount number number of pages in the document eg 1 or 2 completestatus detailsoptical security string status of security features check true check passed false check failed none/na check was not done ( depends on id type) completestatus detailsoptical text string status of text verification true check passed false check failed none/na check was not done 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 result of optical status true check passed false check failed completestatus overallstatus string this field indicates the outcome of the document validation step in the journey it is determined by the flag configuration set under document analysis > additional settings this status serves as the primary indicator for the outcome of document intelligence 1 overallstatus = "true" document successfully validated no issues were found, or only low severity flags were triggered the document is considered valid as per the configured rules the user is allowed to proceed with the journey 2 overallstatus = "false" document validation failed a high severity flag was triggered the user is blocked from proceeding further, with appropriate message 3 overallstatus = "review" document requires manual review a medium severity flags was triggered the document has potential issues but does not block the user the user is still allowed to proceed, but this status can be used for back office review or audit trails 4 overallstatus = "processing error" internal processing error an unexpected error occurred during document validation the user sees an error screen with a retry option to reinitiate validation completestatus message string this field provides a human readable summary of the document validation result, based on the flags triggered during analysis if no flags are triggered "document validated successfully" is returned if any flags are triggered the message reflects the specific issue identified, corresponding to the triggered flag(s) completestatus severity string this field represents the severity level of the flag that was triggered during document analysis the severity levels are based on the configuration defined in the document analysis > additional settings low – a low severity flag was triggered medium – a medium severity flag was triggered high – a high severity flag was triggered 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 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 parameter name type description imagequality object results of image quality checks imagequality result boolean overall result of image quality assessment true check passed false check failed none/na check was not done ( depends on id type) imagequality frontidcheck object detailed results of front id image quality checks imagequality frontidcheck imageglares boolean status of image glare check true check passed false check failed none/na check was not done ( depends on id type) imagequality frontidcheck imagefocus boolean status of image focus check true check passed false check failed none/na check was not done ( depends on id type) imagequality frontidcheck imageresolution boolean status of image resolution check true check passed false check failed none/na check was not done ( depends on id type) imagequality frontidcheck imagecolorness string status of image colorness check true check passed false check failed none/na check was not done ( depends on id type) imagequality frontidcheck perspective boolean status of image perspective check true check passed false check failed none/na check was not done ( depends on id type) imagequality frontidcheck bounds boolean status of image bounds check true check passed false check failed none/na check was not done ( depends on id type) imagequality frontidcheck portrait boolean status of portrait image check true check passed false check failed none/na check was not done ( depends on id type) imagequality frontidcheck brightness string status of image brightness check true check passed false check failed none/na check was not done ( depends on id type) 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 true check passed false check failed 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\[] 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 graphicfields fieldlist\[] docside string details from which side of id, was the graphic filed extracted front > front side of id back > back side of id 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 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, internal list 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 idexpired parameter name type description idexpired string status indicating whether the id has expired true id is expired false id is not expired extractedfields object the values extracted depends on the id card submitted 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 ( dd/mm/yyyy) extractedfields issuingstate string extracted issuing state extractedfields expirydate string extracted expiry date ( dd/mm/yyyy) 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 documentintelligence attempts parameter name type description attempts integer shows how many times the user has submitted a document we overwrite the data with the latest document analysis selfieanalysis object passiveliveliness parameter name type description status string status code of the passive liveliness check liveness boolean indicates if passive liveliness was detected true liveness is positive, false liveness is negative this status serves as the primary indicator for the outcome of liveness check score number score indicating the confidence level of passive liveliness detection facematch parameter name type description status string status of the face match verification verified boolean indicates if the face match was verified true face match is positive, false face match is negative this status serves as the primary indicator for the outcome of facematch between selfie and document portrait message string message providing additional details about the face match result matchpercentage string percentage indicating how closely the selfie matches the id photo additionalfacechecks parameter name type description additionalfacechecks maskdetection object provides analysis data related to mask detection, identifying whether the user is wearing a face mask additionalfacechecks maskdetection status string status of the mask detection analysis additionalfacechecks maskdetection result object contains the result of the mask detection additionalfacechecks maskdetection result found boolean outputs the boolean value true > mask detected false > mask not detected additionalfacechecks facecoverdetection object provides analysis data related to face cover detection this includes identifying obstructions such as glasses, sunglasses, caps, or any other items covering the face additionalfacechecks facecoverdetection status string status of the face cover detection analysis additionalfacechecks facecoverdetection result object contains the result of the face cover detection additionalfacechecks facecoverdetection result isfacecovered boolean outputs the boolean value true > face cover detected false > face cover not detected additionalfacechecks facecoverdetection result facegears array ouputs what face cover is being identified it can have comma separated values incase multiple obstructions were detected glasses > glasses were found cap > cap was found sunglasses > sunglasses were found selfieanalysis attempts parameter name type description attempts integer shows how many times the user has attempted for the selfie analysis we overwrite the data with the latest captured selfie ipaddresses object ip address field data type description asn string the autonomous system number (asn) is associated with the ip address isp string the internet service provider (isp) that manages the ip address countrycode string the two letter country code of the location is associated with the ip address region string the region or state where the ip address is located city string the city where the ip address is located organization string the organization or company associated with the ip address latitude string the latitude coordinate of the ip address location longitude string the longitude coordinate of the ip address location iscrawler string indicates whether the ip address belongs to a web crawler timezone string the timezone of the ip address location mobile string indicates whether the ip address is associated with a mobile device host string the hostname is associated with the ip address proxy string indicates whether the ip address is a proxy server vpn string indicates whether the ip address is associated with a vpn service tor string indicates whether the ip address is associated with the tor network recentabuse string information about any recent abuse associated with the ip address botstatus string the status of the ip address concerning being a bot fraudscore string the fraud score is associated with the ip address 75+ = suspicious | 85+ = risky | 90+ = high risk address string the address of the location is associated with the ip address 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 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!