Captured Id#

Defined in framework ScanditIdCapture

SDCCapturedId#
@interface SDCCapturedId : NSObject

Added in version 6.6.0

A class that represents a result of a document scan. This class contains the captured information that is commonly present in all the documents, like the name or the date of birth of the holder. The class can be cast to a concrete implementation using capturedResultType.

firstName#
@property (nonatomic, nullable, readonly) NSString *firstName

Added in version 6.6.0

The first name of the document holder. Separated by spaces if more than one name is present. Characters can be all uppercase for document types which don’t capitalize names (for example names encoded in ICAO Machine Readable Zones).

lastName#
@property (nonatomic, nullable, readonly) NSString *lastName

Added in version 6.6.0

The last name of the document holder. Separated by spaces if more than one name is present. Characters can be all uppercase for document types which don’t capitalize names (for example names encoded in ICAO Machine Readable Zones).

fullName#
@property (nonatomic, nonnull, readonly) NSString *fullName

Added in version 6.6.0

The full name of the document holder. Characters can be all uppercase for document types which don’t capitalize names (for example names encoded in ICAO Machine Readable Zones).

sex#
@property (nonatomic, nullable, readonly) NSString *sex

Added in version 6.6.0

The sex of the document holder.

dateOfBirth#
@property (nonatomic, nullable, readonly) SDCDateResult *dateOfBirth

Added in version 6.6.0

The date of birth of the document holder.

nationality#
@property (nonatomic, nullable, readonly) NSString *nationality

Added in version 6.6.0

The nationality of the document holder represented by a three-letter code (Alpha-3 codes specified in ISO 3166-1).

address#
@property (nonatomic, nullable, readonly) NSString *address

Added in version 6.6.0

The address of the document holder.

capturedResultType#
@property (nonatomic, readonly) SDCCapturedResultType capturedResultType

Added in version 6.6.0

The captured result type. Consult the documentation for more information about it.

documentType#
@property (nonatomic, readonly) SDCDocumentType documentType

Added in version 6.6.0

The document type. Consult the documentation for more information about it.

issuingCountryISO#
@property (nonatomic, nullable, readonly) NSString *issuingCountryISO

Added in version 6.6.0

The ISO (Alpha-3 code) abbreviation of the issuing country of the document.

issuingCountry#
@property (nonatomic, nullable, readonly) NSString *issuingCountry

Added in version 6.6.0

A human readable text identifying the country that issues the document.

documentNumber#
@property (nonatomic, nullable, readonly) NSString *documentNumber

Added in version 6.6.0

The document number.

dateOfExpiry#
@property (nonatomic, nullable, readonly) SDCDateResult *dateOfExpiry

Added in version 6.6.0

The date of expiry of the document.

dateOfIssue#
@property (nonatomic, nullable, readonly) SDCDateResult *dateOfIssue

Added in version 6.6.0

The date of issue of the document. Please note that some documents may specify the exact date of issue, while other the month and the year only.

aamvaBarcodeResult#
@property (nonatomic, nullable, readonly) SDCAAMVABarcodeResult *aamvaBarcodeResult

Added in version 6.6.0

The additional information extracted from a barcode on a document that follows the American Association of Motor Vehicle Administrators (AAMVA) specification. This property is guaranteed to be non-nil when capturedResultType is SDCCapturedResultTypeAAMVABarcodeResult, and is nil otherwise.

colombiaIdBarcodeResult#
@property (nonatomic, nullable, readonly) SDCColombiaIdBarcodeResult *colombiaIdBarcodeResult

Added in version 6.8.0

The additional information extracted from a barcode on a Colombia ID (Cédula de Ciudadanía). This property is guaranteed to be non-nil when capturedResultType is SDCCapturedResultTypeColombiaIdBarcodeResult, and is nil otherwise.

argentinaIdBarcodeResult#
@property (nonatomic, nullable, readonly) SDCArgentinaIdBarcodeResult *argentinaIdBarcodeResult

Added in version 6.8.0

The additional information extracted from a barcode on a Argentina ID (Documento Nacional de Identidad). This property is guaranteed to be non-nil when capturedResultType is SDCCapturedResultTypeArgentinaIdBarcodeResult, and is nil otherwise.

southAfricaDLBarcodeResult#
@property (nonatomic, nullable, readonly) SDCSouthAfricaDLBarcodeResult *southAfricaDLBarcodeResult

Added in version 6.8.0

The additional information extracted from a barcode on a South Africa Driver’s License. This property is guaranteed to be non-nil when capturedResultType is SDCCapturedResultTypeSouthAfricaDLBarcodeResult, and is nil otherwise.

southAfricaIdBarcodeResult#
@property (nonatomic, nullable, readonly) SDCSouthAfricaIdBarcodeResult *southAfricaIdBarcodeResult

Added in version 6.8.0

The additional information extracted from a barcode on a South Africa identity card (Smart ID Card). This property is guaranteed to be non-nil when capturedResultType is SDCCapturedResultTypeSouthAfricaIdBarcodeResult, and is nil otherwise.

mrzResult#
@property (nonatomic, nullable, readonly) SDCMrzResult *mrzResult

Added in version 6.6.0

The additional information extracted from a Machine Readable Zone (MRZ) of a Machine Readable Travel Document (MRTD). This property is guaranteed to be non-nil when capturedResultType is SDCCapturedResultTypeMrzResult, and is nil otherwise.

usUniformedServicesBarcodeResult#
@property (nonatomic, nullable, readonly) SDCUsUniformedServicesBarcodeResult *usUniformedServicesBarcodeResult

Added in version 6.6.0

The additional information extracted from a barcode on a United States Uniformed Services Identification card. This property is guaranteed to be non-nil when capturedResultType is SDCCapturedResultTypeUSUniformedServicesBarcodeResult, and is nil otherwise.

vizResult#
@property (nonatomic, nullable, readonly) SDCVizResult *vizResult

Added in version 6.6.0

The additional information extracted from a documents or its part intended to be read by humans (for example Visual Inspection Zone (VIZ) of a Machine-Readable Travel Document (MRTD)). This property is guaranteed to be non-nil when capturedResultType is SDCCapturedResultTypeVizResult, and is nil otherwise.

- idImageOfType:#
- (nullable UIImage *)idImageOfType:(SDCIdImageType)idImageType

Added in version 6.6.0

Gets a bitmap for an image type.

JSONString#
@property (nonatomic, nonnull, readonly) NSString *JSONString

Added in version 6.6.0

Returns the JSON representation of the captured id.