PhilippinesIDCardModel

A class derived from IDCardModel containing details specific to the Philippines ID card document

Declaration

@objc final public class PhilippinesIDCardModel : IDCardModel {
    @objc final public var commonReferenceNumber: String? { get }
    @objc override final public var fullName: String? { get }
    @objc final public var surname: String? { get }
    @objc final public var givenName: String? { get }
    @objc final public var middleName: String? { get }
    @objc final public var address: String? { get }
    @objc final public var barcodeData: String? { get }
    
    override final public func encode(to encoder: Encoder) throws
}

Only relevant details are shown, boilerplate or standard Swift generated code is omitted

Summary

Public variables

Name	Type	Description	Data source
commonReferenceNumber	String?	The common reference number of the subject as found on the UMID card document.	OCR
fullName	String?	The given name, middle name and surname of the subject as found on the ID card document.	OCR
surname	String?	The surname of the subject as found on the ID card document.	OCR
givenName	String?	The given name of the subject as found on the ID card document.	OCR
middleName	String?	The middle name of the subject as found on the ID card document.	OCR
address	String?	The address of the subject as found on the ID card document.	OCR
barcodeData	String?	The barcode as found on the ID card document.	Barcode

Public methods

Signature	Return Type	Description
encode(to encoder: Encoder)	Void	Encodes the model using the encoder provided. Used to convert the model to JSON.

Validation

The following validation and verification applies to this document:

Component verification

As explained in Validation & Verification the following fields are verified across the front and back components of the document.

Value	Source
Common reference number	Front: OCR Back: OCR

Public variables

commonReferenceNumber

@objc final public var surname: String? { get }

Example: "0123-4567890-1"

The common reference number of the subject as found on the UMID card document.

fullName

@objc override final public var fullName: String? { get }

Overridden from IDCardModel

Example: "ANNA MARIA ERIKSSON"

The given name, middle name and surname of the subject as found on the ID card document.

surname

@objc final public var surname: String? { get }

Example: "ERIKSSON"

The surname of the subject as found on the ID card document.

givenName

@objc final public var givenName: String? { get }

Example: "ANNA"

The given name of the subject as found on the ID card document.

middleName

@objc final public var middleName: String? { get }

Value can be nil

Example: "MARIA"

The middle name of the subject as found on the ID card document.

address

@objc final public var address: String? { get }

Example: "28 PAYAPA ST BAGONG DIWA STO CRISTOBAL CALOOCAN CITY METRO MANILA PHILIPPINES 1800"

The address of the subject as found on the ID card document.

barcodeData

@objc final public var barcodeData: String? { get }

Value can be nil

The barcode as found on the ID card document.

Public methods

encode(to encoder: Encoder)

override final public func encode(to encoder: Encoder) throws

This function also calls its super function

Encodes the model using the encoder provided. Used to convert the model to JSON.

See also

• IDCardModel