ID Capture Document

Defined in framework ScanditIdCapture

SDCIdCaptureDocumentType

Added in version 7.0.0

Types associated with the document classes below

SDCIdCaptureDocumentTypeIdCard

Added in version 7.0.0

ID card identification document. Associated with SDCIdCard.

SDCIdCaptureDocumentTypeDriverLicense

Added in version 7.0.0

Driver license identification document. Associated with SDCDriverLicense.

SDCIdCaptureDocumentTypePassport

Added in version 7.0.0

Passport identification document. Associated with SDCPassport.

SDCIdCaptureDocumentTypeVisaIcao

Added in version 7.0.0

Visa (ICAO) identification document. Associated with SDCVisaIcao.

SDCIdCaptureDocumentTypeRegionSpecific

Added in version 7.0.0

Region specific identification document. Associated with SDCRegionSpecific.

SDCIdCaptureDocumentTypeResidencePermit

Added in version 7.0.0

Residence Permit. Associated with SDCResidencePermit.

SDCIdCaptureDocumentTypeHealthInsuranceCard

Added in version 7.0.0

Health insurance card. Associated with SDCHealthInsuranceCard.

SDCIdCaptureDocument

@interface SDCIdCaptureDocument : NSObject

Added in version 7.0.0

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

region

@property (nonatomic, readonly) SDCIdCaptureRegion region

Added in version 7.0.0

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

documentType

@property (nonatomic, readonly) SDCIdCaptureDocumentType documentType

Added in version 7.0.0

Enum SDCIdCaptureDocumentType associated with this instance.

- isIdCard

- (BOOL)isIdCard

Added in version 7.0.0

Indicates whether the document is of type SDCIdCard.

- isDriverLicense

- (BOOL)isDriverLicense

Added in version 7.0.0

Indicates whether the document is of type SDCDriverLicense.

- isPassport

- (BOOL)isPassport

Added in version 7.0.0

Indicates whether the document is of type SDCPassport.

- isVisaIcao

- (BOOL)isVisaIcao

Added in version 7.0.0

Indicates whether the document is of type SDCVisaIcao.

- isRegionSpecific

- (BOOL)isRegionSpecific

Added in version 7.0.0

Indicates whether the document is of type SDCRegionSpecific.

- isResidencePermit

- (BOOL)isResidencePermit

Added in version 7.0.0

Indicates whether the document is of type SDCResidencePermit.

- isHealthInsuranceCard

- (BOOL)isHealthInsuranceCard

Added in version 7.0.0

Indicates whether the document is of type SDCHealthInsuranceCard.

ID Card

SDCIdCard

@interface SDCIdCard : SDCIdCaptureDocument

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.

- initWithRegion:

- (instancetype)initWithRegion:(SDCIdCaptureRegion)region

Added in version 7.0.0

Creates a new SDCIdCard instance.

+ documentWithRegion:

+ (instancetype)documentWithRegion:(SDCIdCaptureRegion)region

Added in version 7.0.0

Creates a new SDCIdCard instance.

Driver License

SDCDriverLicense

@interface SDCDriverLicense : SDCIdCaptureDocument

Added in version 7.0.0

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

- initWithRegion:

- (instancetype)initWithRegion:(SDCIdCaptureRegion)region

Added in version 7.0.0

Creates a new SDCDriverLicense instance.

+ documentWithRegion:

+ (instancetype)documentWithRegion:(SDCIdCaptureRegion)region

Added in version 7.0.0

Creates a new SDCDriverLicense instance.

Passport

SDCPassport

@interface SDCPassport : SDCIdCaptureDocument

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.

- initWithRegion:

- (instancetype)initWithRegion:(SDCIdCaptureRegion)region

Added in version 7.0.0

Creates a new SDCPassport instance.

+ documentWithRegion:

+ (instancetype)documentWithRegion:(SDCIdCaptureRegion)region

Added in version 7.0.0

Creates a new SDCPassport instance.

Visa (ICAO)

SDCVisaIcao

@interface SDCVisaIcao : SDCIdCaptureDocument

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.

- initWithRegion:

- (instancetype)initWithRegion:(SDCIdCaptureRegion)region

Added in version 7.0.0

Creates a new SDCVisaIcao instance.

+ documentWithRegion:

+ (instancetype)documentWithRegion:(SDCIdCaptureRegion)region

Added in version 7.0.0

Creates a new SDCVisaIcao instance.

Region Specific

SDCRegionSpecific

@interface SDCRegionSpecific : SDCIdCaptureDocument

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.

- initWithSubtype:

- (instancetype)initWithSubtype:(SDCRegionSpecificSubtype)subtype

Added in version 7.0.0

Creates a new SDCRegionSpecific instance.

+ documentWithSubtype:

+ (instancetype)documentWithSubtype:(SDCRegionSpecificSubtype)subtype

Added in version 7.0.0

Creates a new SDCRegionSpecific instance.

subtype

@property (nonatomic, readonly) SDCRegionSpecificSubtype subtype

Added in version 7.0.0

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

Residence Permit

SDCResidencePermit

@interface SDCResidencePermit : SDCIdCaptureDocument

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.

- initWithRegion:

- (instancetype)initWithRegion:(SDCIdCaptureRegion)region

Added in version 7.0.0

Creates a new SDCResidencePermit instance.

+ documentWithRegion:

+ (instancetype)documentWithRegion:(SDCIdCaptureRegion)region

Added in version 7.0.0

Creates a new SDCResidencePermit instance.

Health Insurance Card

SDCHealthInsuranceCard

@interface SDCHealthInsuranceCard : SDCIdCaptureDocument

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.

- initWithRegion:

- (instancetype)initWithRegion:(SDCIdCaptureRegion)region

Added in version 7.0.0

Creates a new SDCHealthInsuranceCard instance.

+ documentWithRegion:

+ (instancetype)documentWithRegion:(SDCIdCaptureRegion)region

Added in version 7.0.0

Creates a new SDCHealthInsuranceCard instance.