PhilippinesPostalIDModel

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

Declaration

@objc final public class PhilippinesPostalIDModel : DocumentModel {
    @objc final public var fullName: String? { get }
    @objc final public var postalReferenceNumber: String? { get }
    @objc final public var address: String? { get }
    @objc final public var dateOfBirth: Date? { get }
    @objc final public var validUntil: Date? { get }
    @objc final public var nationality: String? { get }
    @objc final public var issuingPostOffice: String? { get }
    @objc final public var cardType: 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
fullName	String?	The full name of the subject as found on the document.	OCR
postalReferenceNumber	String?	The postal reference number of the subject as found on the document.	OCR
address	String?	The address of the subject as found on the document.	OCR
dateOfBirth	Date?	The date of birth of the subject as found on the document.	OCR
validUntil	Date?	The expiry date of the document as found on the document.	OCR
nationality	String?	The nationality of the subject as found on the document.	OCR
issuingPostOffice	String?	The issuing post office of the document as found on the document.	OCR
cardType	String	The card type of the document 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

fullName

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

Example: "JOHN DOE"

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

postalReferenceNumber

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

Example: "012345678912"

The postal reference number of the subject as found on the document.

address

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

Example: "UNIT/HOUSE NO. BUILDING, STREET NAME, BARANGAY, CITY/MUNICIPALITY"

The address 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.

validUntil

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

Example: 1990/01/01

The expiry date of the document as found on the document.

nationality

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

Example: "Filipino"

The nationality of the subject as found on the document.

issuingPostOffice

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

Example: "MNL CPO"

The issuing post office of the document as found on the document.

cardType

@objc final public var cardType: String { get }

Example: "Basic"

The card type of the document as found on the document. Will always be either "Basic" or "Premium"

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