ID Capture Document
Defined under the namespace Scandit.Datacapture.Id
- IdCaptureDocumentType
Added in version 7.0.0
Types associated with the document classes below
- DriverLicense
Added in version 7.0.0
Driver license identification document. Associated with DriverLicense.
- RegionSpecific
Added in version 7.0.0
Region specific identification document. Associated with RegionSpecific.
- ResidencePermit
Added in version 7.0.0
Residence Permit. Associated with ResidencePermit.
- HealthInsuranceCard
Added in version 7.0.0
Health insurance card. Associated with HealthInsuranceCard.
- IdCaptureDocument
abstract class IdCaptureDocumentAdded in version 7.0.0
Base class for IdCaptureDocument subtypes that follow
- region
get region(): Region
Added in version 7.0.0
Geographical region associated with the identification document.
- documentType
readonly documentType: IdCaptureDocumentType
Added in version 7.0.0
Enum IdCaptureDocumentType associated with this instance.
- isIdCard()
isIdCard(): boolean
Added in version 7.0.0
Indicates whether the document is of type IdCard
- isDriverLicense()
isDriverLicense(): boolean
Added in version 7.0.0
Indicates whether the document is of type DriverLicense.
- isPassport()
isPassport(): boolean
Added in version 7.0.0
Indicates whether the document is of type Passport.
- isVisaIcao()
isVisaIcao(): boolean
Added in version 7.0.0
Indicates whether the document is of type VisaIcao.
- isRegionSpecific()
isRegionSpecific(): boolean
Added in version 7.0.0
Indicates whether the document is of type RegionSpecific.
- isResidencePermit()
isResidencePermit(): boolean
Added in version 7.0.0
Indicates whether the document is of type ResidencePermit.
- isHealthInsuranceCard()
isHealthInsuranceCard(): boolean
Added in version 7.0.0
Indicates whether the document is of type HealthInsuranceCard.
ID Card
- IdCard
class IdCard : IdCaptureDocument
Added in version 7.0.0
ID card identification document.
- constructor(region)
constructor(region: Region)
Added in version 7.0.0
Creates a new IdCard instance.
- region
get region(): Region
Added in version 7.0.0
Geographical region associated with the identification document.
- documentType
readonly documentType: IdCaptureDocumentType
Added in version 7.0.0
Enum IdCaptureDocumentType associated with this instance.
Driver License
- DriverLicense
class DriverLicense : IdCaptureDocument
Added in version 7.0.0
Driver license identification document.
- constructor(region)
constructor(region: Region)
Added in version 7.0.0
Creates a new DriverLicense instance.
- region
get region(): Region
Added in version 7.0.0
Geographical region associated with the identification document.
- documentType
readonly documentType: IdCaptureDocumentType
Added in version 7.0.0
Enum IdCaptureDocumentType associated with this instance.
Passport
- Passport
class Passport : IdCaptureDocument
Added in version 7.0.0
Passport identification document.
- constructor(region)
constructor(region: Region)
Added in version 7.0.0
Creates a new Passport instance.
- region
get region(): Region
Added in version 7.0.0
Geographical region associated with the identification document.
- documentType
readonly documentType: IdCaptureDocumentType
Added in version 7.0.0
Enum IdCaptureDocumentType associated with this instance.
Visa (ICAO)
- VisaIcao
class VisaIcao : IdCaptureDocument
Added in version 7.0.0
Visa (ICAO) identification document.
- constructor(region)
constructor(region: Region)
Added in version 7.0.0
Creates a new VisaIcao instance.
- region
get region(): Region
Added in version 7.0.0
Geographical region associated with the identification document.
- documentType
readonly documentType: IdCaptureDocumentType
Added in version 7.0.0
Enum IdCaptureDocumentType associated with this instance.
Region Specific
- RegionSpecific
class RegionSpecific : IdCaptureDocument
Added in version 7.0.0
Region specific identification document.
- constructor(subtype)
constructor(subtype: RegionSpecificSubtype)
Added in version 7.0.0
Creates a new RegionSpecific instance.
- region
get region(): Region
Added in version 7.0.0
Geographical region associated with the identification document.
- documentType
readonly documentType: IdCaptureDocumentType
Added in version 7.0.0
Enum IdCaptureDocumentType associated with this instance.
- subtype
readonly subtype: RegionSpecificSubtype
Added in version 7.0.0
Enum RegionSpecificSubtype indicating the region-specific subtype associated with this instance.
Residence Permit
- ResidencePermit
class ResidencePermit : IdCaptureDocument
Added in version 7.0.0
Residence permit.
- constructor(region)
constructor(region: Region)
Added in version 7.0.0
Creates a new ResidencePermit instance.
- region
get region(): Region
Added in version 7.0.0
Geographical region associated with the identification document.
- documentType
readonly documentType: IdCaptureDocumentType
Added in version 7.0.0
Enum IdCaptureDocumentType associated with this instance.
Health Insurance Card
- HealthInsuranceCard
class HealthInsuranceCard : IdCaptureDocument
Added in version 7.0.0
Health insurance card.
- constructor(region)
constructor(region: Region)
Added in version 7.0.0
Creates a new HealthInsuranceCard instance.
- region
get region(): Region
Added in version 7.0.0
Geographical region associated with the identification document.
- documentType
readonly documentType: IdCaptureDocumentType
Added in version 7.0.0
Enum IdCaptureDocumentType associated with this instance.