Retrieval – GBG IDscan Documentation

Retrieval

This action is used to retrieve the processing results for a processed journey. It accepts a journey ID and returns the processing results for the journey and a list of the processed documents in addition to the extracted fields for each processed document in the journey.

Important note: Authentication must be done before calling this action, for more information please refer to Authentication section.

Signature:

[GET] http://serverUrl/idscanenterprisesvc/Journey/Get

Request/Response format: JSON

URL Parameters:

Parameter DescriptionFormat
JourneyIDMandatory, Reference number of the requested entry.GUID

Sample Response

 {
   "JourneyId": "461c9e05-3a0d-422b-8902-b3ce748b485a",
   "HighLevelResult": "Passed",
   "HighLevelResultDetails": [
     "UNDERAGERULE:PASSED",
     "DOCUMENTBACKSIDECHECK:NOTNEEDED",
     "DOCUMENTBLOCKINGPOLICY:PASSED",
     "DOCUMENTEXPIRY:PASSED",
     "DOCUMENTSUPPORT:PASSED",
     "DOCUMENTPROOFPOLICY:SKIPPED",
     "DOCUMENTVALIDATION:Passed"
   ],
   "InitiatedDateTime": "2019-11-21T13:49:15.9717097",
   "ProcessedDocuments": [
     {
       "IssuingCountryCode": "GBR",
       "IssuingCountryName": "United Kingdom",
     //"IssuingStateName": "Australian Capital Territory", this information will be exposed for Australia country code only.  
       "DocumentCategory": "Driving License",
       "DocumentType": "Driving License",
       "DocumentName": "United Kingdom - Driving License - Front - 2015",
       "DocumentSide": "Front",
       "IsValidated": "false",
       "ScanDateTime": "2019-11-21T13:49:15.9717097",
       "HighLevelResult": "Refer",
       "ExtractedFields": [
         {
           "Name": "AddressFull",
           "Value": "12 TORWOOD CRESCENT EDINBURGH EH12 9GJ",
           "OCRValue": "12 TORWOOD CRESCENT EDINBURGH EH12 9GJ",
           "LocalValue": "",
           "OCRLocalValue": ""
         },
         {
           "Name": "AddressCity",
           "Value": "EDINBURGH",
           "OCRValue": "EDINBURGH",
           "LocalValue": "",
           "OCRLocalValue": ""
         },
         {
           "Name": "AddressPostCode",
           "Value": "EH12 9GJ",
           "OCRValue": "EH12 9GJ",
           "LocalValue": "",
           "OCRLocalValue": ""
         },
         {
           "Name": "LastNameFirstPart",
           "Value": "MORGA",
           "OCRValue": "MORGA",
           "LocalValue": "",
           "OCRLocalValue": ""
         },
         {
           "Name": "Sex",
           "Value": "FEMALE",
           "OCRValue": "FEMALE",
           "LocalValue": "",
           "OCRLocalValue": ""
         },
         {
           "Name": "BirthPlace",
           "Value": "1 LA",
           "OCRValue": "1 LA",
           "LocalValue": "",
           "OCRLocalValue": ""
         },
         {
           "Name": "IssueNumber",
           "Value": "35",
           "OCRValue": "35",
           "LocalValue": "",
           "OCRLocalValue": ""
         },
         {
           "Name": "DocumentNumberCheckDigit",
           "Value": "IJ",
           "OCRValue": "IJ",
           "LocalValue": "",
           "OCRLocalValue": ""
         },
         {
           "Name": "BirthDate",
           "Value": "1976-03-11",
           "OCRValue": "1976-03-11",
           "LocalValue": "",
           "OCRLocalValue": ""
         },
         {
           "Name": "DocumentNumber",
           "Value": "MORGA753116SM9IJ 35",
           "OCRValue": "MORGA753116SM9IJ 35",
           "LocalValue": "",
           "OCRLocalValue": ""
         },
         {
           "Name": "FirstName",
           "Value": "SARAH",
           "OCRValue": "SARAH",
           "LocalValue": "",
           "OCRLocalValue": ""
         },
         {
           "Name": "ArbitraryDigit",
           "Value": "9",
           "OCRValue": "9",
           "LocalValue": "",
           "OCRLocalValue": ""
         },
         {
           "Name": "FirstNameInitial",
           "Value": "SM",
           "OCRValue": "SM",
           "LocalValue": "",
           "OCRLocalValue": ""
         },
         {
           "Name": "ExpiryDate",
           "Value": "2023-01-18",
           "OCRValue": "2023-01-18",
           "LocalValue": "",
           "OCRLocalValue": ""
         },
         {
           "Name": "IssueDate",
           "Value": "2013-01-19",
           "OCRValue": "2013-01-19",
           "LocalValue": "",
           "OCRLocalValue": ""
         },
         {
           "Name": "LastName",
           "Value": "MORGAN",
           "OCRValue": "MORGAN",
           "LocalValue": "",
           "OCRLocalValue": ""
         },
         {
           "Name": "LicenseCategory",
           "Value": "AM/A/B1/B/F/K/I/N/P/Q",
           "OCRValue": "AM/A/B1/B/F/K/I/N/P/Q",
           "LocalValue": "",
           "OCRLocalValue": ""
         },
         {
           "Name": "DocumentCategory",
           "Value": "Driving License",
           "OCRValue": "Driving License"
         },
         {
           "Name": "DocumentType",
           "Value": "Driving License",
           "OCRValue": "Driving License"
         }
       ],
       "DocumentImages": [
         {
           "Role": "WhiteImage",
           "Url": "https://poc.idscan.cloud/IDScanEnterpriseSvc/Search/GetImage?id=913dfe8f-be68-47e9-ae3d-1e281bdd55af&role=OutputWhiteImage"
         },
         {
           "Role": "DigitalTamperingHeatmapImage",
           "Url": "https://poc.idscan.cloud/IDScanEnterpriseSvc/Search/GetImage?id=913dfe8f-be68-47e9-ae3d-1e281bdd55af&role=DigitalTamperingHeatmapImage"
         },
         {
           "Role": "FacePortraitImage",
           "Url": "https://poc.idscan.cloud/IDScanEnterpriseSvc/Search/GetImage?id=913dfe8f-be68-47e9-ae3d-1e281bdd55af&role=FacePortraitImage"
         }
       ],
       "DigitalTamperingValidator": "Passed"
     }
   ],
   "ReferenceNumber": "1000010181",
   "AuthenticationToleranceLevel": "medium",
   "RequiredAction":"BACKSIDE",  
   "LastDecision": {
     "DecisionCode": "Rejected.Overridable",
     "DecisionDateTime": "21/11/2019 13:49:16",
     "DecisionId": "00000000-0000-0000-0000-000000000000",
     "Origin": "Automatic"
   },
   "AdditionalData": [
     {
       "Name": "BranchCode",
       "Value": "1234"
     },
     {
       "Name": "CustomerNumber",
       "Value": "c1234"
     },
     {
       "Name": "Channel",
       "Value": "Postman"
     },
     {
       "Name": "UserName",
       "Value": "psc"
     },
     {
       "Name": "RequiredJourneySteps",
       "Value": "BACKSIDE,FRONTSIDE"
     },
     {
       "Name": "UnderAgeRuleResult",
       "Value": "PASSED"
     }
   ]
 "ProcessedLiveness": { 
    "LivenessOverallResult": "Failed", 
    "LivenessActions": [ 
      { 
        "ActionNo": "1", 
        "ActionType": "TiltStraight", 
        "Result": "Passed", 
        "Url": " https://poc.idscan.cloud /IDScanEnterprisesvc/Search/GetLivenessActionFrame?id=461c9e05-3a0d-422b-8902-b3ce748b485a&action=TiltStraight" 
      }, 
      { 
        "ActionNo": "2", 
        "ActionType": "Frown", 
        "Result": "ActionTimedOut", 
        "Url": " https://poc.idscan.cloud /IDScanEnterprisesvc/Search/GetLivenessActionFrame?id=461c9e05-3a0d-422b-8902-b3ce748b485a&action=Frown" 
      }, 
      { 
        "ActionNo": "3", 
        "ActionType": "TiltUp", 
        "Result": "ActionTimedOut", 
        "Url": " https://poc.idscan.cloud /IDScanEnterprisesvc/Search/GetLivenessActionFrame?id=461c9e05-3a0d-422b-8902-b3ce748b485a&action=TiltUp" 
      } 
    ] 
  }
 , 
  "JourneySteps": [ 
    { 
      "Type": "FRONTSIDE", 
      "HighLevelresult": "Passed", 
      "ValidationChecks": [ 
        "DOCUMENTFRONTSIDETYPECHECK:PASSED", 
        "UNDERAGERULE:PASSED", 
        "DOCUMENTBLOCKINGPOLICY:PASSED", 
        "DOCUMENTSUPPORT:PASSED", 
        "DOCUMENTVALIDATION:PASSED" 
      ] 
    }, 
    { 
      "Type": "SELFIE", 
      "HighLevelresult": "Passed", 
      "ValidationChecks": [] 
    }, 
    { 
      "Type": "LIVENESS", 
      "HighLevelResult": "Refer", 
      "ValidationChecks": [ 
        "LIVENESSFINALRESULT:FAILED" 
      ] 
    } 
  ]    
 } 

Response

KeyDescriptionFormat
InitiatedDateTime
Date and time of entry in local format of the server PC
DateTime
JourneyId A unique formatted id of the entryGUID
RequiredActionThe required action for unfinished jourenyString
HighLevelResultDetails The details of the high level result decision. This will include the reasons that caused the journey to refer Values will vary depending on the configured business rules to refer a journey
HighLevelResult The processing result, see Table for possible values String
ProcessedDocuments Collection of processed documents (see Processed Document object) Object
ReferenceNumber Unique entry reference number String
AuthenticationToleranceLevel
Applied Authentication Tolerance Level in journey String
LastDecisionThe status of the decisionObject
AdditionalData Set of Additional Data that linked to the journey Object
ProcessedLivenessThe details of the liveness stepObject
JourneyStepsThe details of the journey stepsList of JourneyStepDetail object

Possible Processing result for HighLevelResult:

Result
Description
Expired One or more of the documents in the case was expired
NotAccepted One or more of the documents in the case was not accepted by business rules
Notsupported One or more of the documents in the case was not recognized by IDES
Passed All documents in the case(entry) has passed the business rules and authentication checks
Refer One or more of the documents in the case did not pass authentication checks
Undefined The system does not have enough information to provide a decision on the case, possible reasons:
– System needs more documents or needs to scan the backside of the document as defined in business rules configurations.
– System needs to scan the document again due to bad image quality.

Processed Document Object:

KeyDescription
Format
IssuingCountryCode
The issuing country codeString, 3 digits ISO 3166-1 standard
IssuingCountryName The issuing country nameString
IssuingCountryState The issuing country state. Currently only returned for AustraliaString
DocumentCategory High level grouping of doc types as of Document Expert knowledge
String
DocumentImages A list of output image objects in the following format: “Role”: “WhiteImage”, “Url”: “Http URL to download the image in jpg format”List of Object
DocumentName Friendly name of the document including the issuing country name String
DocumentSide
The captured side of the document. String. Possible Values: “Front”, “Back”
DocumentType Determines the document type, e.g. Passport, Driving License, Resident Permit etc. (see Annex1 for possible values)String
ExtractedFields List of the extracted fields from doc, see “Extracted Field Object” List of Object
HighLevelResult The processing result for a particular document image, see Table for possible valuesString
IsValidated
Determines whether the doc was validated by the system or not.
Provides an access to the high level overall result of the library authentication on the document.
true: The document has passed the authentication checks with an overall successful result.
false: The document failed many of the authentication checks that pose a concern on document state.
undetermined: The state of the checks was inconclusive this might be because not enough; Authentication checks were carried on the document or the checks returned an intermediate result.
String “true”, “false” or “undetermined”
ScanDateTime Date and time of scanning the document imageDateTime
DigitalTamperingValidatorDetermines the document is tampered or not String “Passed” or “Failed
FaceMatchConfidenceScoreThe processing result confidence score of IDFM in case DocumentType is “Selfie Photo”. The returned value has been normalised so that any score less than 0.4 will indicate we do not have a match, any score above 0.6 is a match and scores in-between will indicate an uncertain result. Unlike above NoFace and Identical will produce errors.Float between 0 and 1

Last Decision Object:

KeyDescriptionFormat
DecisionCodeIf the journey is “notAccepted” then the decisionCode will be rejected, if it is “passed”, decisionCode will be accepted. In the other options (notSupported, Expired,Refer) the decisionCode will be rejected.overridable.String
DecisionDateTimeThis shows either the completion Date and time of the processed journey if it is not not overridden yet or shows the overridden date and time of overriding if the journey is overridden.DateTime
OriginIn automatic mode, the decisionCode will get the value from HLR. In Manual one, the decisionCode will be changed according to the reviewer decision.String

Extracted Field Object

KeyDescriptionFormat
NameName of the extracted fieldString
ValueThe extracted value from the documentString
OCRValueThe original OCR valueString
LocalValueThe local value from the documentString
OCRLocalValueThe original OCR local valueString

Processed Liveness Object

KeyDescriptionFormat
LivenessOverallResultThe liveness overall resultString
LivenessActionsThe details of the liveness actionObject

Liveness Action Object

KeyDescriptionFormat
ActionNoThe order of the actionString
ActionTypeThe type of the liveness actionString
ResultThe result of the liveness actionString
UrlThe URL of the liveness actionString

Journey Step Detail Object

KeyDescriptionFormat
TypeThe captured side of the documentString
HighLevelResultThe processing result for a particular document image, see Table for possible valuesString
ValidationCheckThe details of the high level result decision. This will include the reasons that caused the journey to referValues will vary depending on the configured business rules to refer a journey

Possible Processing result for High Level Result Details: 

Key Description Possible values 
DOCUMENTFRONTSIDETYPECHECK Indicates if the front scan is a front side document PASSED, FAILED, SKIPPED 
DOCUMENTBACKSIDETYPECHECK Indicates if the back scan is a backside document PASSED, FAILED, SKIPPED 
DOCUMENTBACKSIDECHECK Indicates if the backside is required on this journey or not DOCUMENTBACKSIDECHEK:SUCSESSNEEDED, DOCUMENTBACKSIDECHEK: NEEDED, DOCUMENTBACKSIDECHEK:SKIPPED 
UNDERAGERULE Indicates if the extracted date of birth is under the specified minimum allowed age or not PASSED, FAILED, SKIPPED 
DOCUMENTBLOCKINGPOLICY  Indicates if the scanned document is blocked or not PASSED, FAILED 
DOCUMENTEXPIRY Indicates if the scanned document is expired or not PASSED, FAILED, SKIPPED 
DOCUMENTSUPPORT Indicates if the scanned document is supported or not PASSED, FAILED 
DOCUMENTPROOFPOLICY Indicates if the scanned document is specified in the Acceptable document (whitelist) or not PASSED, FAILED, SKIPPED 
DOCUMENTVALIDATION Indicates if the scanned document is validated or not PASSED, FAILED, SKIPPED 
FACEMATCHVALIDATION Indicates if the provided selfie document is validated or not PASSED, FAILED, SKIPPED, UNDETERMINED 
ACCUMULATIVELIVENESSRESULT Indicates if the liveness session is passed or not PASSED, FAILED 

Request:

[GET] https://serviceurl/idscanenterprisesvc/journey/get?journeyId=13ccc9de-0e6c-4e18-8518-f7a7586cc316

Response:


Note: The structure of the response will be the same regardless of the document type but the extracted field list in this example is for demonstration purposes only; possible list of extracted fields depends on the document type being processed.

{
  "JourneyId": "461c9e05-3a0d-422b-8902-b3ce748b485a",
  "HighLevelResult": "Refer",
  "HighLevelResultDetails": [
    "DATEOFBITHCROSSCHECK:SKIPPED",
    "DOCUMENTNUMBERCROSSCHECK:SKIPPED",
    "DOCUMENTTYPECROSSCHECK:SKIPPED",
    "EXPIRYDATECROSSCHECK:SKIPPED",
    "FIRSTNAMECROSSCHECK:SKIPPED",
    "LASTNAMECROSSCHECK:SKIPPED",
    "PAPERDOCUMENTCROSSCHECK:SKIPPED",
    "FACEMATCHVALIDATION:PASSED",
    "CHIPPHOTOVALIDATION:PASSED",
    "UNDERAGERULE:PASSED",
    "DOCUMENTBACKSIDECHECK:NOTNEEDED",
    "DOCUMENTBLOCKINGPOLICY:PASSED",
    "DOCUMENTEXPIRY:PASSED",
    "DOCUMENTSUPPORT:PASSED",
    "DOCUMENTPROOFPOLICY:SKIPPED",
    "DOCUMENTVALIDATION:FAILED"

  ],
  "InitiatedDateTime": "2019-11-21T13:49:15.9717097",
  "ProcessedDocuments": [
    {
      "IssuingCountryCode": "GBR",
      "IssuingCountryName": "United Kingdom",
    //"IssuingStateName": "Australian Capital Territory", this information will be exposed for Australia country code only,
      "DocumentCategory": "Driving License",
      "DocumentType": "Driving License",
      "DocumentName": "United Kingdom - Driving License - Front - 2015",
      "DocumentSide": "Front",
      "IsValidated": "false",
      "ScanDateTime": "2019-11-21T13:49:15.9717097",
      "HighLevelResult": "Refer",
      "ExtractedFields": [
        {
          "Name": "AddressFull",
          "Value": "12 TORWOOD CRESCENT EDINBURGH EH12 9GJ",
          "OCRValue": "12 TORWOOD CRESCENT EDINBURGH EH12 9GJ",
          "LocalValue": "",
          "OCRLocalValue": ""
        },
        {
          "Name": "AddressCity",
          "Value": "EDINBURGH",
          "OCRValue": "EDINBURGH",
          "LocalValue": "",
          "OCRLocalValue": ""
        },
        {
          "Name": "AddressPostCode",
          "Value": "EH12 9GJ",
          "OCRValue": "EH12 9GJ",
          "LocalValue": "",
          "OCRLocalValue": ""
        },
        {
          "Name": "LastNameFirstPart",
          "Value": "MORGA",
          "OCRValue": "MORGA",
          "LocalValue": "",
          "OCRLocalValue": ""
        },
        {
          "Name": "Sex",
          "Value": "FEMALE",
          "OCRValue": "FEMALE",
          "LocalValue": "",
          "OCRLocalValue": ""
        },
        {
          "Name": "BirthPlace",
          "Value": "1 LA",
          "OCRValue": "1 LA",
          "LocalValue": "",
          "OCRLocalValue": ""
        },
        {
          "Name": "IssueNumber",
          "Value": "35",
          "OCRValue": "35",
          "LocalValue": "",
          "OCRLocalValue": ""
        },
        {
          "Name": "DocumentNumberCheckDigit",
          "Value": "IJ",
          "OCRValue": "IJ",
          "LocalValue": "",
          "OCRLocalValue": ""
        },
        {
          "Name": "BirthDate",
          "Value": "1976-03-11",
          "OCRValue": "1976-03-11",
          "LocalValue": "",
          "OCRLocalValue": ""
        },
        {
          "Name": "DocumentNumber",
          "Value": "MORGA753116SM9IJ 35",
          "OCRValue": "MORGA753116SM9IJ 35",
          "LocalValue": "",
          "OCRLocalValue": ""
        },
        {
          "Name": "FirstName",
          "Value": "SARAH",
          "OCRValue": "SARAH",
          "LocalValue": "",
          "OCRLocalValue": ""
        },
        {
          "Name": "ArbitraryDigit",
          "Value": "9",
          "OCRValue": "9",
          "LocalValue": "",
          "OCRLocalValue": ""
        },
        {
          "Name": "FirstNameInitial",
          "Value": "SM",
          "OCRValue": "SM",
          "LocalValue": "",
          "OCRLocalValue": ""
        },
        {
          "Name": "ExpiryDate",
          "Value": "2023-01-18",
          "OCRValue": "2023-01-18",
          "LocalValue": "",
          "OCRLocalValue": ""
        },
        {
          "Name": "IssueDate",
          "Value": "2013-01-19",
          "OCRValue": "2013-01-19",
          "LocalValue": "",
          "OCRLocalValue": ""
        },
        {
          "Name": "LastName",
          "Value": "MORGAN",
          "OCRValue": "MORGAN",
          "LocalValue": "",
          "OCRLocalValue": ""
        },
        {
          "Name": "LicenseCategory",
          "Value": "AM/A/B1/B/F/K/I/N/P/Q",
          "OCRValue": "AM/A/B1/B/F/K/I/N/P/Q",
          "LocalValue": "",
          "OCRLocalValue": ""
        },
        {
          "Name": "DocumentCategory",
          "Value": "Driving License",
          "OCRValue": "Driving License"
        },
        {
          "Name": "DocumentType",
          "Value": "Driving License",
          "OCRValue": "Driving License"
        }
      ],
      "DocumentImages": [
        {
          "Role": "WhiteImage",
          "Url": "https://poc.idscan.cloud/IDScanEnterpriseSvc/Search/GetImage?id=913dfe8f-be68-47e9-ae3d-1e281bdd55af&role=OutputWhiteImage"
        },
        {
          "Role": "DigitalTamperingHeatmapImage",
          "Url": "https://poc.idscan.cloud/IDScanEnterpriseSvc/Search/GetImage?id=913dfe8f-be68-47e9-ae3d-1e281bdd55af&role=DigitalTamperingHeatmapImage"
        },
        {
          "Role": "FacePortraitImage",
          "Url": "https://poc.idscan.cloud/IDScanEnterpriseSvc/Search/GetImage?id=913dfe8f-be68-47e9-ae3d-1e281bdd55af&role=FacePortraitImage"
        }
      ],
      "DigitalTamperingValidator": "Passed"
    }
  ],
  "ReferenceNumber": "1000010181",
  "AuthenticationToleranceLevel": "medium",
  "LastDecision": {
    "DecisionCode": "Rejected.Overridable",
    "DecisionDateTime": "21/11/2019 13:49:16",
    "DecisionId": "00000000-0000-0000-0000-000000000000",
    "Origin": "Automatic"
  },
  "AdditionalData": [
    {
      "Name": "BranchCode",
      "Value": "1234"
    },
    {
      "Name": "CustomerNumber",
      "Value": "c1234"
    },
    {
      "Name": "Channel",
      "Value": "Postman"
    },
    {
      "Name": "UserName",
      "Value": "psc"
    },
    {
      "Name": "RequiredJourneySteps",
      "Value": "BACKSIDE,FRONTSIDE"
    },
    {
      "Name": "UnderAgeRuleResult",
      "Value": "PASSED"
    }
  ]
},
 "JourneySteps": [ 
    { 
      "Type": "FRONTSIDE", 
      "HighLevelresult": "Passed", 
      "ValidationChecks": [ 
        "DOCUMENTFRONTSIDETYPECHECK:PASSED", 
        "UNDERAGERULE:PASSED", 
        "DOCUMENTBLOCKINGPOLICY:PASSED", 
        "DOCUMENTSUPPORT:PASSED", 
        "DOCUMENTVALIDATION:PASSED" 
      ] 
    }, 
    { 
      "Type": "SELFIE", 
      "HighLevelresult": "Passed", 
      "ValidationChecks": [] 
    }, 
    { 
      "Type": "LIVENESS", 
      "HighLevelResult": "Refer", 
      "ValidationChecks": [ 
        "LIVENESSFINALRESULT:FAILED" 
      ] 
    } 
  ] 
 
}  

End of retrieval response example.

Was this page helpful?