ID Capture Document

Defined in framework ScanditIdCapture

enum IdCaptureDocumentType

Added in version 7.0.0

Types associated with the document classes below

idCard

Added in version 7.0.0

ID card identification document. Associated with IdCard.

driverLicense

Added in version 7.0.0

Driver license identification document. Associated with DriverLicense.

passport

Added in version 7.0.0

Passport identification document. Associated with Passport.

visaIcao

Added in version 7.0.0

Visa (ICAO) identification document. Associated with VisaIcao.

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.

allCases

static var allCases: Array<IdCaptureDocumentType> { get }

Added in version 7.0.0

Returns all subtypes as array.

description

var description: String { get }

Added in version 7.0.0

Returns a name for the given IdCaptureDocumentType.

IdCaptureDocument

open class IdCaptureDocument : NSObject

Added in version 7.0.0

A category of documents, such as ID cards, driver’s licenses, or passports.

region

open var region: IdCaptureRegion { get }

Added in version 7.0.0

Specifies the region (e.g., country) where the document was issued.

documentType

open var documentType: IdCaptureDocumentType { get }

Added in version 7.0.0

Enum IdCaptureDocumentType associated with this instance.

isIdCard

open func isIdCard() -> Bool

Added in version 7.0.0

Indicates whether the document is of type IdCard.

isDriverLicense

open func isDriverLicense() -> Bool

Added in version 7.0.0

Indicates whether the document is of type DriverLicense.

isPassport

open func isPassport() -> Bool

Added in version 7.0.0

Indicates whether the document is of type Passport.

isVisaIcao

open func isVisaIcao() -> Bool

Added in version 7.0.0

Indicates whether the document is of type VisaIcao.

isRegionSpecific

open func isRegionSpecific() -> Bool

Added in version 7.0.0

Indicates whether the document is of type RegionSpecific.

isResidencePermit

open func isResidencePermit() -> Bool

Added in version 7.0.0

Indicates whether the document is of type ResidencePermit.

isHealthInsuranceCard

open func isHealthInsuranceCard() -> Bool

Added in version 7.0.0

Indicates whether the document is of type HealthInsuranceCard.

ID Card

IdCard

open class IdCard : IdCaptureDocument

Added in version 7.0.0

A category of state-issued documents primarily designed to confirm a citizen’s identity, voting rights, or age. This category includes documents commonly referred to as ID Cards, Voting IDs, and Proof of Age Cards. It also encompasses Passport Cards issued by certain jurisdictions, which provide limited travel rights.

While other documents (e.g., driver’s licenses, passports, residence permits) may serve as identification in certain regions, they are not included in this category.

init

init(region: IdCaptureRegion)

Added in version 7.0.0

Creates a new IdCard instance.

document

open class func document(with region: IdCaptureRegion) -> Self

Added in version 7.0.0

Creates a new IdCard instance.

Driver License

DriverLicense

open class DriverLicense : IdCaptureDocument

Added in version 7.0.0

A category of documents that confirms the holder’s right to drive or operate vehicles.

init

init(region: IdCaptureRegion)

Added in version 7.0.0

Creates a new DriverLicense instance.

document

open class func document(with region: IdCaptureRegion) -> Self

Added in version 7.0.0

Creates a new DriverLicense instance.

Passport

Passport

open class Passport : IdCaptureDocument

Added in version 7.0.0

A category of official government-issued documents that verify a person’s identity and nationality, enabling international travel.

Passport Cards and other documents used for regional travel are not included in this category.

init

init(region: IdCaptureRegion)

Added in version 7.0.0

Creates a new Passport instance.

document

open class func document(with region: IdCaptureRegion) -> Self

Added in version 7.0.0

Creates a new Passport instance.

Visa (ICAO)

VisaIcao

open class VisaIcao : IdCaptureDocument

Added in version 7.0.0

A category of travel documents that temporarily permit a foreigner to enter, remain in, or leave the issuing jurisdiction. Only documents that comply with the ICAO Machine Readable Travel Document (MRTD) standard are included in this category.

This category does not include documents that grant similar privileges but do not adhere to the ICAO MRTD standard, such as the US Border Crossing Card or travel permits for autonomous regions like Hong Kong and Macao issued by China.

init

init(region: IdCaptureRegion)

Added in version 7.0.0

Creates a new VisaIcao instance.

document

open class func document(with region: IdCaptureRegion) -> Self

Added in version 7.0.0

Creates a new VisaIcao instance.

Region Specific

RegionSpecific

open class RegionSpecific : IdCaptureDocument

Added in version 7.0.0

A category of documents that do not fall into other established categories and lack a recognized international standard. These documents grant privileges or serve specific purposes within a particular region or jurisdiction, often related to local regulations or services.

init

init(subtype: RegionSpecificSubtype)

Added in version 7.0.0

Creates a new RegionSpecific instance.

document

open class func document(with subtype: RegionSpecificSubtype) -> Self

Added in version 7.0.0

Creates a new RegionSpecific instance.

subtype

open var subtype: RegionSpecificSubtype { get }

Added in version 7.0.0

Enum RegionSpecificSubtype indicating the region-specific subtype associated with this instance.

Residence Permit

ResidencePermit

open class ResidencePermit : IdCaptureDocument

Added in version 7.0.0

A category of documents issued to confirm the identity of non-citizens and their right to reside for an extended period within a given jurisdiction. These are sometimes referred to as Resident IDs or Alien IDs.

init

init(region: IdCaptureRegion)

Added in version 7.0.0

Creates a new ResidencePermit instance.

document

open class func document(with region: IdCaptureRegion) -> Self

Added in version 7.0.0

Creates a new ResidencePermit instance.

Health Insurance Card

HealthInsuranceCard

open class HealthInsuranceCard : IdCaptureDocument

Added in version 7.0.0

A category of documents that provide proof of an individual’s health insurance coverage, typically issued by a health insurer or government agency.

init

init(region: IdCaptureRegion)

Added in version 7.0.0

Creates a new HealthInsuranceCard instance.

document

open class func document(with region: IdCaptureRegion) -> Self

Added in version 7.0.0

Creates a new HealthInsuranceCard instance.