IDScan

Response Content

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.

Attribute
Description
Type

InitiatedDateTime

Date and time of entry in local format of the server PC

DateTime

JourneyId

A unique formatted id of the entry

GUID

RequiredAction

The required action for unfinished joureny

String

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

LastDecision

The status of the decision

Object

AdditionalData

Set of Additional Data that linked to the journey

Object

ProcessedLiveness

The details of the liveness step

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:

Attribute
Description
Type

IssuingCountryCode

The issuing country code

String, 3 digits ISO 3166-1 standard

IssuingCountryName

The issuing country name

String

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. Possible Values: “Front”, “Back”

String

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 values

String

IsValidated

Determines whether the doc was validated by the system or not. 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 image

DateTime

DigitalTamperingValidator

Determines the document is tampered or not

String “Passed” or “Failed”

FaceMatchConfidenceScore

The 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:

Attribute
Description
Type

DecisionCode

If 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

DecisionDateTime

This 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

Origin

In 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:

Attribute
Description
Type

Name

Name of the extracted field

String

Value

The extracted value from the document

String

OCRValue

The original OCR value

String

LocalValue

The local value from the document

String

OCRLocalValue

The original OCR local value

String

Processed Liveness Object:

Attribute
Description
Type

LivenessOverallResult

The liveness overall result

String

LivenessActions

The details of the liveness action

Object

Liveness Action Object:

Attribute
Description
Type

ActionNo

The order of the action

String

ActionType

The type of the liveness action

String

Result

The result of the liveness action

String

Url

The URL of the liveness action

String

Example 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",
       "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" 
      } 
    ] 
  }  
 } 

List of Possible Extracted Fields from IDscan Document Expert System:

Field Name
Description

AddressBuildingName

The building name of the address

AddressBuildingNumber

The building number of the address

AddressCity

The city of the address

AddressCountry

The country of the address

AddressDeliveryPointIdentifier

The delivery point identifier (DPID) of the address

AddressDistrict

The district of the address

AddressFull

The full address (all lines)

AddressLine1

The first line of the address

AddressLine2

The second line of the address

AddressLine3

The third line of the address

AddressLine4

The fourth line of the address

AddressLine5

The fifth line of the address

AddressPostCode

The post code of the address

AddressPostCodeType

The postcode type of the address

AddressState

The state of the address

AddressStateCode

The state code of the address

AddressStreet

The street of the address

AddressStreetSuffix

The street suffix of the address

AddressStreetType

The street type of the address

AddressStreetTypeAbbreviation

The street abbreviation of the address

AddressSubBuildingName

The sub-building name of the address

AddressSubBuildingNumber

The sub-building number of the address

AddressUnitNumber

The unit number of the address

AddressUnitType

The unit type of the address

AgeCategory

The category into which the document holder’s age falls

AlienNumber

The alien number extracted from the document

ArbitraryDigit

The arbitrary digit of the document number field

BankCardSecurityCode

The security code on the bank card

BankCardType

The type of bank card

BarcodeItems

Collection of generic barcode items

BirthDate

The birth date of person in the document in ISO 8601 format

BirthPlace

The document holder’s place of birth extracted from the document

BirthPlaceCity

The city in which the document holder was born in, extracted from the document

BirthPlaceCountry

The Country in which the document holder was born in, extracted from the doc.

BirthPlaceState

The State in which the documentholder was born in, extracted from the doc.

BOSNumber

The BOS number of the document

CardNumber

The card number of the document

ChildrenCount

The total number of children the document holder has

Conditions

The conditions which are mentioned in the document

Constraints

Any constraint that is mentioned in the document

CreditCardNumber

The number on the credit card

CustomerNumber

The customer number of the document

DistinguishingMarks

The distinguishing marks of the document holder

DocumentNumber

The identifying number of the doc. such as doc no., driver no., passport no.

DocumentNumberCheckDigit

The check digit character of the document number field

DocumentTypeCode

The code type of the document.

Donor

Determine if the document holder is an organ donor, this is used when somebody is killed by accident and their organ can be transferred to another person.

Employer

The name of the employer extracted from the document.

Endorsements

Any endorsement that is mentioned in the document.

EntryMode

The mode of allowed entries for the document holder. Values such as Multi or Single could be used.

ExpiryDate

The expiration date of the document in ISO 8601 format

ExpiryDate2

The second expiry date of the document in ISO 8601 format

ExpiryDate3

The third expiry date of the document in ISO 8601 format

ExpiryDate4

The fourth expiry date of the document in ISO 8601 format

EyeColor

The eye colour of the document holder

FatherName

The father name extracted from the document

Fingerprint

The finger print extracted from the document

FirstIssuanceDate

The first issue date of this document in ISO 8601 format

FirstName

The first name extracted from the document

FirstNameInitial

The first character of the first name extracted from the document

FullName

The full name extracted from document

HairColor

The hair colour of the document holder

HealthNumber

The health number extracted from the document

Height

The height of the document holder

Hologram

The hologram extracted from the document

IssueDate

The issue date of the document in ISO 8601 format

IssueDate2

The second issue date of the document in ISO 8601 format

IssueDate3

The third issue date of the document in ISO 8601 format

IssueDate4

The fourth issue date of the document in ISO 8601 format

IssueNumber

The issue number extracted from the document

IssuingAuthority

The authority issuing the document

IssuingAuthorityType

The type of the authority issuing the document

IssuingLocation

The location where the document was issued

LastName

The last name extracted from the document

LastNameFirstPart

The first few characters of the last name extracted from the document

LensData

The lens data of the document holder

LicenseCategory

The license category of the document

LicenseCategory2

The second license category of the document

LicenseCategory3

The third license category of the document

LicenseCategory4

The fourth license category of the document

LicenseNumber

The license number of the document

LicenseType

The type of the license specified in the document.

LicenseType2

The second type of the license specified in the document.

LicenseType3

The third type of the license specified in the document.

LicenseType4

The fourth type of the license specified in the document.

MaritalStatus

The marital status of the document holder (single or married).

MembershipNumber

The membership number extracted from the document

MiddleName

The middle name extracted from the document

MiddleNameInitial

The first character of the middle name

MotherName

The mother name extracted from the document

MRZBirthDateCheckDigit

The check digit of the date of birth contained in the MRZ

MRZCode1

The first letter of the MRZ which specifies the first part of the MRZ code. This can specify the type of the doc. such as P for passports, I for identity cards and so on

MRZCode2

The second letter of the MRZ which specifies the second part of the MRZ code. This can specify the subtype of the document and is country-specific

MRZCompositeCheckDigit

The composite check digit of the MRZ

MRZDocumentNumberCheckDigit

The check digit of the document number contained in the MRZ

MRZExpiryDateCheckDigit

The check digit of the expiry date contained in the MRZ

MRZFull

The full MRZ (all lines)

MRZLine1

The first line of the MRZ

MRZLine2

The second line of the MRZ

MRZLine3

The third line of the MRZ

MRZPersonalNumberCheckDigit

The check digit of the personal number contained in the MRZ

MRZStandardType

The standard type of the ICAO document

NationalInsuranceNumber

The National Insurance number extracted from the document

NationalityCode

The nationality ISO code of the document holder

NationalityName

The nationality of the document holder

ObservationPage

The observation page number of the document

Occupation

The occupation of the document holder

Parents

The names of the document holder’s parents

PeriodOfStay

The allowed period for stay extracted from the document

PermitNumber

The permit number of the document

PersonalNumber

The personal number extracted from the document

PortraitPhoto

The document holder’s photo extracted from the document

Race

The race of the document holder

ReferenceNumber

The reference number of the document

Remarks

Any remark mentioned in the document

RFIDG1

The raw data from RFID (Data Group 1)

RFIDG15

The raw data from RFID (Data Group 15)

RFIDG2

The raw data from RFID (Data Group 2)

RFIDG3

The raw data from RFID (Data Group 3)

RFIDPortraitPhoto

The document holder’s photo stored in the biometric chip (after decoding)

RFIDSOD

The raw data from RFID

SecondaryPortraitPhoto

The second portrait photo extracted from the document if exists

SecondLastName

The second last name extracted from the document. This is special case in some documents where the two last names exist

Sex

The gender of the document holder

Signature

The signature of the document holder (Image)

SocialSecurityNumber

The social security number extracted from the document

StudentID

The student identification number extracted from the document

TaxNumber

The tax number extracted from the document

Title

The title of the document holder such as Mr, Ms and so on

VAFNumber

The visa application form number extracted from the document

VersionNumber

The version number of the document

Weight

The weight of the document holder

Possible extracted fields from utility bills, bank statements and other non-ID documents:

Field
Description

DocumentCategory

High level category of the document type

DocumentType

Type of the document as recognised by IDscan Document Expert System

IssueDate

Issuing date of the document

Issuer

Issuer of the document. For example the bank name in case of bank statements

Logo

Logo of the issuer of the document if present on the document

RecipientAddress

Full address of the recipient, the entity addressed in the document

RecipientName

Name of the entity(s) addressed in this document. Could be one person or more or a company

List of document types supported in IDscan:

Agents License Driving License Electoral Card Foreigner Identification Card Health Card Job License Membership Identification Card Military Identification Card National Identification Card Passport Proof of Age Card Travel Permit Visa Weapons Licence

List of supporting supported non-ID document types:

Account Statement Agreement (Tenancy) Bank Document Bank Letter Bank Statement Benefit Letter Certificate (Birth, Marriage, Civil partnership) Council Document Council Letter Council Tax Driving Licence DWP Document HMRC Document Information Sheet Insurance Document Insurance Letter Invoice NIC Letter NINO Letter Official Document Official Letter Repayment Letter (related to Tax or Social support) Tax Letter Tax Statement Telephone Bill Telephone Letter Telecommunication Document TV Licence University Letter Utility Bill Utility Document Utility Letter Water Bill Water Document

Last updated