Skip to main content

Generic Document Recognizer

Generic Document Recognizer UI​

ScanbotSDK.UI.startGenericDocumentRecognizer(configuration: GenericDocumentRecognizerConfiguration)​

The Scanbot SDK provides the ability to detect various types of documents in an image, crop them and recognize data fields via the Generic Document Recognizer.

alt

Currently, the Generic Document Recognizer supports the following types of documents:

  • German ID Card
  • German Passport
  • German Driver's license
  • German Residence permit

The Generic Document Recognizer is based on the OCR feature and thus requires the proper installation of the OCR language files deu.traineddata and eng.traineddata (aka. blob files). For more details on how to set up OCR language files please refer to the OCR section.

Generic Document Recognizer usage example​

Generic Document Recognizer hook example
loading...

Parameters​

Generic Document Scanner Configuration

Returns​

Generic Document Scanner Result

Document Type:​

The document type can be one of the following.

Recognize Generic Document on still image​

A Generic Document can also be recognized on still images in the following manner:

Generic Document on still image
loading...

The result handing is the same as Generic Document Recognizer.

Available documents and fields​

DeDriverLicenseBack​

  • DeDriverLicenseBack.Restrictions
  • DeDriverLicenseBack.Category.Restrictions
  • DeDriverLicenseBack.Category.ValidFrom
  • DeDriverLicenseBack.Category.ValidUntil

DeDriverLicenseFront​

  • DeDriverLicenseFront.BirthDate
  • DeDriverLicenseFront.Birthplace
  • DeDriverLicenseFront.ExpiryDate
  • DeDriverLicenseFront.GivenNames
  • DeDriverLicenseFront.ID
  • DeDriverLicenseFront.IssueDate
  • DeDriverLicenseFront.IssuingAuthority
  • DeDriverLicenseFront.LicenseCategories
  • DeDriverLicenseFront.Photo
  • DeDriverLicenseFront.Signature
  • DeDriverLicenseFront.Surname

DeIdCardBack​

  • DeIdCardBack.Address
  • DeIdCardBack.EyeColor
  • DeIdCardBack.Height
  • DeIdCardBack.IssueDate
  • DeIdCardBack.IssuingAuthority
  • DeIdCardBack.Pseudonym
  • DeIdCardBack.RawMRZ
  • DeIdCardBack.MRZ.${MRZ_FIELD_NAME} - (check MRZ field names below)

DeIdCardFront​

  • DeIdCardFront.BirthDate
  • DeIdCardFront.Birthplace
  • DeIdCardFront.ExpiryDate
  • DeIdCardFront.GivenNames
  • DeIdCardFront.ID
  • DeIdCardFront.MaidenName
  • DeIdCardFront.Nationality
  • DeIdCardFront.PIN
  • DeIdCardFront.Photo
  • DeIdCardFront.Signature
  • DeIdCardFront.Surname

DePassport​

  • DePassport.BirthDate
  • DePassport.Birthplace
  • DePassport.CountryCode
  • DePassport.ExpiryDate
  • DePassport.Gender
  • DePassport.GivenNames
  • DePassport.ID
  • DePassport.IssueDate
  • DePassport.IssuingAuthority
  • DePassport.MaidenName
  • DePassport.Nationality
  • DePassport.PassportType
  • DePassport.Photo
  • DePassport.RawMRZ
  • DePassport.Signature
  • DePassport.Surname
  • DePassport.MRZ.${MRZ_FIELD_NAME} - (check MRZ field names below)

DeResidencePermitFront​

  • DeResidencePermitFront.BirthDate
  • DeResidencePermitFront.ExpiryDate
  • DeResidencePermitFront.Gender
  • DeResidencePermitFront.GivenNames
  • DeResidencePermitFront.ID
  • DeResidencePermitFront.Nationality
  • DeResidencePermitFront.PIN
  • DeResidencePermitFront.Photo
  • DeResidencePermitFront.PlaceOfIssue
  • DeResidencePermitFront.Remarks
  • DeResidencePermitFront.Signature
  • DeResidencePermitFront.Surname
  • DeResidencePermitFront.TitleType
  • DeResidencePermitFront.ValidFrom

DeResidencePermitBack​

  • DeResidencePermitBack.Address
  • DeResidencePermitBack.BirthDate
  • DeResidencePermitBack.Birthplace
  • DeResidencePermitBack.EyeColor
  • DeResidencePermitBack.Gender
  • DeResidencePermitBack.Height
  • DeResidencePermitBack.IssuingAuthority
  • DeResidencePermitBack.Nationality
  • DeResidencePermitBack.RawMRZ
  • DeResidencePermitBack.Remarks
  • DeResidencePermitBack.MRZ.${MRZ_FIELD_NAME} - (check MRZ field names below)

MRZ Field Names​

  • ${DOCUMENT_NAME}.MRZ.BirthDate
  • ${DOCUMENT_NAME}.MRZ.CheckDigitBirthDate
  • ${DOCUMENT_NAME}.MRZ.CheckDigitDocumentNumber
  • ${DOCUMENT_NAME}.MRZ.CheckDigitExpiryDate
  • ${DOCUMENT_NAME}.MRZ.CheckDigitGeneral
  • ${DOCUMENT_NAME}.MRZ.CheckDigitPersonalNumber
  • ${DOCUMENT_NAME}.MRZ.DateOfIssuance
  • ${DOCUMENT_NAME}.MRZ.DocumentNumber
  • ${DOCUMENT_NAME}.MRZ.DocumentTypeCode
  • ${DOCUMENT_NAME}.MRZ.ExpiryDate
  • ${DOCUMENT_NAME}.MRZ.Gender
  • ${DOCUMENT_NAME}.MRZ.GivenNames
  • ${DOCUMENT_NAME}.MRZ.IssuingAuthority
  • ${DOCUMENT_NAME}.MRZ.LanguageCode
  • ${DOCUMENT_NAME}.MRZ.Nationality
  • ${DOCUMENT_NAME}.MRZ.OfficeOfIssuance
  • ${DOCUMENT_NAME}.MRZ.Optional1
  • ${DOCUMENT_NAME}.MRZ.Optional2
  • ${DOCUMENT_NAME}.MRZ.PINCode
  • ${DOCUMENT_NAME}.MRZ.PersonalNumber
  • ${DOCUMENT_NAME}.MRZ.Surname
  • ${DOCUMENT_NAME}.MRZ.TravelDocType
  • ${DOCUMENT_NAME}.MRZ.TravelDocTypeVariant
  • ${DOCUMENT_NAME}.MRZ.VersionNumber
  • ${DOCUMENT_NAME}.MRZ.VisaOptional

Want to scan longer than one minute?

Generate a free trial license to test the Scanbot SDK thoroughly.

Get your free Trial License

What do you think of this documentation?

On this page

Scroll to top