PhilippinesUnifiedMultipurposeIDModel

A class derived from DocumentModel containing details specific to the Philippines unified multipurpose ID document

Declaration

@objc final public class PhilippinesUnifiedMultipurposeIDModel : DocumentModel {
    @objc final public var commonReferenceNumber: 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 sex: Sex { get }
    @objc final public var dateOfBirth: Date? { get }
    @objc final public var address: 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 document.	OCR
surname	String?	The surname of the subject as found on the document.	OCR
givenName	String?	The given name of the subject as found on the document.	OCR
middleName	String?	The middle name of the subject as found on the document.	OCR
sex	Sex	The sex of the subject as found on the document.	OCR
dateOfBirth	Date?	The date of birth of the subject as found on the document.	OCR
address	String?	The address of the subject as found on the document.	OCR

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.

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 document.

surname

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

Example: "DOE"

The surname of the subject as found on the document.

givenName

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

Example: "JOHN"

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

middleName

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

Value can be nilbecause it is not included on all documents

Example: "MARTIN"

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

sex

@objc final public var sex: Sex { get }

Example: Sex.Male

The sex of the subject as found on the document.

dateOfBirth

@objc final public var dateOfBirth: Date? { get }

Example: 1990/01/01

The date of birth of the subject as found on the 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 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

• DocumentModel

• Sex