Document Data Extractor
Document Data Extractor UI
ScanbotSDK.UI.startDocumentDataExtractor(configuration: DocumentDataExtractorScreenConfiguration)
The Scanbot SDK provides the ability to detect various types of documents in an image, crop them and recognize data fields via the Document Data Extractor.
Currently, the Document Data Extractor supports the following types of documents:
- German ID Card
- German Passport
- German Driver's license
- German Residence permit
- German Health Insurance Card (front side)
- European Health Insurance Card
The Document Data Extractor is based on the SCANBOT OCR engine and doesn't require the installation of the OCR language files
Document Data Extractor usage example
Document Data Extractor hook example
loading...
Parameters
Document Data Extractor Configuration
Returns
Document Data Extractor Result
Document Type:
The document type can be one of the following.
Extract Document Data on still image
Document Data can be extracted on still images in the following manner:
Extract Document Data on still image
loading...
The result handing is the same as Document Data Extractor.
Available documents and fields
DeDriverLicenseBack
DeDriverLicenseBack.Category.ADeDriverLicenseBack.Category.A1DeDriverLicenseBack.Category.A2DeDriverLicenseBack.Category.AMDeDriverLicenseBack.Category.BDeDriverLicenseBack.Category.B1DeDriverLicenseBack.Category.BEDeDriverLicenseBack.Category.CDeDriverLicenseBack.Category.C1DeDriverLicenseBack.Category.C1EDeDriverLicenseBack.Category.CEDeDriverLicenseBack.Category.DDeDriverLicenseBack.Category.D1DeDriverLicenseBack.Category.D1EDeDriverLicenseBack.Category.DEDeDriverLicenseBack.Category.LDeDriverLicenseBack.Category.T
DeDriverLicenseFront
DeDriverLicenseFront.BirthDateDeDriverLicenseFront.BirthplaceDeDriverLicenseFront.ExpiryDateDeDriverLicenseFront.GivenNamesDeDriverLicenseFront.IDDeDriverLicenseFront.IssueDateDeDriverLicenseFront.IssuingAuthorityDeDriverLicenseFront.LicenseCategoriesDeDriverLicenseFront.PhotoDeDriverLicenseFront.SignatureDeDriverLicenseFront.Surname
DeIdCardBack
DeIdCardBack.AddressDeIdCardBack.EyeColorDeIdCardBack.HeightDeIdCardBack.IssueDateDeIdCardBack.IssuingAuthorityDeIdCardBack.PseudonymDeIdCardBack.RawMRZDeIdCardBack.MRZ.${MRZ_FIELD_NAME}- (check MRZ field names below)
DeIdCardFront
DeIdCardFront.BirthDateDeIdCardFront.BirthplaceDeIdCardFront.CardAccessNumberDeIdCardFront.ExpiryDateDeIdCardFront.GivenNamesDeIdCardFront.IDDeIdCardFront.MaidenNameDeIdCardFront.NationalityDeIdCardFront.PhotoDeIdCardFront.SignatureDeIdCardFront.Surname
DePassport
DePassport.BirthDateDePassport.BirthplaceDePassport.CountryCodeDePassport.ExpiryDateDePassport.GenderDePassport.GivenNamesDePassport.IDDePassport.IssueDateDePassport.IssuingAuthorityDePassport.MaidenNameDePassport.NationalityDePassport.PassportTypeDePassport.PhotoDePassport.RawMRZDePassport.SignatureDePassport.SurnameDePassport.MRZ.${MRZ_FIELD_NAME}- (check MRZ field names below)
DeResidencePermitFront
DeResidencePermitFront.BirthDateDeResidencePermitFront.CardAccessNumberDeResidencePermitFront.ExpiryDateDeResidencePermitFront.GenderDeResidencePermitFront.GivenNamesDeResidencePermitFront.IDDeResidencePermitFront.NationalityDeResidencePermitFront.PhotoDeResidencePermitFront.PlaceOfIssueDeResidencePermitFront.RemarksDeResidencePermitFront.SignatureDeResidencePermitFront.SurnameDeResidencePermitFront.TitleTypeDeResidencePermitFront.ValidFrom
DeResidencePermitBack
DeResidencePermitBack.AddressDeResidencePermitBack.BirthDateDeResidencePermitBack.BirthplaceDeResidencePermitBack.EyeColorDeResidencePermitBack.GenderDeResidencePermitBack.HeightDeResidencePermitBack.IssuingAuthorityDeResidencePermitBack.NationalityDeResidencePermitBack.RawMRZDeResidencePermitBack.RemarksDeResidencePermitBack.MRZ.${MRZ_FIELD_NAME}- (check MRZ field names below)
DeHealthInsuranceCardFront
DeHealthInsuranceCardFront.CardAccessNumberDeHealthInsuranceCardFront.IssuerNameDeHealthInsuranceCardFront.IssuerNumberDeHealthInsuranceCardFront.NameDeHealthInsuranceCardFront.PersonalNumber
EuropeanHealthInsuranceCard
EuropeanHealthInsuranceCard.BarcodeEuropeanHealthInsuranceCard.BirthDateEuropeanHealthInsuranceCard.CardNumberEuropeanHealthInsuranceCard.CountryCodeEuropeanHealthInsuranceCard.ExpiryDateEuropeanHealthInsuranceCard.GivenNamesEuropeanHealthInsuranceCard.IssuerNameEuropeanHealthInsuranceCard.IssuerNumberEuropeanHealthInsuranceCard.PersonalNumberEuropeanHealthInsuranceCard.SignatureEuropeanHealthInsuranceCard.Surname
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 LicenseWhat do you think of this documentation?
What can we do to improve it? Please be as detailed as you like.