export declare namespace MyInfoComponents {
namespace Schemas {
/**
* Academic Qualifications
* Academic Qualifications achieved
*/
interface Academicqualifications {
/**
* Transcript of qualification
*/
transcripts?: {
/**
* Qualification's Name
*/
name?: {
/**
* example:
* SINGAPORE-CAMBRIDGE GENERAL CERTIFICATE OF EDUCATION ORDINARY LEVEL
*/
value?: string;
};
/**
* Year this qualification was attained
*
* See "date-fullyear" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14'
*/
yearattained?: {
/**
* example:
* 2018
*/
value?: string;
};
results?: {
/**
* Subject taken
*/
subject?: {
/**
* example:
* English Language
*/
value?: string;
};
/**
* Level of subject taken
*/
level?: {
/**
* example:
* Ordinary
*/
value?: string;
};
/**
* Grade attained
*/
grade?: {
/**
* example:
* A
*/
value?: string;
};
/**
* Optional Sub Subject taken
*/
subsubject?: {
/**
* example:
* SPECIAL PAPER
*/
value?: string;
};
/**
* Optional grade attained for subSubject
*/
subgrade?: {
/**
* example:
* One
*/
value?: string;
};
}[];
/**
* Explanatory Notes
*/
explanatorynotes?: {
value?: string;
};
}[];
/**
* Electronic Certificates Uploaded
*/
certificates?: {
/**
* File name of the electronic certificate
*/
name?: {
/**
* example:
* nus.opencert
*/
value?: string;
};
/**
* File content of the electronic certificate, Base64 encoded
*/
content?: {
value?: string;
};
/**
* Open Certificate Information
*
* Note: The test environment for OpenCert is at https://dev.opencerts.io/ while production is
* at https://opencerts.io/
*/
opencertificate?: {
/**
* The OpenCert serial number.
*/
id?: {
/**
* example:
* 100000000343840
*/
value?: string;
};
/**
* Indicate whether this open certificate is primary certificate
*/
primary?: {
/**
* example:
* true
*/
value?: boolean;
};
};
/**
* Indicate whether this file is open certificate
*/
opencertificateindicator?: {
/**
* example:
* true
*/
value?: boolean;
};
}[];
}
/**
* Address details (Singapore Format)
*/
interface AddressSG {
/**
* Type of Address (SG or UNFORMATTED for non SG)
*/
type?: "SG" | "UNFORMATTED";
/**
* Block/House of Address
*/
block?: {
/**
* example:
* 548
*/
value?: string;
};
/**
* Building of Address
*/
building?: {
/**
* example:
*
*/
value?: string;
};
/**
* Floor of Address
*/
floor?: {
/**
* example:
* 09
*/
value?: string;
};
/**
* Unit of Address
*/
unit?: {
/**
* example:
* 128
*/
value?: string;
};
/**
* Street of Address
*/
street?: {
/**
* example:
* BEDOK NORTH AVENUE 1
*/
value?: string;
};
/**
* Postal Code of Address
*/
postal?: {
/**
* example:
* 460548
*/
value?: string;
};
/**
* Country/Place of Address. For AddressSG this will always be "SG".
*/
country?: {
code?: string;
desc?: string;
};
}
/**
* Address details (Non-Singapore Format)
*/
interface AddressUnformatted {
/**
* Type of Address (SG or UNFORMATTED for non SG)
*/
type?: "SG" | "UNFORMATTED";
/**
* Unregistered Foreign address line 1
*/
line1?: {
/**
* example:
* 4578 SMITHFIELD AVENUE
*/
value?: string;
};
/**
* Unregistered Foreign address line 2
*/
line2?: {
/**
* example:
* HARTFORD CT 06120
*/
value?: string;
};
}
/**
* Alias
* Alias name of the Person.
*
* Presentation Logic - If there is a value to `aliasname` (i.e. not empty), then `aliasname` should be displayed in a new line below `hanyupinyinname`, and prefixed with the ''@'' symbol i.e. "@`aliasname`".'*
*/
interface Aliasname {
/**
* value of the field.
* example:
* TRICIA TAN XIAO HUI
*/
value?: string;
}
/**
* BillAdd
* Billing Address of Person
*
* **Note:**
* - address can be either a Singapore address (type: 'SG') or non Singapore address (type: 'UNFORMATTED')
* - check the `type` discriminator property to differentiate between the two address formats
*
*/
type Billadd =
/**
* BillAdd
* Billing Address of Person
*
* **Note:**
* - address can be either a Singapore address (type: 'SG') or non Singapore address (type: 'UNFORMATTED')
* - check the `type` discriminator property to differentiate between the two address formats
*
*/
/**
* Address details (Singapore Format)
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
DataitemAddressSg
/**
* Address details (Non-Singapore Format)
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
| DataitemAddressUnformatted;
/**
* BirthCountry
* Country/Place of Birth of Person.
*
* Refer to the [Code reference tables](#section/Support) in the Support section for list of possible values.
*/
interface Birthcountry {
/**
*
* example:
* SG
*/
code?: string;
/**
*
* example:
* SINGAPORE
*/
desc?: string;
}
/**
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
interface Childrenbirthrecords {
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
/**
* Birth certificate number of child.
*/
birthcertno?: {
/**
* example:
* S5562882C
*/
value?: string;
};
/**
* Full Name of child
*/
name?: {
/**
* example:
* Jo Tan Pei Ni
*/
value?: string;
};
/**
* Han Yu Pin Yin name of child.
*
* Presentation Logic - If there is a value to `hanyupinyinname` (i.e. not empty), then `hanyupinyinname` should be displayed in a new line below `name`, and formatted with round brackets i.e. \"(`hanyupinyinname`)\".*
*/
hanyupinyinname?: {
/**
* example:
* Cheng Pei Ni
*/
value?: string;
};
/**
* Alias name of child.
*
* Presentation Logic - If there is a value to `aliasname` (i.e. not empty), then `aliasname` should be displayed in a new line below `hanyupinyinname`, and prefixed with the ''@'' symbol i.e. \"@`aliasname`\".*
*/
aliasname?: {
/**
* example:
*
*/
value?: string;
};
/**
* Han Yu Pin Yin Alias name of child.
*
* Presentation Logic - If there is a value to `hanyupinyinaliasname` (i.e. not empty), then `hanyupinyinaliasname` should be displayed in a new line below `aliasname`, and prefixed with the ''@'' symbol i.e. \"@`hanyupinyinaliasname`\".*
*/
hanyupinyinaliasname?: {
/**
* example:
*
*/
value?: string;
};
/**
* Married name of child.
*
* Presentation Logic - If there is a value to `marriedname` (i.e. not empty), then `marriedname` should be displayed in a new line below `hanyupinyinaliasname`.*
*/
marriedname?: {
/**
* example:
*
*/
value?: string;
};
/**
* Sex of child. Possible values:
*
* 'F' - FEMALE
* 'M' - MALE
* 'U' - UNKNOWN
*/
sex?: {
/**
* example:
* F
*/
code?: "F" | "M" | "U";
/**
* example:
* FEMALE
*/
desc?: "FEMALE" | "MALE" | "UNKNOWN";
};
/**
* Race of child.
*
* Refer to the [Code reference tables](#section/Support) in the Support section for list of possible values.
*
*/
race?: {
/**
* example:
* CN
*/
code?: string;
/**
* example:
* CHINESE
*/
desc?: string;
};
/**
* Secondary Race of child.
*
* Refer to the [Code reference tables](#section/Support) in the Support section for list of possible values.
*/
secondaryrace?: {
/**
* example:
*
*/
code?: string;
/**
* example:
*
*/
desc?: string;
};
/**
* Dialect of child.
*
* Refer to the [Code reference tables](#section/Support) in the Support section for list of possible values.
*/
dialect?: {
/**
* example:
* HK
*/
code?: string;
/**
* example:
* HOKKIEN
*/
desc?: string;
};
/**
* Life Status of child. Possible values:
*
* A - ALIVE
* D - DECEASED
*/
lifestatus?: {
/**
* example:
* D
*/
code?: "A" | "D";
/**
* example:
* DECEASED
*/
desc?: "ALIVE" | "DECEASED";
};
/**
* Date of Birth of child.
*
* See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14
*/
dob?: {
/**
* example:
* 2011-09-10
*/
value?: string;
};
/**
* Time of Birth of child.
*
* Format: HHMM
*/
tob?: {
/**
* example:
* 0901
*/
value?: string;
};
vaccinationrequirements?: {
/**
* Vaccination Requirement.
*
* Refer to the [Code reference tables](#section/Support) in the Support section for list of possible values.
*/
requirement?: {
/**
* example:
* 1M3D
*/
code?: string;
/**
* example:
* MINIMUM VACCINATION REQUIREMENT FOR PRESCHOOL
*/
desc?: string;
};
fulfilled?: {
/**
* example:
* true
*/
value?: boolean;
};
}[];
/**
* Indicates whether the child is a Singapore Citizen at the time of birth.
*
* Y - Yes
* N - No
* < BLANK > - Not applicable
*/
sgcitizenatbirthind?: {
/**
* example:
* Y
*/
value?: "Y" | "N" | "";
};
}
/**
* CountryOfMarriage
* Country/Place of the latest marriage.
*
*
* **Note:** This field must be made **editable** on your digital service form even though `source` is '1' (Government Verified).
*/
interface Countryofmarriage {
/**
*
* example:
* SG
*/
code?: string;
/**
*
* example:
* SINGAPORE
*/
desc?: string;
}
/**
* CPFBalances
* CPF Balances of Person in SGD.
*
* 'ra' will not appear in the results if user does not have a Retirement Account.
*/
interface Cpfbalances {
/**
* Amount Balance in CPF-MA
*/
ma?: {
/**
* example:
* 11470.71
*/
value?: number;
};
/**
* Amount Balance in CPF-OA
*/
oa?: {
/**
* example:
* 1581.48
*/
value?: number;
};
/**
* Amount Balance in CPF-SA
*/
sa?: {
/**
* example:
* 21967.09
*/
value?: number;
};
/**
* Amount Balance in CPF-RA
*/
ra?: {
/**
* example:
* 0.01
*/
value?: number;
};
}
/**
* CPFContributions
* Employer CPF Contributions of Person in SGD. Does not include any non-employer contributions.
* Maximum past 15 months' of contributions.
*
*/
interface Cpfcontributions {
/**
* example:
* [
* {
* "date": {
* "value": "2016-12-01"
* },
* "amount": {
* "value": 500
* },
* "month": {
* "value": "2016-11"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "date": {
* "value": "2016-12-12"
* },
* "amount": {
* "value": 500
* },
* "month": {
* "value": "2016-12"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "date": {
* "value": "2016-12-21"
* },
* "amount": {
* "value": 500
* },
* "month": {
* "value": "2016-12"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "date": {
* "value": "2017-01-01"
* },
* "amount": {
* "value": 500
* },
* "month": {
* "value": "2016-12"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "date": {
* "value": "2017-01-12"
* },
* "amount": {
* "value": 500
* },
* "month": {
* "value": "2017-01"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "date": {
* "value": "2017-01-21"
* },
* "amount": {
* "value": 500
* },
* "month": {
* "value": "2017-01"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "date": {
* "value": "2017-02-01"
* },
* "amount": {
* "value": 500
* },
* "month": {
* "value": "2017-01"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "date": {
* "value": "2017-02-12"
* },
* "amount": {
* "value": 500
* },
* "month": {
* "value": "2017-02"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "date": {
* "value": "2017-02-21"
* },
* "amount": {
* "value": 500
* },
* "month": {
* "value": "2017-02"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "date": {
* "value": "2017-03-01"
* },
* "amount": {
* "value": 500
* },
* "month": {
* "value": "2017-02"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "date": {
* "value": "2017-03-12"
* },
* "amount": {
* "value": 500
* },
* "month": {
* "value": "2017-03"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "date": {
* "value": "2017-03-21"
* },
* "amount": {
* "value": 500
* },
* "month": {
* "value": "2017-03"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "date": {
* "value": "2017-04-01"
* },
* "amount": {
* "value": 500
* },
* "month": {
* "value": "2017-03"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "date": {
* "value": "2017-04-12"
* },
* "amount": {
* "value": 500
* },
* "month": {
* "value": "2017-04"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "date": {
* "value": "2017-04-21"
* },
* "amount": {
* "value": 500
* },
* "month": {
* "value": "2017-04"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "date": {
* "value": "2017-05-01"
* },
* "amount": {
* "value": 500
* },
* "month": {
* "value": "2017-04"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "date": {
* "value": "2017-05-12"
* },
* "amount": {
* "value": 500
* },
* "month": {
* "value": "2017-05"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "date": {
* "value": "2017-05-21"
* },
* "amount": {
* "value": 500
* },
* "month": {
* "value": "2017-05"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "date": {
* "value": "2017-06-01"
* },
* "amount": {
* "value": 500
* },
* "month": {
* "value": "2017-05"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "date": {
* "value": "2017-06-12"
* },
* "amount": {
* "value": 500
* },
* "month": {
* "value": "2017-06"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "date": {
* "value": "2017-06-21"
* },
* "amount": {
* "value": 500
* },
* "month": {
* "value": "2017-06"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "date": {
* "value": "2017-07-01"
* },
* "amount": {
* "value": 500
* },
* "month": {
* "value": "2017-06"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "date": {
* "value": "2017-07-12"
* },
* "amount": {
* "value": 500
* },
* "month": {
* "value": "2017-07"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "date": {
* "value": "2017-07-21"
* },
* "amount": {
* "value": 500
* },
* "month": {
* "value": "2017-07"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "date": {
* "value": "2017-08-01"
* },
* "amount": {
* "value": 500
* },
* "month": {
* "value": "2017-07"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "date": {
* "value": "2017-08-12"
* },
* "amount": {
* "value": 750
* },
* "month": {
* "value": "2017-08"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "date": {
* "value": "2017-08-21"
* },
* "amount": {
* "value": 750
* },
* "month": {
* "value": "2017-08"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "date": {
* "value": "2017-09-01"
* },
* "amount": {
* "value": 750
* },
* "month": {
* "value": "2017-08"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "date": {
* "value": "2017-09-12"
* },
* "amount": {
* "value": 750
* },
* "month": {
* "value": "2017-09"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "date": {
* "value": "2017-09-21"
* },
* "amount": {
* "value": 750
* },
* "month": {
* "value": "2017-09"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "date": {
* "value": "2017-10-01"
* },
* "amount": {
* "value": 750
* },
* "month": {
* "value": "2017-09"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "date": {
* "value": "2017-10-12"
* },
* "amount": {
* "value": 750
* },
* "month": {
* "value": "2017-10"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "date": {
* "value": "2017-10-21"
* },
* "amount": {
* "value": 750
* },
* "month": {
* "value": "2017-10"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "date": {
* "value": "2017-11-01"
* },
* "amount": {
* "value": 750
* },
* "month": {
* "value": "2017-10"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "date": {
* "value": "2017-11-12"
* },
* "amount": {
* "value": 750
* },
* "month": {
* "value": "2017-11"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "date": {
* "value": "2017-11-21"
* },
* "amount": {
* "value": 750
* },
* "month": {
* "value": "2017-11"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "date": {
* "value": "2017-12-01"
* },
* "amount": {
* "value": 750
* },
* "month": {
* "value": "2017-11"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "date": {
* "value": "2017-12-12"
* },
* "amount": {
* "value": 750
* },
* "month": {
* "value": "2017-12"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "date": {
* "value": "2017-12-21"
* },
* "amount": {
* "value": 750
* },
* "month": {
* "value": "2017-12"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "date": {
* "value": "2018-01-01"
* },
* "amount": {
* "value": 750
* },
* "month": {
* "value": "2017-12"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "date": {
* "value": "2018-01-12"
* },
* "amount": {
* "value": 750
* },
* "month": {
* "value": "2018-01"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "date": {
* "value": "2018-01-21"
* },
* "amount": {
* "value": 750
* },
* "month": {
* "value": "2018-01"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* }
* ]
*/
history?: {
/**
* Employer who paid the Contribution.
*/
employer?: {
/**
* example:
* Crystal Horse Invest Pte Ltd
*/
value?: string;
};
/**
* Date of Contribution Paid. See "full-date" in http://xml2rfc.ietf.org/public/rfc/htm
*/
date?: {
/**
* example:
* 2017-03-01
*/
value?: string;
};
/**
* Month for which CPF Contribution was paid. Format: YYYY-MM
*/
month?: {
/**
* example:
* 2017-02
*/
value?: string;
};
/**
* Amount of contribution in SGD
*/
amount?: {
/**
* example:
* 500
*/
value?: number;
};
}[];
}
/**
* CPF Dependant Protection Scheme
* CPF Dependant Protection Scheme
*/
interface Cpfdependantprotectionscheme {
coverage?: {
/**
* Indicator
* example:
* true
*/
value?: boolean;
};
insurercode?: {
/**
* Insurer Code
* example:
* 9GEL
*/
value?: string;
};
sumassuredamount?: {
/**
* Sum assured. OPTIONAL attribute, present only if 'coverage' is true
* example:
* 70000
*/
value?: number;
};
}
/**
* CPFEmployers
* Employers who paid CPF Contributions. Maximum up to past 14 months.
*
*/
interface Cpfemployers {
/**
* example:
* [
* {
* "month": {
* "value": "2016-11"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "month": {
* "value": "2016-12"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "month": {
* "value": "2016-12"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "month": {
* "value": "2016-12"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "month": {
* "value": "2017-01"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "month": {
* "value": "2017-01"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "month": {
* "value": "2017-01"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "month": {
* "value": "2017-02"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "month": {
* "value": "2017-02"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "month": {
* "value": "2017-02"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "month": {
* "value": "2017-03"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "month": {
* "value": "2017-03"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "month": {
* "value": "2017-03"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "month": {
* "value": "2017-04"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "month": {
* "value": "2017-04"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "month": {
* "value": "2017-04"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "month": {
* "value": "2017-05"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "month": {
* "value": "2017-05"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "month": {
* "value": "2017-05"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "month": {
* "value": "2017-06"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "month": {
* "value": "2017-06"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "month": {
* "value": "2017-06"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "month": {
* "value": "2017-07"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "month": {
* "value": "2017-07"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "month": {
* "value": "2017-07"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "month": {
* "value": "2017-08"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "month": {
* "value": "2017-08"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "month": {
* "value": "2017-08"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "month": {
* "value": "2017-09"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "month": {
* "value": "2017-09"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "month": {
* "value": "2017-09"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "month": {
* "value": "2017-10"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "month": {
* "value": "2017-10"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "month": {
* "value": "2017-10"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "month": {
* "value": "2017-11"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "month": {
* "value": "2017-11"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "month": {
* "value": "2017-11"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "month": {
* "value": "2017-12"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "month": {
* "value": "2017-12"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "month": {
* "value": "2017-12"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "month": {
* "value": "2018-01"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "month": {
* "value": "2018-01"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* }
* ]
*/
history?: {
/**
* Employer who paid the Contribution.
*/
employer?: {
/**
* example:
* Crystal Horse Invest Pte Ltd
*/
value?: string;
};
/**
* Month for which CPF Contribution was paid. Format: YYYY-MM
*/
month?: {
/**
* example:
* 2017-03
*/
value?: string;
};
}[];
}
/**
* CPF Home Protection Scheme
* CPF Home Protection Scheme
*/
interface Cpfhomeprotectionscheme {
coverage?: {
/**
* Indicator
* example:
* true
*/
value?: boolean;
};
premium?: {
/**
* Coverage premium. OPTIONAL attribute, present only if 'coverage' is true
* example:
* 100.01
*/
value?: number;
};
shareofcover?: {
/**
* Share of coverage (in percentage). OPTIONAL attribute, present only if 'coverage' is true
* example:
* 20
*/
value?: number;
};
}
/**
* CPFHousingWithdrawal
* CPF Housing Withdrawal of Person. Amounts in SGD.
*/
interface Cpfhousingwithdrawal {
/**
* Withdrawal details for properties
*/
withdrawaldetails?: {
/**
* Registered Address of Property which withdrawal is made.
*
* **Note:**
* - address can be either Singapore address (type: 'SG') or non Singapore address (type: 'UNFORMATTED')
* - check the `type` discriminator property to differentiate between the two address formats
*
*/
address?: AddressSG | /* Address details (Non-Singapore Format) */ AddressUnformatted;
/**
*
*/
accruedinterestamt?: {
/**
* example:
* 1581.48
*/
value?: number;
};
/**
*
*/
monthlyinstalmentamt?: {
/**
* example:
* 1196.09
*/
value?: number;
};
/**
*
*/
principalwithdrawalamt?: {
/**
* example:
* 2897.01
*/
value?: number;
};
/**
*
*/
totalamountofcpfallowedforproperty?: {
/**
* example:
* 10000.01
*/
value?: number;
};
}[];
}
/**
* CPFInvestmentScheme
* CPF Investment Scheme.
*/
interface Cpfinvestmentscheme {
/**
* Quantity of Special Discounted Shares shares held
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
sdsnetshareholdingqty?: {
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
/**
* example:
* 1360
*/
value?: number;
};
/**
* CPF Investment Account Details
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
account?: {
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
/**
* Agent Bank Code
*/
agentbankcode?: {
/**
* example:
* OCBC
*/
value?: string;
};
/**
* Account Number
*/
invbankacctno?: {
/**
* example:
* 098-26644-4
*/
value?: string;
};
};
/**
* Status of Self-Awareness Questionnaire Participation.
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
saqparticipationstatus?: {
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
/**
* Possible values:
*
* 'Y' – Participated
* 'X' – Existing CPFIS participant
* 'N' – Did not participate
* example:
* X
*/
code?: "Y" | "X" | "N";
/**
* example:
* Participated
*/
desc?: string;
};
}
/**
* CPFLife
* CPF Lifelong Income For the Elderly (CPF LIFE)
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
interface Cpflife {
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
/**
* Flag to indicate the CPF Life membership of the user
*/
cpflifecoverage?: {
/**
* example:
* true
*/
value?: boolean;
};
/**
* CPF Life plan chosen
*/
cpflifeplan?: {
/**
* example:
* Standard Plan
*/
value?: string;
};
/**
* Monthly payout from CPF Life in SGD
*/
cpflifemonthlypayout?: {
/**
* example:
* 1000
*/
value?: number;
};
/**
* Flag to indicate if user is currently receiving monthly payouts from CPF LIFE
*/
cpflifepaymentcommencement?: {
/**
* example:
* true
*/
value?: boolean;
};
/**
* Date of latest CPF Life payment. Can be blank.
*
* See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14
*/
cpflifepaymentdate?: {
/**
* example:
* 2019-09-02
*/
value?: string;
};
}
/**
* CPFMedishieldLife
* CPF MediShield Life
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
interface Cpfmedishieldlife {
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
/**
* Present only if underlying 'hascovertag' is not empty (true or false) from CPF
*/
medishieldlifecoverage?: {
/**
* Status of cover of user.
*/
hascovertag?: {
/**
* example:
* true
*/
value?: boolean;
};
/**
* Name of the current payer who pay for this policy for current policy renewal date.
*
* Present only if 'hascovertag' is true.
*/
payername?: {
value?: string;
};
/**
* Net Premium Payable in SGD after subsidies, Additional Premium Support and Government Benefit (if applicable) for current policy year.
*
* Present only if 'hascovertag' is true.
*
*/
netpremiumpayable?: {
/**
* example:
* 1000
*/
value?: number;
};
/**
* Renewal date for current policy year.
*
* See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14
*
* Present only if 'hascovertag' is true.
*
*/
policyrenewaldate?: {
/**
* example:
* 2019-07-02
*/
value?: string;
};
};
/**
* Present only if underlying 'hascovertag' is not empty (true or false) from CPF
*/
integratedshieldplancoverage?: {
/**
* Status of cover of user.
*/
hascovertag?: {
/**
* example:
* true
*/
value?: boolean;
};
/**
* Name of the current payer who pay for this policy for current policy renewal date.
*
* Present only if 'hascovertag' is true.
*/
payername?: {
value?: string;
};
/**
* Company code of private insurer. Refer to 'Code Listing (InsurerCode)' in https://public.cloud.myinfo.gov.sg/dpp/frontend/assets/api-lib/myinfo/downloads/myinfo-api-code-tables.xlsx for list of possible values
*
* Present only if 'hascovertag' is true.
*/
insurercode?: {
value?: string;
};
};
/**
* Empty array will be returned if there is no data
*/
medishieldlifedependants?: {
/**
* Name of dependants whom the enquirer is paying for.
*/
dependantname?: {
value?: string;
};
/**
* Net Premium Payable in SGD after subsidies, Additional Premium Support and Government Benefit (if applicable) for current policy year
*/
netpremiumpayable?: {
/**
* example:
* 1000
*/
value?: number;
};
/**
* Renewal date for current policy year.
*
* See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14
*
* Present only if 'hascovertag' is true.
*
*/
policyrenewaldate?: {
/**
* example:
* 2019-07-02
*/
value?: string;
};
}[];
/**
* Empty array will be returned if there is no data
*/
integratedshieldplandependants?: {
/**
* Name of dependants whom the enquirer is paying for.
*/
dependantname?: {
value?: string;
};
/**
* Company code of private insurer. Refer to 'Code Listing (InsurerCode)' in https://public.cloud.myinfo.gov.sg/dpp/frontend/assets/api-lib/myinfo/downloads/myinfo-api-code-tables.xlsx for list of possible values
*
* Present only if 'hascovertag' is true.
*/
insurercode?: {
value?: string;
};
}[];
}
/**
* CPFMonthlyPayouts
* CPF Monthly Payouts (Non-LIFE)
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
interface Cpfmonthlypayouts {
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
/**
* Monthly payout amount in SGD
*/
monthlypayout?: {
/**
* example:
* 1000
*/
value?: number;
};
/**
* Flag to indicate if user is currently receiving monthly payouts
*/
paymentcommencement?: {
/**
* example:
* true
*/
value?: boolean;
};
}
/**
* CPFRSTUCurrentYearTaxRelief
* CPF Retirement Savings Topping-up Scheme - Current Year Tax Relief
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
interface Cpfrstucurrentyeartaxrelief {
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
/**
* Total tax relief from self top-up in SGD
*/
totaltaxreliefself?: {
/**
* example:
* 1000
*/
value?: number;
};
/**
* Remaining tax relief from self top-up in SGD
*/
remainingtaxreliefself?: {
/**
* example:
* 1000
*/
value?: number;
};
/**
* Total tax relief from top-up by loved ones in SGD
*/
totaltaxrelieflovedones?: {
/**
* example:
* 1000
*/
value?: number;
};
/**
* Remaining tax relief from top-up by loved ones in SGD
*/
remainingtaxrelieflovedones?: {
/**
* example:
* 1000
*/
value?: number;
};
}
/**
* CPFRSTUSelfTopupAmount
* CPF Retirement Savings Topping-up Scheme - Maximum amount you can top-up using cash and CPF
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
interface Cpfrstuselftopupamount {
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
/**
* Maximum amount you can top up using cash
*/
selftopupusingcash?: {
/**
* example:
* 1000
*/
value?: number;
};
/**
* Maximum amount you can transfer using CPF
*/
selftopupusingcpf?: {
/**
* example:
* 1000
*/
value?: number;
};
}
/**
* CPFTransactions
* CPF Transaction History of Person in SGD.
* Maximum past 15 months' of transactions.
*
*/
interface Cpftransactions {
history?: {
/**
* Type of transaction
*/
txntype?: {
/**
* example:
* CON
*/
code?: string;
/**
* example:
* Contributions/Government Cash Grant/Government Top-up
*/
desc?: string;
};
/**
* Account Number. May be present if txntype code is 'TRF'.
*/
accountno?: {
value?: string;
};
/**
* Month of transaction. Format: YYYY-MM
*
* Present if txntype code is 'CON'/'RFD'/'ADJ'
*/
month?: {
/**
* example:
* 2017-02
*/
value?: string;
};
/**
* Date of Transaction. See "full-date" in http://xml2rfc.ietf.org/public/rfc/htm
*/
date?: {
/**
* example:
* 2017-03-01
*/
value?: string;
};
/**
* Footer reference
*/
referenceno?: {
value?: string;
};
/**
* Transaction Amount to Ordinary Account in SGD
*/
oatxnamt?: {
/**
* example:
* 500
*/
value?: number;
};
/**
* Transaction Amount to Special Account in SGD
*/
satxnamt?: {
/**
* example:
* 500
*/
value?: number;
};
/**
* Transaction Amount to Medisave Account in SGD
*/
matxnamt?: {
/**
* example:
* 500
*/
value?: number;
};
/**
* Transaction Amount to Retirement Account in SGD. Only present if user has Retirement Account
*/
ratxnamt?: {
/**
* example:
* 500
*/
value?: number;
};
}[];
/**
* example:
* [
* {
* "message": {
* "value": "REF A: EMPLOYER XXXX"
* }
* },
* {
* "message": {
* "value": "B: EMPLOYER YYYY"
* }
* }
* ]
*/
footers?: {
message?: {
/**
* example:
* REF A: EMPLOYER XXXX
*/
value?: string;
};
}[];
}
/**
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
interface DataFieldProperties {
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
}
/**
* Address details (Singapore Format)
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
interface DataitemAddressSg {
/**
* Type of Address (SG or UNFORMATTED for non SG)
*/
type?: "SG" | "UNFORMATTED";
/**
* Block/House of Address
*/
block?: {
/**
* example:
* 548
*/
value?: string;
};
/**
* Building of Address
*/
building?: {
/**
* example:
*
*/
value?: string;
};
/**
* Floor of Address
*/
floor?: {
/**
* example:
* 09
*/
value?: string;
};
/**
* Unit of Address
*/
unit?: {
/**
* example:
* 128
*/
value?: string;
};
/**
* Street of Address
*/
street?: {
/**
* example:
* BEDOK NORTH AVENUE 1
*/
value?: string;
};
/**
* Postal Code of Address
*/
postal?: {
/**
* example:
* 460548
*/
value?: string;
};
/**
* Country/Place of Address. For AddressSG this will always be "SG".
*/
country?: {
code?: string;
desc?: string;
};
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
}
/**
* Address details (Non-Singapore Format)
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
interface DataitemAddressUnformatted {
/**
* Type of Address (SG or UNFORMATTED for non SG)
*/
type?: "SG" | "UNFORMATTED";
/**
* Unregistered Foreign address line 1
*/
line1?: {
/**
* example:
* 4578 SMITHFIELD AVENUE
*/
value?: string;
};
/**
* Unregistered Foreign address line 2
*/
line2?: {
/**
* example:
* HARTFORD CT 06120
*/
value?: string;
};
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
}
/**
* Dialect
* Dialect of Person.
*
* Refer to the [Code reference tables](#section/Support) in the Support section for list of possible values.
*/
interface Dialect {
/**
*
* example:
* SG
*/
code?: string;
/**
*
* example:
* SWISS GERMAN
*/
desc?: string;
}
/**
* DivorceDate
* Last Divorce Date of Person.
*
*
* **Note:** This field must be made **editable** on your digital service form even though `source` is '1' (Government Verified).
*
*/
interface Divorcedate {
/**
* Value of data field.
*
* See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14
* example:
*
*/
value?: string;
}
/**
* DOB
* Date of Birth of Person.
*/
interface Dob {
/**
* Value of data field.
* Format can be one of the below (with reference to http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14):
* - full-date
* - date-fullyear "-" date-month
* - date-fullyear
* example:
* 1958-05-17
*/
value?: string;
}
/**
* Driving Licence details of Person.
*
*/
interface Drivinglicence {
/**
* Status of Certificate of Merit. Possible values:
*
* Y - ELIGIBLE
* N - NOT ELIGIBLE
*/
comstatus?: {
/**
* example:
* Y
*/
code?: "Y" | "N";
/**
*
* example:
* ELIGIBLE
*/
desc?: "ELIGIBLE" | "NOT ELIGIBLE";
};
/**
* Total Demerit Points
*/
totaldemeritpoints?: {
/**
* example:
* 0
*/
value?: number;
};
/**
*
*/
suspension?: {
/**
* Suspension Start Date
*/
startdate?: {
/**
* example:
*
*/
value?: string;
};
/**
* Suspension End Date
*/
enddate?: {
/**
* example:
*
*/
value?: string;
};
};
/**
*
*/
disqualification?: {
/**
* Disqualification Start Date
*/
startdate?: {
/**
* example:
*
*/
value?: string;
};
/**
* Disqualification End Date
*/
enddate?: {
/**
* example:
*
*/
value?: string;
};
};
/**
*
*/
revocation?: {
/**
* Revocation Start Date
*/
startdate?: {
/**
* example:
*
*/
value?: string;
};
/**
* Revocation End Date
*/
enddate?: {
/**
* example:
*
*/
value?: string;
};
};
/**
* Provisional Driving Licence (PDL)
*/
pdl?: {
/**
* Validity of PDL. Possible values:
*
* V - VALID
* E - EXPIRED
* I - INVALID
* N - NOT HOLDING
*/
validity?: {
/**
* example:
* V
*/
code?: "V" | "E" | "I" | "N";
/**
*
* example:
* VALID
*/
desc?: "VALID" | "EXPIRED" | "INVALID" | "NOT HOLDING";
};
/**
* PDL Expiry Date
*/
expirydate?: {
/**
* example:
* 2020-06-15
*/
value?: string;
};
/**
* PDL Classes
* example:
* [
* {
* "class": {
* "value": "2A"
* }
* },
* {
* "class": {
* "value": "3A"
* }
* }
* ]
*/
classes?: {
class?: {
value?: string;
};
}[];
};
/**
* Qualified Driving Licence (QDL)
*/
qdl?: {
/**
* Validity of QDL. Possible values:
*
* V - VALID
* E - EXPIRED
* I - INVALID
* N - NOT HOLDING
*/
validity?: {
/**
* example:
* V
*/
code?: "V" | "E" | "I" | "N";
/**
*
* example:
* VALID
*/
desc?: "VALID" | "EXPIRED" | "INVALID" | "NOT HOLDING";
};
/**
* QDL Expiry Date
*/
expirydate?: {
/**
* example:
* 2020-06-15
*/
value?: string;
};
/**
* QDL Classes. Includes Issue Date (e.g. 2B, 2018-01-01)
* example:
* [
* {
* "class": {
* "value": "2A"
* },
* "issuedate": {
* "value": "2018-06-06"
* }
* },
* {
* "class": {
* "value": "3A"
* },
* "issuedate": {
* "value": "2018-06-06"
* }
* }
* ]
*/
classes?: {
class?: {
value?: string;
};
issuedate?: {
value?: string;
};
}[];
};
/**
* Serial Number of the Photo Card
*/
photocardserialno?: {
/**
* example:
* 115616
*/
value?: string;
};
}
/**
* EduLevel
* Highest Education Level of Person.
*
* '0' - NO FORMAL QUALIFICATION / PRE-PRIMARY / LOWER PRIMARY
* '1' - PRIMARY
* '2' - LOWER SECONDARY
* '3' - SECONDARY
* '4' - POST-SECONDARY (NON-TERTIARY): GENERAL & VOCATION
* '5' - POLYTECHNIC DIPLOMA
* '6' - PROFESSIONAL QUALIFICATION AND OTHER DIPLOMA
* '7' - BACHELOR'S OR EQUIVALENT
* '8' - POSTGRADUATE DIPLOMA / CERTIFICATE (EXCLUDING MASTER'S AND DOCTORATE)
* '9' - MASTER'S AND DOCTORATE OR EQUIVALENT
* 'N' - MODULAR CERTIFICATION (NON-AWARD COURSES / NON-FULL QUALIFICATIONS)
*/
interface Edulevel {
/**
*
* example:
* 7
*/
code?: "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" | "N";
/**
* example:
* BACHELOR'S OR EQUIVALENT
*/
desc?: "NO FORMAL QUALIFICATION / PRE-PRIMARY / LOWER PRIMARY" | "PRIMARY" | "LOWER SECONDARY" | "SECONDARY" | "POST-SECONDARY (NON-TERTIARY): GENERAL & VOCATION" | "POLYTECHNIC DIPLOMA" | "PROFESSIONAL QUALIFICATION AND OTHER DIPLOMA" | "BACHELOR'S OR EQUIVALENT" | "POSTGRADUATE DIPLOMA / CERTIFICATE (EXCLUDING MASTER'S AND DOCTORATE)" | "MASTER'S AND DOCTORATE OR EQUIVALENT" | "MODULAR CERTIFICATION (NON-AWARD COURSES / NON-FULL QUALIFICATIONS)";
}
/**
* Email
* Email Address of Person.
*/
interface Email {
/**
* Value of data field.
* example:
* test@gmail.com
*/
value?: string;
}
/**
* Employment
* Name of Employer.
*/
interface Employment {
/**
* example:
* ALPHA
*/
value?: string;
}
/**
* EmploymentSector
* Employment Sector of a FIN holder.
*
* **Note:** Only applies to a foreigner with a valid work pass.
*
* Some examples of possible values are:
* MANUFACTURING
* CONSTRUCTION
* RECLAMATION
* SERVICE
* GRI-TECHNOLOGY
* LANDSCAPING
* INCINERATOR PLANT
* MARINE SHIPYARD
* PROCESS
* HARBOURCRAFT
* DOMESTIC
*/
interface Employmentsector {
/**
* example:
* MANUFACTURING
*/
value?: string;
}
/**
* GradYear
* Year of Graduation of Person. Format: YYYY
*/
interface Gradyear {
/**
* example:
* 2006
*/
value?: string;
}
/**
* GSTVoucher
* GST Voucher details
*/
interface Gstvoucher {
/**
* Indicator if user is excluded
*/
exclusion?: {
/**
* example:
* false
*/
value?: boolean;
};
/**
* Indicator if user needs to signup
*/
signup?: {
/**
* example:
* true
*/
value?: boolean;
};
/**
* Amount given for medisave account
*/
gstmedisave?: {
/**
* example:
* 100
*/
value?: number;
};
/**
* Amount given for ordinary account
*/
gstregular?: {
/**
* example:
* 100
*/
value?: number;
};
/**
* Amount given for special account
*/
gstspecial?: {
/**
* example:
* 100
*/
value?: number;
};
/**
* Year given
*/
year?: {
/**
* Value of data field. See "date-fullyear" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14
* example:
* 2019
*/
value?: string;
};
}
/**
* HDBOwnership
* HDB Ownership details
*
* **TODO: is this tied to the registered address or the person (UINFIN) or both?**
*
*/
interface HDBOwnership {
/**
* Number of Owners. Note that this does not include executors, administrators or trustees.
*/
noofowners?: {
/**
* example:
* 2
*/
value?: number;
};
/**
* Address details (Singapore Format)
*/
address?: {
/**
* Type of Address (SG or UNFORMATTED for non SG)
*/
type?: "SG" | "UNFORMATTED";
/**
* Block/House of Address
*/
block?: {
/**
* example:
* 548
*/
value?: string;
};
/**
* Building of Address
*/
building?: {
/**
* example:
*
*/
value?: string;
};
/**
* Floor of Address
*/
floor?: {
/**
* example:
* 09
*/
value?: string;
};
/**
* Unit of Address
*/
unit?: {
/**
* example:
* 128
*/
value?: string;
};
/**
* Street of Address
*/
street?: {
/**
* example:
* BEDOK NORTH AVENUE 1
*/
value?: string;
};
/**
* Postal Code of Address
*/
postal?: {
/**
* example:
* 460548
*/
value?: string;
};
/**
* Country/Place of Address. For AddressSG this will always be "SG".
*/
country?: {
code?: string;
desc?: string;
};
};
/**
* HDBType
* Flat Type of the HDB flat.
*
* **Note 1:** that this excludes Rental Flats, Pre-War SIT flat, PSA flat, HUDC flat, Executive Condominium and Shophouse.
*
* **Note 2:** If `housingtype` is available, this value will be null.
*
* **Note 3:** If `housingtype` & `hdbtype` are unavailable, make this field user editable.
*
* '111' - 1-ROOM FLAT (HDB)
* '112' - 2-ROOM FLAT (HDB)
* '113' - 3-ROOM FLAT (HDB)
* '114' - 4-ROOM FLAT (HDB)
* '115' - 5-ROOM FLAT (HDB)
* '116' - EXECUTIVE FLAT (HDB)
* '118' - STUDIO APARTMENT (HDB)
*/
hdbtype?: {
/**
*
* example:
* 112
*/
code?: "111" | "112" | "113" | "114" | "115" | "116" | "118";
/**
*
* example:
* 2-ROOM FLAT (HDB)
*/
desc?: "1-ROOM FLAT (HDB)" | "2-ROOM FLAT (HDB)" | "3-ROOM FLAT (HDB)" | "4-ROOM FLAT (HDB)" | "5-ROOM FLAT (HDB)" | "EXECUTIVE FLAT (HDB)" | "STUDIO APARTMENT (HDB)";
};
/**
* Date from which the lease period starts. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14
*/
leasecommencementdate?: {
/**
* example:
* 2008-06-13
*/
value?: string;
};
/**
* Term of lease (in years) for the property computed from the lease commencement date.
*/
termoflease?: {
/**
* example:
* 99
*/
value?: number;
};
/**
* Effective date of flat purchase. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14
*/
dateofpurchase?: {
/**
* example:
* 2008-06-13
*/
value?: string;
};
/**
* Effective date of partial transfer without monetary consideration (e.g. addition, deletion or substitution of a co-owner) for an HDB sold flat.
*
* For partial transfer of flat where at least one of the current owner remains in the household, the Date of Purchase remains unchanged while the date of transfer of ownership will be updated.
*
* For outright transfer where there is a total change of all owner(s), only the Date of Purchase will be updated.
*
* See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14'
*/
dateofownershiptransfer?: {
/**
* example:
* 2018-06-13
*/
value?: string;
};
/**
* The amount of housing loan granted to owner(s) by HDB in SGD.
*/
loangranted?: {
/**
* example:
* 310000.01
*/
value?: number;
};
/**
* The number of years of loan repaymnet opted by owner(s) at the time the loan is first granted to him/her.
*/
originalloanrepayment?: {
/**
* example:
* 25
*/
value?: number;
};
/**
* The remaining term of repayment for the loan in the format `years` + `months`.
*/
balanceloanrepayment?: {
years?: {
/**
* example:
* 2
*/
value?: number;
};
months?: {
/**
* example:
* 6
*/
value?: number;
};
};
/**
* The amount of outstanding HDB loan owed by owner(s) in SGD.
*/
outstandingloanbalance?: {
/**
* example:
* 50000.01
*/
value?: number;
};
/**
* The amount of monthly instalment the owner(s) have to pay for his/her loan in SGD.
*/
monthlyloaninstalment?: {
/**
* example:
* 1000.01
*/
value?: number;
};
/**
* The amount of outstanding instalment the owner(s) have to pay for his/her loan in SGD.
*/
outstandinginstalment?: {
/**
* example:
* 1000.01
*/
value?: number;
};
/**
* The purchase price of the HDB flat in SGD.
*/
purchaseprice?: {
/**
* example:
* 1000.01
*/
value?: number;
};
}
/**
* HanYuPinYinAlias
* Han Yu Pin Yin Alias name of the Person.
*
* Presentation Logic - If there is a value to `hanyupinyinaliasname` (i.e. not empty), then `hanyupinyinaliasname` should be displayed in a new line below `aliasname`, and prefixed with the ''@'' symbol i.e. "@`hanyupinyinaliasname`".*
*/
interface Hanyupinyinaliasname {
/**
* example:
* TRICIA CHEN XIAO HUI
*/
value?: string;
}
/**
* HanYuPinYin
* Han Yu Pin Yin name of the Person.
*
* Presentation Logic - If there is a value to `hanyupinyinname` (i.e. not empty), then `hanyupinyinname` should be displayed in a new line below `name`, and formatted with round brackets i.e. "(`hanyupinyinname`)"'*
*/
interface Hanyupinyinname {
/**
* example:
* CHEN XIAO HUI
*/
value?: string;
}
/**
* HDBOwnership
* HDB Ownership details
*
* **TODO: is this tied to the registered address or the person (UINFIN) or both?**
*
*/
interface Hdbownership {
/**
* Number of Owners. Note that this does not include executors, administrators or trustees.
*/
noofowners?: {
/**
* example:
* 2
*/
value?: number;
};
/**
* Address details (Singapore Format)
*/
address?: {
/**
* Type of Address (SG or UNFORMATTED for non SG)
*/
type?: "SG" | "UNFORMATTED";
/**
* Block/House of Address
*/
block?: {
/**
* example:
* 548
*/
value?: string;
};
/**
* Building of Address
*/
building?: {
/**
* example:
*
*/
value?: string;
};
/**
* Floor of Address
*/
floor?: {
/**
* example:
* 09
*/
value?: string;
};
/**
* Unit of Address
*/
unit?: {
/**
* example:
* 128
*/
value?: string;
};
/**
* Street of Address
*/
street?: {
/**
* example:
* BEDOK NORTH AVENUE 1
*/
value?: string;
};
/**
* Postal Code of Address
*/
postal?: {
/**
* example:
* 460548
*/
value?: string;
};
/**
* Country/Place of Address. For AddressSG this will always be "SG".
*/
country?: {
code?: string;
desc?: string;
};
};
/**
* HDBType
* Flat Type of the HDB flat.
*
* **Note 1:** that this excludes Rental Flats, Pre-War SIT flat, PSA flat, HUDC flat, Executive Condominium and Shophouse.
*
* **Note 2:** If `housingtype` is available, this value will be null.
*
* **Note 3:** If `housingtype` & `hdbtype` are unavailable, make this field user editable.
*
* '111' - 1-ROOM FLAT (HDB)
* '112' - 2-ROOM FLAT (HDB)
* '113' - 3-ROOM FLAT (HDB)
* '114' - 4-ROOM FLAT (HDB)
* '115' - 5-ROOM FLAT (HDB)
* '116' - EXECUTIVE FLAT (HDB)
* '118' - STUDIO APARTMENT (HDB)
*/
hdbtype?: {
/**
*
* example:
* 112
*/
code?: "111" | "112" | "113" | "114" | "115" | "116" | "118";
/**
*
* example:
* 2-ROOM FLAT (HDB)
*/
desc?: "1-ROOM FLAT (HDB)" | "2-ROOM FLAT (HDB)" | "3-ROOM FLAT (HDB)" | "4-ROOM FLAT (HDB)" | "5-ROOM FLAT (HDB)" | "EXECUTIVE FLAT (HDB)" | "STUDIO APARTMENT (HDB)";
};
/**
* Date from which the lease period starts. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14
*/
leasecommencementdate?: {
/**
* example:
* 2008-06-13
*/
value?: string;
};
/**
* Term of lease (in years) for the property computed from the lease commencement date.
*/
termoflease?: {
/**
* example:
* 99
*/
value?: number;
};
/**
* Effective date of flat purchase. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14
*/
dateofpurchase?: {
/**
* example:
* 2008-06-13
*/
value?: string;
};
/**
* Effective date of partial transfer without monetary consideration (e.g. addition, deletion or substitution of a co-owner) for an HDB sold flat.
*
* For partial transfer of flat where at least one of the current owner remains in the household, the Date of Purchase remains unchanged while the date of transfer of ownership will be updated.
*
* For outright transfer where there is a total change of all owner(s), only the Date of Purchase will be updated.
*
* See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14'
*/
dateofownershiptransfer?: {
/**
* example:
* 2018-06-13
*/
value?: string;
};
/**
* The amount of housing loan granted to owner(s) by HDB in SGD.
*/
loangranted?: {
/**
* example:
* 310000.01
*/
value?: number;
};
/**
* The number of years of loan repaymnet opted by owner(s) at the time the loan is first granted to him/her.
*/
originalloanrepayment?: {
/**
* example:
* 25
*/
value?: number;
};
/**
* The remaining term of repayment for the loan in the format `years` + `months`.
*/
balanceloanrepayment?: {
years?: {
/**
* example:
* 2
*/
value?: number;
};
months?: {
/**
* example:
* 6
*/
value?: number;
};
};
/**
* The amount of outstanding HDB loan owed by owner(s) in SGD.
*/
outstandingloanbalance?: {
/**
* example:
* 50000.01
*/
value?: number;
};
/**
* The amount of monthly instalment the owner(s) have to pay for his/her loan in SGD.
*/
monthlyloaninstalment?: {
/**
* example:
* 1000.01
*/
value?: number;
};
/**
* The amount of outstanding instalment the owner(s) have to pay for his/her loan in SGD.
*/
outstandinginstalment?: {
/**
* example:
* 1000.01
*/
value?: number;
};
/**
* The purchase price of the HDB flat in SGD.
*/
purchaseprice?: {
/**
* example:
* 1000.01
*/
value?: number;
};
}
/**
* HDBType
* Flat Type of the HDB flat.
*
* **Note 1:** that this excludes Rental Flats, Pre-War SIT flat, PSA flat, HUDC flat, Executive Condominium and Shophouse.
*
* **Note 2:** If `housingtype` is available, this value will be null.
*
* **Note 3:** If `housingtype` & `hdbtype` are unavailable, make this field user editable.
*
* '111' - 1-ROOM FLAT (HDB)
* '112' - 2-ROOM FLAT (HDB)
* '113' - 3-ROOM FLAT (HDB)
* '114' - 4-ROOM FLAT (HDB)
* '115' - 5-ROOM FLAT (HDB)
* '116' - EXECUTIVE FLAT (HDB)
* '118' - STUDIO APARTMENT (HDB)
*/
interface Hdbtype {
/**
*
* example:
* 112
*/
code?: "111" | "112" | "113" | "114" | "115" | "116" | "118";
/**
*
* example:
* 2-ROOM FLAT (HDB)
*/
desc?: "1-ROOM FLAT (HDB)" | "2-ROOM FLAT (HDB)" | "3-ROOM FLAT (HDB)" | "4-ROOM FLAT (HDB)" | "5-ROOM FLAT (HDB)" | "EXECUTIVE FLAT (HDB)" | "STUDIO APARTMENT (HDB)";
}
/**
* HomeNo
* Home Contact Number of Person.
*/
interface Homeno {
/**
* Prefix of Phone Number. Defaults to '+'. If phone number is blank, prefix will be returned as blank.
*/
prefix?: {
/**
* example:
* +
*/
value?: string;
};
/**
* Area Code of Phone Number. Default to '65'. If phone number is blank, code will be returned as blank.
*/
areacode?: {
/**
* example:
* 65
*/
value?: string;
};
/**
* Phone Number.
*/
nbr?: {
/**
* example:
* 66132665
*/
value?: string;
};
}
/**
* HouseholdIncome
* Household Income of Person in SGD.
*/
interface Householdincome {
/**
* upper bound of the range of household income bracket
*/
high?: {
/**
* example:
* 5999
*/
value?: number;
};
/**
* lower bound of the range of household income bracket
*/
low?: {
/**
* example:
* 5000
*/
value?: number;
};
}
/**
* HousingType
* Housing Type of Person (non-HDB only).
*
* **Note 1:** If `hdbtype` is available, this value will be null.
*
* **Note 2:** If `housingtype` & `hdbtype` are unavailable, make this field user editable.
*
* Refer to `hdbtype` for detailed HDB type.
*
* '121' - DETACHED HOUSE
* '122' - SEMI-DETACHED HOUSE
* '123' - TERRACE HOUSE
* '131' - CONDOMINIUM
* '132' - EXECUTIVE CONDOMINIUM
* '139' - APARTMENT
*/
interface Housingtype {
/**
*
* example:
* 123
*/
code?: "121" | "122" | "123" | "131" | "132" | "139";
/**
*
* example:
* TERRACE HOUSE
*/
desc?: "DETACHED HOUSE" | "SEMI-DETACHED HOUSE" | "TERRACE HOUSE" | "CONDOMINIUM" | "EXECUTIVE CONDOMINIUM" | "APARTMENT";
}
/**
* MailAdd
* Mailing Address of Person
*
* **Note:**
* - address can be either a Singapore address (type: 'SG') or non Singapore address (type: 'UNFORMATTED')
* - check the `type` discriminator property to differentiate between the two address formats
*
*/
type Mailadd =
/**
* MailAdd
* Mailing Address of Person
*
* **Note:**
* - address can be either a Singapore address (type: 'SG') or non Singapore address (type: 'UNFORMATTED')
* - check the `type` discriminator property to differentiate between the two address formats
*
*/
/**
* Address details (Singapore Format)
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
DataitemAddressSg
/**
* Address details (Non-Singapore Format)
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
| DataitemAddressUnformatted;
/**
* Marital
* Marital Status of Person.
*
* '1' - SINGLE
* '2' - MARRIED
* '3' - WIDOWED
* '5' - DIVORCED
*
* **Note:** This field must be made **editable** on your digital service form even though `source` is '1' (Government Verified).
*/
interface Marital {
/**
*
* example:
* 2
*/
code?: "1" | "2" | "3" | "5";
/**
*
* example:
* MARRIED
*/
desc?: "SINGLE" | "MARRIED" | "WIDOWED" | "DIVORCED";
}
/**
* MarriageCertNo
* Certificate number of the latest marriage.
*
*
* **Note:** This field must be made **editable** on your digital service form even though `source` is '1' (Government Verified).
*/
interface Marriagecertno {
/**
* Value of data field.
* example:
* 123456789012345
*/
value?: string;
}
/**
* MarriageDate
* Latest Marriage Date of Person.
*
*
* **Note:** This field must be made **editable** on your digital service form even though `source` is '1' (Government Verified).
*
*/
interface Marriagedate {
/**
* Value of data field.
*
* See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14
* example:
* 2007-01-01
*/
value?: string;
}
/**
* MarriedName
* Married name of the Person.
*
* Presentation Logic - If there is a value to `marriedname` (i.e. not empty), then `marriedname` should be displayed in a new line below `hanyupinyinaliasname`.*
*/
interface Marriedname {
/**
* value of the field, should be displayed as it is.
* example:
*
*/
value?: string;
}
/**
* MerdekaGen
* Merdekagen details
*/
interface Merdekagen {
/**
* Eligibility
*/
eligibility?: {
/**
* example:
* true
*/
value?: boolean;
};
/**
* Amount eligible for
*/
quantum?: {
/**
* example:
* 100
*/
value?: number;
};
/**
* Suggested user friendly display
*/
message?: {
/**
* example:
* 2
*/
code?: string;
/**
* example:
* You are eligible for the Merdeka Generation Package. For further enquiries, please contact 1800-2222-888.
*/
desc?: string;
};
}
/**
* MobileNo
* Mobile Number of Person.
*/
interface Mobileno {
/**
* Prefix of Phone Number. Defaults to '+'. If phone number is blank, prefix will be returned as blank.
*/
prefix?: {
/**
* example:
* +
*/
value?: string;
};
/**
* Area Code of Phone Number. Default to '65'. If phone number is blank, code will be returned as blank.
*/
areacode?: {
/**
* example:
* 65
*/
value?: string;
};
/**
* Phone Number.
*/
nbr?: {
/**
* example:
* 66132665
*/
value?: string;
};
}
interface NOA {
/**
* Assessable Income
*/
amount?: {
/**
* example:
* 100000.01
*/
value?: number;
};
/**
* value of data field
*/
yearofassessment?: {
/**
* example:
* 2018
*/
value?: string;
};
/**
* Assessable Income from employment
*/
employment?: {
/**
* example:
* 100000.01
*/
value?: number;
};
/**
* Assessable Income from trade
*/
trade?: {
/**
* example:
* 0
*/
value?: number;
};
/**
* Assessable Income from rent
*/
rent?: {
/**
* example:
* 0
*/
value?: number;
};
/**
* Assessable Income from interest
*/
interest?: {
/**
* example:
* 0
*/
value?: number;
};
/**
* Tax Clearance indicator. This means that tax clearance has been sought by the employer for this NOA assessment. For more information, please refer to [this](https://www.iras.gov.sg/irashome/Businesses/Employers/Tax-Clearance-for-Foreign-SPR-Employees/Getting-Tax-Clearance--A-Step-by-Step-Guide/)
*/
taxclearance?: {
/**
* example:
* N
*/
value?: "Y" | "N";
};
/**
* Type of 'Notice of Assessment' (NOA)
*/
category?: {
/**
* example:
* ORIGINAL
*/
value?: "ADDITIONAL" | "AMENDED" | "ORIGINAL" | "REPAYMENT";
};
}
interface NOABasic {
/**
* Assessable Income
*/
amount?: {
/**
* example:
* 100000.01
*/
value?: number;
};
/**
* The second latest annual assessable income available from IRAS within the past 3 years.
*/
yearofassessment?: {
/**
* example:
* 2018
*/
value?: string;
};
}
/**
* Name
* Full Name of the Person.
*/
interface Name {
/**
* value of the field, should be displayed as it is.
* example:
* TAN XIAO HUI
*/
value?: string;
}
/**
* Nationality
* Nationality/Citizenship of Person.
*
* Refer to the [Code reference tables](#section/Support) in the Support section for list of possible values.
*/
interface Nationality {
/**
*
* example:
* SG
*/
code?: string;
/**
*
* example:
* SINGAPORE CITIZEN
*/
desc?: string;
}
/**
* History of Notice Of Assessment
* Detailed breakdown of latest 2 Notice of Assessments within the past three years.
*/
interface Noahistory {
noas?: NOA[];
}
/**
* History of Notice Of Assessment (Basic)
* Summary of latest 2 Notice of Assessments within the past three years.
*/
interface NoahistoryBasic {
noas?: NOABasic[];
}
/**
* Occupation
* Occupation of Person.
*/
interface Occupation {
/**
* Free text.
*
* For SC/PR holders, blank will be returned.
* example:
*
*/
value?: string;
}
/**
* OwnerPrivate
* Ownership of Private Property Status of Person (based on IRAS information).
*
* true
* false
* null (data not available)
*/
interface Ownerprivate {
/**
* Value of data field.
* example:
* false
*/
value?: boolean;
}
/**
* Partial UINFIN
* Masked Singapore issued identification number of the Person. Only the last 3 digit and ending alphabet will be in clear.
*/
interface Partialuinfin {
/**
* Value of the field, should be displayed as it is.
* example:
* *****111D
*/
value?: string;
}
/**
* PassExpiryDate
* Pass expiry of a foreigner.
**Note:** Only applies to a foreigner with a valid pass.
*/
interface Passexpirydate {
/**
* Value of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14
* example:
* 2022-12-31
*/
value?: string;
}
/**
* PassportExpiryDate
* Passport Expiry Date of Person.
*/
interface Passportexpirydate {
/**
* Value of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14
* example:
* 2020-01-01
*/
value?: string;
}
/**
* PassportNumber
* Passport Number of Person.
*/
interface Passportnumber {
/**
* Value of data field.
* example:
* E35463874W
*/
value?: string;
}
/**
* PassStatus
* Pass status of a FIN holder.
**Note:** Only applies to a foreigner with a valid pass.
* Live
* Approved
*
*/
interface Passstatus {
/**
* Value of data field.
* example:
* Live
*/
value?: "Live" | "Approved";
}
/**
* PassType
* Pass type of a FIN holder.
**Note:** Only applies to a foreigner with a valid pass.
*
* Refer to the [Code reference tables](#section/Support) in the Support section for list of possible values.
*/
interface Passtype {
/**
* Value of data field.
* example:
* RPass
*/
code?: string;
/**
* example:
* Work Permit
*/
desc?: string;
}
/**
* Person instance's details (Basic Profile)
*/
interface Person {
/**
* Partial UINFIN
* Masked Singapore issued identification number of the Person. Only the last 3 digit and ending alphabet will be in clear.
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
partialuinfin?: {
/**
* Value of the field, should be displayed as it is.
* example:
* *****111D
*/
value?: string;
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* UINFIN
* Singapore issued identification number of the Person.
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
uinfin?: {
/**
* value of the field, should be displayed as it is.
* example:
* S1111111D
*/
value?: string;
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* Name
* Full Name of the Person.
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
name?: {
/**
* value of the field, should be displayed as it is.
* example:
* TAN XIAO HUI
*/
value?: string;
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* HanYuPinYin
* Han Yu Pin Yin name of the Person.
*
* Presentation Logic - If there is a value to `hanyupinyinname` (i.e. not empty), then `hanyupinyinname` should be displayed in a new line below `name`, and formatted with round brackets i.e. "(`hanyupinyinname`)"'*
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
hanyupinyinname?: {
/**
* example:
* CHEN XIAO HUI
*/
value?: string;
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* Alias
* Alias name of the Person.
*
* Presentation Logic - If there is a value to `aliasname` (i.e. not empty), then `aliasname` should be displayed in a new line below `hanyupinyinname`, and prefixed with the ''@'' symbol i.e. "@`aliasname`".'*
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
aliasname?: {
/**
* value of the field.
* example:
* TRICIA TAN XIAO HUI
*/
value?: string;
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* HanYuPinYinAlias
* Han Yu Pin Yin Alias name of the Person.
*
* Presentation Logic - If there is a value to `hanyupinyinaliasname` (i.e. not empty), then `hanyupinyinaliasname` should be displayed in a new line below `aliasname`, and prefixed with the ''@'' symbol i.e. "@`hanyupinyinaliasname`".*
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
hanyupinyinaliasname?: {
/**
* example:
* TRICIA CHEN XIAO HUI
*/
value?: string;
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* MarriedName
* Married name of the Person.
*
* Presentation Logic - If there is a value to `marriedname` (i.e. not empty), then `marriedname` should be displayed in a new line below `hanyupinyinaliasname`.*
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
marriedname?: {
/**
* value of the field, should be displayed as it is.
* example:
*
*/
value?: string;
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* Sex
* Sex of Person.
* 'F' - FEMALE
* 'M' - MALE
* 'U' - UNKNOWN
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
sex?: {
/**
* example:
* F
*/
code?: "F" | "M" | "U";
/**
*
* example:
* FEMALE
*/
desc?: "FEMALE" | "MALE" | "UNKNOWN";
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* Race
* Race of Person.
*
* Refer to the [Code reference tables](#section/Support) in the Support section for list of possible values.
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
race?: {
/**
* example:
* CN
*/
code?: string;
/**
* example:
* CHINESE
*/
desc?: string;
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* SecondaryRace
* Secondary Race of Person.
*
* Refer to the [Code reference tables](#section/Support) in the Support section for list of possible values.
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
secondaryrace?: {
/**
*
* example:
* EU
*/
code?: string;
/**
*
* example:
* EURASIAN
*/
desc?: string;
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* Dialect
* Dialect of Person.
*
* Refer to the [Code reference tables](#section/Support) in the Support section for list of possible values.
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
dialect?: {
/**
*
* example:
* SG
*/
code?: string;
/**
*
* example:
* SWISS GERMAN
*/
desc?: string;
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* Nationality
* Nationality/Citizenship of Person.
*
* Refer to the [Code reference tables](#section/Support) in the Support section for list of possible values.
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
nationality?: {
/**
*
* example:
* SG
*/
code?: string;
/**
*
* example:
* SINGAPORE CITIZEN
*/
desc?: string;
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* DOB
* Date of Birth of Person.
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
dob?: {
/**
* Value of data field.
* Format can be one of the below (with reference to http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14):
* - full-date
* - date-fullyear "-" date-month
* - date-fullyear
* example:
* 1958-05-17
*/
value?: string;
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* BirthCountry
* Country/Place of Birth of Person.
*
* Refer to the [Code reference tables](#section/Support) in the Support section for list of possible values.
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
birthcountry?: {
/**
*
* example:
* SG
*/
code?: string;
/**
*
* example:
* SINGAPORE
*/
desc?: string;
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* ResidentialStatus
* Residential Status of Person. Applicable to Singapore Citizens and Permanent Residents.
*
*
* **Note:** This data item is not applicable for FIN holders i.e. `source` will be '3'.
* In such cases, the `code` and `desc` properties will be blank or empty string ("").
*
* A - ALIEN
* C - CITIZEN
* P - PR
* U - UNKNOWN
* N - NOT APPLICABLE
* < BLANK > (for FIN holders only)
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
residentialstatus?: {
/**
* example:
* C
*/
code?: "A" | "C" | "P" | "U" | "N" | "";
/**
* example:
* CITIZEN
*/
desc?: "ALIEN" | "CITIZEN" | "PR" | "UNKNOWN" | "NOT APPLICABLE" | "";
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* PassportNumber
* Passport Number of Person.
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
passportnumber?: {
/**
* Value of data field.
* example:
* E35463874W
*/
value?: string;
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* PassportExpiryDate
* Passport Expiry Date of Person.
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
passportexpirydate?: {
/**
* Value of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14
* example:
* 2020-01-01
*/
value?: string;
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* RegAdd
* Registered Address of Person (including FIN holders)
*
* **Note:**
* - address can be either a Singapore address (type: 'SG') or non Singapore address (type: 'UNFORMATTED')
* - check the `type` discriminator property to differentiate between the two address formats
* - may be unavailable for some FIN holders
*/
regadd?:
/**
* Address details (Singapore Format)
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
DataitemAddressSg
/**
* Address details (Non-Singapore Format)
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
| DataitemAddressUnformatted;
/**
* MailAdd
* Mailing Address of Person
*
* **Note:**
* - address can be either a Singapore address (type: 'SG') or non Singapore address (type: 'UNFORMATTED')
* - check the `type` discriminator property to differentiate between the two address formats
*
*/
mailadd?:
/**
* Address details (Singapore Format)
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
DataitemAddressSg
/**
* Address details (Non-Singapore Format)
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
| DataitemAddressUnformatted;
/**
* BillAdd
* Billing Address of Person
*
* **Note:**
* - address can be either a Singapore address (type: 'SG') or non Singapore address (type: 'UNFORMATTED')
* - check the `type` discriminator property to differentiate between the two address formats
*
*/
billadd?:
/**
* Address details (Singapore Format)
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
DataitemAddressSg
/**
* Address details (Non-Singapore Format)
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
| DataitemAddressUnformatted;
/**
* HousingType
* Housing Type of Person (non-HDB only).
*
* **Note 1:** If `hdbtype` is available, this value will be null.
*
* **Note 2:** If `housingtype` & `hdbtype` are unavailable, make this field user editable.
*
* Refer to `hdbtype` for detailed HDB type.
*
* '121' - DETACHED HOUSE
* '122' - SEMI-DETACHED HOUSE
* '123' - TERRACE HOUSE
* '131' - CONDOMINIUM
* '132' - EXECUTIVE CONDOMINIUM
* '139' - APARTMENT
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
housingtype?: {
/**
*
* example:
* 123
*/
code?: "121" | "122" | "123" | "131" | "132" | "139";
/**
*
* example:
* TERRACE HOUSE
*/
desc?: "DETACHED HOUSE" | "SEMI-DETACHED HOUSE" | "TERRACE HOUSE" | "CONDOMINIUM" | "EXECUTIVE CONDOMINIUM" | "APARTMENT";
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* HDBType
* Flat Type of the HDB flat.
*
* **Note 1:** that this excludes Rental Flats, Pre-War SIT flat, PSA flat, HUDC flat, Executive Condominium and Shophouse.
*
* **Note 2:** If `housingtype` is available, this value will be null.
*
* **Note 3:** If `housingtype` & `hdbtype` are unavailable, make this field user editable.
*
* '111' - 1-ROOM FLAT (HDB)
* '112' - 2-ROOM FLAT (HDB)
* '113' - 3-ROOM FLAT (HDB)
* '114' - 4-ROOM FLAT (HDB)
* '115' - 5-ROOM FLAT (HDB)
* '116' - EXECUTIVE FLAT (HDB)
* '118' - STUDIO APARTMENT (HDB)
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
hdbtype?: {
/**
*
* example:
* 112
*/
code?: "111" | "112" | "113" | "114" | "115" | "116" | "118";
/**
*
* example:
* 2-ROOM FLAT (HDB)
*/
desc?: "1-ROOM FLAT (HDB)" | "2-ROOM FLAT (HDB)" | "3-ROOM FLAT (HDB)" | "4-ROOM FLAT (HDB)" | "5-ROOM FLAT (HDB)" | "EXECUTIVE FLAT (HDB)" | "STUDIO APARTMENT (HDB)";
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* HDBOwnership
* HDB Ownership details
*
*/
hdbownership?: {
/**
* Number of Owners. Note that this does not include executors, administrators or trustees.
*/
noofowners?: {
/**
* example:
* 2
*/
value?: number;
};
/**
* Address details (Singapore Format)
*/
address?: {
/**
* Type of Address (SG or UNFORMATTED for non SG)
*/
type?: "SG" | "UNFORMATTED";
/**
* Block/House of Address
*/
block?: {
/**
* example:
* 548
*/
value?: string;
};
/**
* Building of Address
*/
building?: {
/**
* example:
*
*/
value?: string;
};
/**
* Floor of Address
*/
floor?: {
/**
* example:
* 09
*/
value?: string;
};
/**
* Unit of Address
*/
unit?: {
/**
* example:
* 128
*/
value?: string;
};
/**
* Street of Address
*/
street?: {
/**
* example:
* BEDOK NORTH AVENUE 1
*/
value?: string;
};
/**
* Postal Code of Address
*/
postal?: {
/**
* example:
* 460548
*/
value?: string;
};
/**
* Country/Place of Address. For AddressSG this will always be "SG".
*/
country?: {
code?: string;
desc?: string;
};
};
/**
* HDBType
* Flat Type of the HDB flat.
*
* **Note 1:** that this excludes Rental Flats, Pre-War SIT flat, PSA flat, HUDC flat, Executive Condominium and Shophouse.
*
* **Note 2:** If `housingtype` is available, this value will be null.
*
* **Note 3:** If `housingtype` & `hdbtype` are unavailable, make this field user editable.
*
* '111' - 1-ROOM FLAT (HDB)
* '112' - 2-ROOM FLAT (HDB)
* '113' - 3-ROOM FLAT (HDB)
* '114' - 4-ROOM FLAT (HDB)
* '115' - 5-ROOM FLAT (HDB)
* '116' - EXECUTIVE FLAT (HDB)
* '118' - STUDIO APARTMENT (HDB)
*/
hdbtype?: {
/**
*
* example:
* 112
*/
code?: "111" | "112" | "113" | "114" | "115" | "116" | "118";
/**
*
* example:
* 2-ROOM FLAT (HDB)
*/
desc?: "1-ROOM FLAT (HDB)" | "2-ROOM FLAT (HDB)" | "3-ROOM FLAT (HDB)" | "4-ROOM FLAT (HDB)" | "5-ROOM FLAT (HDB)" | "EXECUTIVE FLAT (HDB)" | "STUDIO APARTMENT (HDB)";
};
/**
* Date from which the lease period starts. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14
*/
leasecommencementdate?: {
/**
* example:
* 2008-06-13
*/
value?: string;
};
/**
* Term of lease (in years) for the property computed from the lease commencement date.
*/
termoflease?: {
/**
* example:
* 99
*/
value?: number;
};
/**
* Effective date of flat purchase. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14
*/
dateofpurchase?: {
/**
* example:
* 2008-06-13
*/
value?: string;
};
/**
* Effective date of partial transfer without monetary consideration (e.g. addition, deletion or substitution of a co-owner) for an HDB sold flat.
*
* For partial transfer of flat where at least one of the current owner remains in the household, the Date of Purchase remains unchanged while the date of transfer of ownership will be updated.
*
* For outright transfer where there is a total change of all owner(s), only the Date of Purchase will be updated.
*
* See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14'
*/
dateofownershiptransfer?: {
/**
* example:
* 2018-06-13
*/
value?: string;
};
/**
* The amount of housing loan granted to owner(s) by HDB in SGD.
*/
loangranted?: {
/**
* example:
* 310000.01
*/
value?: number;
};
/**
* The number of years of loan repaymnet opted by owner(s) at the time the loan is first granted to him/her.
*/
originalloanrepayment?: {
/**
* example:
* 25
*/
value?: number;
};
/**
* The remaining term of repayment for the loan in the format `years` + `months`.
*/
balanceloanrepayment?: {
years?: {
/**
* example:
* 2
*/
value?: number;
};
months?: {
/**
* example:
* 6
*/
value?: number;
};
};
/**
* The amount of outstanding HDB loan owed by owner(s) in SGD.
*/
outstandingloanbalance?: {
/**
* example:
* 50000.01
*/
value?: number;
};
/**
* The amount of monthly instalment the owner(s) have to pay for his/her loan in SGD.
*/
monthlyloaninstalment?: {
/**
* example:
* 1000.01
*/
value?: number;
};
/**
* The amount of outstanding instalment the owner(s) have to pay for his/her loan in SGD.
*/
outstandinginstalment?: {
/**
* example:
* 1000.01
*/
value?: number;
};
/**
* The purchase price of the HDB flat in SGD.
*/
purchaseprice?: {
/**
* example:
* 1000.01
*/
value?: number;
};
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
}[];
/**
* OwnerPrivate
* Ownership of Private Property Status of Person (based on IRAS information).
*
* true
* false
* null (data not available)
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
ownerprivate?: {
/**
* Value of data field.
* example:
* false
*/
value?: boolean;
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* Email
* Email Address of Person.
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
email?: {
/**
* Value of data field.
* example:
* test@gmail.com
*/
value?: string;
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* HomeNo
* Home Contact Number of Person.
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
homeno?: {
/**
* Prefix of Phone Number. Defaults to '+'. If phone number is blank, prefix will be returned as blank.
*/
prefix?: {
/**
* example:
* +
*/
value?: string;
};
/**
* Area Code of Phone Number. Default to '65'. If phone number is blank, code will be returned as blank.
*/
areacode?: {
/**
* example:
* 65
*/
value?: string;
};
/**
* Phone Number.
*/
nbr?: {
/**
* example:
* 66132665
*/
value?: string;
};
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* MobileNo
* Mobile Number of Person.
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
mobileno?: {
/**
* Prefix of Phone Number. Defaults to '+'. If phone number is blank, prefix will be returned as blank.
*/
prefix?: {
/**
* example:
* +
*/
value?: string;
};
/**
* Area Code of Phone Number. Default to '65'. If phone number is blank, code will be returned as blank.
*/
areacode?: {
/**
* example:
* 65
*/
value?: string;
};
/**
* Phone Number.
*/
nbr?: {
/**
* example:
* 66132665
*/
value?: string;
};
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* Marital
* Marital Status of Person.
*
* '1' - SINGLE
* '2' - MARRIED
* '3' - WIDOWED
* '5' - DIVORCED
*
* **Note:** This field must be made **editable** on your digital service form even though `source` is '1' (Government Verified).
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
marital?: {
/**
*
* example:
* 2
*/
code?: "1" | "2" | "3" | "5";
/**
*
* example:
* MARRIED
*/
desc?: "SINGLE" | "MARRIED" | "WIDOWED" | "DIVORCED";
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* MarriageCertNo
* Certificate number of the latest marriage.
*
*
* **Note:** This field must be made **editable** on your digital service form even though `source` is '1' (Government Verified).
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
marriagecertno?: {
/**
* Value of data field.
* example:
* 123456789012345
*/
value?: string;
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* CountryOfMarriage
* Country/Place of the latest marriage.
*
*
* **Note:** This field must be made **editable** on your digital service form even though `source` is '1' (Government Verified).
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
countryofmarriage?: {
/**
*
* example:
* SG
*/
code?: string;
/**
*
* example:
* SINGAPORE
*/
desc?: string;
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* MarriageDate
* Latest Marriage Date of Person.
*
*
* **Note:** This field must be made **editable** on your digital service form even though `source` is '1' (Government Verified).
*
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
marriagedate?: {
/**
* Value of data field.
*
* See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14
* example:
* 2007-01-01
*/
value?: string;
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* DivorceDate
* Last Divorce Date of Person.
*
*
* **Note:** This field must be made **editable** on your digital service form even though `source` is '1' (Government Verified).
*
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
divorcedate?: {
/**
* Value of data field.
*
* See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14
* example:
*
*/
value?: string;
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* ChildrenBirthRecords
* This refers to only local registered birth records(based on ICA’s electronic Birth Certificate Records from 1985 onwards).
*
* This includes adoption of locally registered child.
*
* For child below 21, the child’s Birth Cert No, Name, Sex, Race, Dialect, Date of Birth and Time of Birth will be shown.
*
* For child above 21, only the child’s Birth Cert Number will be shown.
*/
childrenbirthrecords?: {
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
/**
* Birth certificate number of child.
*/
birthcertno?: {
/**
* example:
* S5562882C
*/
value?: string;
};
/**
* Full Name of child
*/
name?: {
/**
* example:
* Jo Tan Pei Ni
*/
value?: string;
};
/**
* Han Yu Pin Yin name of child.
*
* Presentation Logic - If there is a value to `hanyupinyinname` (i.e. not empty), then `hanyupinyinname` should be displayed in a new line below `name`, and formatted with round brackets i.e. \"(`hanyupinyinname`)\".*
*/
hanyupinyinname?: {
/**
* example:
* Cheng Pei Ni
*/
value?: string;
};
/**
* Alias name of child.
*
* Presentation Logic - If there is a value to `aliasname` (i.e. not empty), then `aliasname` should be displayed in a new line below `hanyupinyinname`, and prefixed with the ''@'' symbol i.e. \"@`aliasname`\".*
*/
aliasname?: {
/**
* example:
*
*/
value?: string;
};
/**
* Han Yu Pin Yin Alias name of child.
*
* Presentation Logic - If there is a value to `hanyupinyinaliasname` (i.e. not empty), then `hanyupinyinaliasname` should be displayed in a new line below `aliasname`, and prefixed with the ''@'' symbol i.e. \"@`hanyupinyinaliasname`\".*
*/
hanyupinyinaliasname?: {
/**
* example:
*
*/
value?: string;
};
/**
* Married name of child.
*
* Presentation Logic - If there is a value to `marriedname` (i.e. not empty), then `marriedname` should be displayed in a new line below `hanyupinyinaliasname`.*
*/
marriedname?: {
/**
* example:
*
*/
value?: string;
};
/**
* Sex of child. Possible values:
*
* 'F' - FEMALE
* 'M' - MALE
* 'U' - UNKNOWN
*/
sex?: {
/**
* example:
* F
*/
code?: "F" | "M" | "U";
/**
* example:
* FEMALE
*/
desc?: "FEMALE" | "MALE" | "UNKNOWN";
};
/**
* Race of child.
*
* Refer to the [Code reference tables](#section/Support) in the Support section for list of possible values.
*
*/
race?: {
/**
* example:
* CN
*/
code?: string;
/**
* example:
* CHINESE
*/
desc?: string;
};
/**
* Secondary Race of child.
*
* Refer to the [Code reference tables](#section/Support) in the Support section for list of possible values.
*/
secondaryrace?: {
/**
* example:
*
*/
code?: string;
/**
* example:
*
*/
desc?: string;
};
/**
* Dialect of child.
*
* Refer to the [Code reference tables](#section/Support) in the Support section for list of possible values.
*/
dialect?: {
/**
* example:
* HK
*/
code?: string;
/**
* example:
* HOKKIEN
*/
desc?: string;
};
/**
* Life Status of child. Possible values:
*
* A - ALIVE
* D - DECEASED
*/
lifestatus?: {
/**
* example:
* D
*/
code?: "A" | "D";
/**
* example:
* DECEASED
*/
desc?: "ALIVE" | "DECEASED";
};
/**
* Date of Birth of child.
*
* See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14
*/
dob?: {
/**
* example:
* 2011-09-10
*/
value?: string;
};
/**
* Time of Birth of child.
*
* Format: HHMM
*/
tob?: {
/**
* example:
* 0901
*/
value?: string;
};
vaccinationrequirements?: {
/**
* Vaccination Requirement.
*
* Refer to the [Code reference tables](#section/Support) in the Support section for list of possible values.
*/
requirement?: {
/**
* example:
* 1M3D
*/
code?: string;
/**
* example:
* MINIMUM VACCINATION REQUIREMENT FOR PRESCHOOL
*/
desc?: string;
};
fulfilled?: {
/**
* example:
* true
*/
value?: boolean;
};
}[];
/**
* Indicates whether the child is a Singapore Citizen at the time of birth.
*
* Y - Yes
* N - No
* < BLANK > - Not applicable
*/
sgcitizenatbirthind?: {
/**
* example:
* Y
*/
value?: "Y" | "N" | "";
};
}[];
/**
* SponsoredChildrenRecords
* Details of children sponsored to be SC/PR/LTVP
*
* For child below 21, the child's NRIC/FIN, Name, Sex, Race, Secondary Race, Dialect, Date of Birth, Country/Place of Birth, Residential Status and SC/PR/LTVP grant date will be shown.
*
* For child above 21, only the child's last known NRIC/FIN will be shown.
*/
sponsoredchildrenrecords?: {
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
/**
* NRIC/FIN of child
*/
nric?: {
/**
* example:
* S5562882C
*/
value?: string;
};
/**
* Full Name of child
*/
name?: {
/**
* example:
* Jo Tan Pei Ni
*/
value?: string;
};
/**
* Han Yu Pin Yin name of child.
*/
hanyupinyinname?: {
/**
* example:
* Cheng Pei Ni
*/
value?: string;
};
/**
* Alias name of child.
*/
aliasname?: {
/**
* example:
*
*/
value?: string;
};
/**
* Han Yu Pin Yin Alias name of child.
*/
hanyupinyinaliasname?: {
/**
* example:
*
*/
value?: string;
};
/**
* Married name of child.
*/
marriedname?: {
/**
* example:
*
*/
value?: string;
};
/**
* Sex of child. Possible values:
*
* 'F' - FEMALE
* 'M' - MALE
* 'U' - UNKNOWN
*/
sex?: {
/**
* example:
* F
*/
code?: "F" | "M" | "U";
/**
* example:
* FEMALE
*/
desc?: "FEMALE" | "MALE" | "UNKNOWN";
};
/**
* Race of child.
*
* Refer to the [Code reference tables](#section/Support) in the Support section for list of possible values.
*/
race?: {
/**
* example:
* CN
*/
code?: string;
/**
* example:
* CHINESE
*/
desc?: string;
};
/**
* Secondary Race of child.
*
* Refer to the [Code reference tables](#section/Support) in the Support section for list of possible values.
*/
secondaryrace?: {
/**
* example:
*
*/
code?: string;
/**
* example:
*
*/
desc?: string;
};
/**
* Dialect of child.
*
* Refer to the [Code reference tables](#section/Support) in the Support section for list of possible values.
*/
dialect?: {
/**
* example:
* HK
*/
code?: string;
/**
* example:
* HOKKIEN
*/
desc?: string;
};
/**
* Date of Birth of child.
*
* See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14
*/
dob?: {
/**
* example:
* 2011-09-10
*/
value?: string;
};
/**
* BirthCountry
* Country/Place of Birth of child.
*
* Refer to the [Code reference tables](#section/Support) in the Support section for list of possible values.
*/
birthcountry?: {
/**
* example:
* SG
*/
code?: string;
/**
* example:
* SINGAPORE
*/
desc?: string;
};
/**
* Life Status of child. Possible values:
*
* A - ALIVE
* D - DECEASED
*/
lifestatus?: {
/**
* example:
* A
*/
code?: "A" | "D";
/**
* example:
* ALIVE
*/
desc?: "ALIVE" | "DECEASED";
};
/**
* ResidentialStatus
* Residential Status of child. Possible values:
*
* A - ALIEN
* C - CITIZEN
* P - PR
* U - UNKNOWN
* N - NOT APPLICABLE
*/
residentialstatus?: {
/**
* example:
* C
*/
code?: "A" | "C" | "P" | "U" | "N";
/**
* example:
* Citizen
*/
desc?: "ALIEN" | "CITIZEN" | "PR" | "UNKNOWN" | "NOT APPLICABLE";
};
/**
* Nationality/Citizenship of child.
*
* Refer to the [Code reference tables](#section/Support) in the Support section for list of possible values.
*/
nationality?: {
/**
* example:
* SG
*/
code?: string;
/**
* example:
* SINGAPORE CITIZEN
*/
desc?: string;
};
/**
* Date granted Singapore Citizenship, Permanent Resident or Long-term Visit Pass
*
* See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14
*/
scprgrantdate?: {
/**
* example:
* 2015-06-13
*/
value?: string;
};
vaccinationrequirements?: {
/**
* Vaccination Requirement
*
* Refer to the [Code reference tables](#section/Support) in the Support section for list of possible values.
*/
requirement?: {
/**
* example:
* 1M3D
*/
code?: string;
/**
* example:
* MINIMUM VACCINATION REQUIREMENT FOR PRESCHOOL
*/
desc?: string;
};
fulfilled?: {
/**
* example:
* true
*/
value?: boolean;
};
}[];
}[];
/**
* EduLevel
* Highest Education Level of Person.
*
* '0' - NO FORMAL QUALIFICATION / PRE-PRIMARY / LOWER PRIMARY
* '1' - PRIMARY
* '2' - LOWER SECONDARY
* '3' - SECONDARY
* '4' - POST-SECONDARY (NON-TERTIARY): GENERAL & VOCATION
* '5' - POLYTECHNIC DIPLOMA
* '6' - PROFESSIONAL QUALIFICATION AND OTHER DIPLOMA
* '7' - BACHELOR'S OR EQUIVALENT
* '8' - POSTGRADUATE DIPLOMA / CERTIFICATE (EXCLUDING MASTER'S AND DOCTORATE)
* '9' - MASTER'S AND DOCTORATE OR EQUIVALENT
* 'N' - MODULAR CERTIFICATION (NON-AWARD COURSES / NON-FULL QUALIFICATIONS)
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
edulevel?: {
/**
*
* example:
* 7
*/
code?: "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" | "N";
/**
* example:
* BACHELOR'S OR EQUIVALENT
*/
desc?: "NO FORMAL QUALIFICATION / PRE-PRIMARY / LOWER PRIMARY" | "PRIMARY" | "LOWER SECONDARY" | "SECONDARY" | "POST-SECONDARY (NON-TERTIARY): GENERAL & VOCATION" | "POLYTECHNIC DIPLOMA" | "PROFESSIONAL QUALIFICATION AND OTHER DIPLOMA" | "BACHELOR'S OR EQUIVALENT" | "POSTGRADUATE DIPLOMA / CERTIFICATE (EXCLUDING MASTER'S AND DOCTORATE)" | "MASTER'S AND DOCTORATE OR EQUIVALENT" | "MODULAR CERTIFICATION (NON-AWARD COURSES / NON-FULL QUALIFICATIONS)";
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* GradYear
* Year of Graduation of Person. Format: YYYY
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
gradyear?: {
/**
* example:
* 2006
*/
value?: string;
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* SchoolName
* Name of School of Person.
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
schoolname?: {
/**
* Code value of school name.
*
* **Note:** Code+desc and value are mutually exclusive.
* example:
* T07GS3011J
*/
code?: string;
/**
* Name of school represented by 'code'
*
* **Note:** Code+desc and value are mutually exclusive.
* example:
* SIGLAP SECONDARY SCHOOL
*/
desc?: string;
/**
* Free text value of school name.
*
* **Note:** Code+desc and value are mutually exclusive.
* example:
*
*/
value?: string;
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* Occupation
* Occupation of Person.
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
occupation?: {
/**
* Free text.
*
* For SC/PR holders, blank will be returned.
* example:
*
*/
value?: string;
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* Employment
* Name of Employer.
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
employment?: {
/**
* example:
* ALPHA
*/
value?: string;
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* PassType
* Pass type of a FIN holder.
**Note:** Only applies to a foreigner with a valid pass.
*
* Refer to the [Code reference tables](#section/Support) in the Support section for list of possible values.
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
passtype?: {
/**
* Value of data field.
* example:
* RPass
*/
code?: string;
/**
* example:
* Work Permit
*/
desc?: string;
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* PassStatus
* Pass status of a FIN holder.
**Note:** Only applies to a foreigner with a valid pass.
* Live
* Approved
*
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
passstatus?: {
/**
* Value of data field.
* example:
* Live
*/
value?: "Live" | "Approved";
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* PassExpiryDate
* Pass expiry of a foreigner.
**Note:** Only applies to a foreigner with a valid pass.
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
passexpirydate?: {
/**
* Value of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14
* example:
* 2022-12-31
*/
value?: string;
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* EmploymentSector
* Employment Sector of a FIN holder.
*
* **Note:** Only applies to a foreigner with a valid work pass.
*
* Some examples of possible values are:
* MANUFACTURING
* CONSTRUCTION
* RECLAMATION
* SERVICE
* GRI-TECHNOLOGY
* LANDSCAPING
* INCINERATOR PLANT
* MARINE SHIPYARD
* PROCESS
* HARBOURCRAFT
* DOMESTIC
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
employmentsector?: {
/**
* example:
* MANUFACTURING
*/
value?: string;
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* HouseholdIncome
* Household Income of Person in SGD.
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
householdincome?: {
/**
* upper bound of the range of household income bracket
*/
high?: {
/**
* example:
* 5999
*/
value?: number;
};
/**
* lower bound of the range of household income bracket
*/
low?: {
/**
* example:
* 5000
*/
value?: number;
};
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
vehicles?: {
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
/**
* Vehicle Registration Number displayed on the vehicle number plates
*/
vehicleno?: {
/**
* example:
* SDF1235A
*/
value?: string;
};
/**
* Type of Vehicles such as 'MOTOR CAR', 'STATION /WAGON/JEEP/LAND ROVER'
*/
type?: {
/**
* example:
* PASSENGER MOTOR CAR
*/
value?: string;
};
/**
* In-Vehicle Unit (IU) number of the device fitted in Singapore-registered vehicles for Electronic Road Pricing (ERP) gantries and Electronic Parking System (EPS) car parks.
*/
iulabelno?: {
/**
* example:
*
*/
value?: string;
};
/**
* Vehicle Make such as 'TOYOTA', 'HONDA', 'AUDI'
*/
make?: {
/**
* example:
* TOYOTA
*/
value?: string;
};
/**
* Vehicle Model such as 'COROLLA ALTIS CLASSIC 1.6 CVT', 'HRV 1.5 DX CVT'
*/
model?: {
/**
* example:
* COROLLA ALTIS
*/
value?: string;
};
/**
* Vehicle Chassis Number
*/
chassisno?: {
/**
* example:
* ZC11S1735800
*/
value?: string;
};
/**
* Vehicle Engine Number
*/
engineno?: {
/**
* example:
* M13A1837453
*/
value?: string;
};
/**
* Vehicle Motor Number
*/
motorno?: {
/**
* example:
*
*/
value?: string;
};
/**
* Manufacturing year
*/
yearofmanufacture?: {
/**
* example:
* 2010
*/
value?: string;
};
/**
* Date when vehicle is registered with LTA. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14'
*/
firstregistrationdate?: {
/**
* example:
* 2010-06-06
*/
value?: string;
};
/**
* Date when vehicle is first registered in the country of origin. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14'
*/
originalregistrationdate?: {
/**
* example:
* 2010-06-06
*/
value?: string;
};
/**
* Vehicle Certificate of Entitlement (COE) bid category
*/
coecategory?: {
/**
* example:
* A - CAR UP TO 1600CC & 97KW (130BHP)
*/
value?: string;
};
/**
* Vehicle Certificate of Entitlement (COE) expiry date. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14'
*/
coeexpirydate?: {
/**
* example:
* 2020-06-05
*/
value?: string;
};
/**
* See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14'
*/
roadtaxexpirydate?: {
/**
* example:
* 2020-06-05
*/
value?: string;
};
/**
* Actual Quota Premium (QP) amount payable for the COE upon registration, conversion or COE revalidation in Singapore dollars (SGD). For renewal of COE, the value will contain actual PQP paid.
*/
quotapremium?: {
/**
* example:
* 14000.01
*/
value?: number;
};
/**
* Open Market Value is the value of manufacturer invoice price, freight and insurance in Singapore dollars (SGD).
*/
openmarketvalue?: {
/**
* example:
* 25000.01
*/
value?: number;
};
/**
* CO2 emission rate
*/
co2emission?: {
/**
* example:
* 146.01
*/
value?: number;
};
/**
* Status of the Vehicle.
*
* 1 - LIVE
* 2 - DE-REGISTERED
*/
status?: {
/**
* example:
* 1
*/
code?: "1" | "2";
/**
* example:
* LIVE
*/
desc?: "LIVE" | "DE-REGISTERED";
};
/**
* Vehicle Primary Colour (e.g. BLACK)
*/
primarycolour?: {
/**
* example:
* BLACK
*/
value?: string;
};
/**
* Vehicle Primary Colour (e.g. WHITE)
*/
secondarycolour?: {
/**
* example:
* WHITE
*/
value?: string;
};
/**
* Vehicle Attachment 1 (e.g. DISABLED)
*/
attachment1?: {
/**
* example:
* DISABLED
*/
value?: string;
};
/**
* Vehicle Attachment 2 (e.g. WITH SUN ROOF)
*/
attachment2?: {
/**
* example:
* WITH SUN ROOF
*/
value?: string;
};
/**
* Vehicle Attachment 3 (e.g. SIDE CURTAIN)
*/
attachment3?: {
/**
* example:
* SIDE CURTAIN
*/
value?: string;
};
/**
* Vehicle Scheme (e.g. REVISED OFF-PEAK CAR)
*/
scheme?: {
/**
* example:
* REVISED OFF-PEAK CAR
*/
value?: string;
};
/**
* Total Hydro Carbon (THC) emission rate
*/
thcemission?: {
/**
* example:
* 1.011001
*/
value?: number;
};
/**
* Carbon Monoxide emission rate
*/
coemission?: {
/**
* example:
* 1.100001
*/
value?: number;
};
/**
* Nitrogen Oxide (NOx) emission rate.
*/
noxemission?: {
/**
* example:
* 0.011001
*/
value?: number;
};
/**
* Particulates (PM - Atmospheric Particulate Matter) emission rate.
*/
pmemission?: {
/**
* example:
* 0.007
*/
value?: number;
};
/**
* Engine Capacity in cubic centimeter (cc)
*/
enginecapacity?: {
/**
* example:
* 1600
*/
value?: number;
};
/**
* Power Rate. Applicable to Electric and Hybrid vehicles powered by electric motors. Unit is Kilowatt.
*/
powerrate?: {
/**
* example:
* 1.41
*/
value?: number;
};
/**
* Effective Date/Time of Ownership. See "date-time" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14'
*/
effectiveownership?: {
/**
* example:
* 2010-08-31T20:12:12+08:00
*/
value?: string;
};
/**
* Propellant (e.g. Compressed Natural Gas, Diesel, Diesel-CNG, Diesel-Electric, Diesel-Electric (Plug-In), Electric, Gas, Liquefied Petroleum Gas (LPG), Petrol, Petrol-CNG, Petrol-Electric, Petrol-Electric (Plug-In), Petrol-LPG
*/
propellant?: {
/**
* example:
* Compressed Natural Gas
*/
value?: string;
};
/**
* Maximum Unladen Weight in kilograms (kg)
*/
maximumunladenweight?: {
/**
* example:
* 1500
*/
value?: number;
};
/**
* Maximum Laden Weight in kilograms (kg)
*/
maximumladenweight?: {
/**
* example:
* 1795
*/
value?: number;
};
/**
* Minimum PARF Benefit in Singapore dollars (SGD).
*/
minimumparfbenefit?: {
/**
* example:
* 8770.01
*/
value?: number;
};
/**
* Number of Transfer
*/
nooftransfers?: {
/**
* example:
* 2
*/
value?: number;
};
/**
* Vehicle Parking Certificate. Applicable for Heavy Vehicles.
*/
vpc?: {
/**
* example:
* 1234567890
*/
value?: string;
};
}[];
/**
* Driving Licence details of Person.
*
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
drivinglicence?: {
/**
* Status of Certificate of Merit. Possible values:
*
* Y - ELIGIBLE
* N - NOT ELIGIBLE
*/
comstatus?: {
/**
* example:
* Y
*/
code?: "Y" | "N";
/**
*
* example:
* ELIGIBLE
*/
desc?: "ELIGIBLE" | "NOT ELIGIBLE";
};
/**
* Total Demerit Points
*/
totaldemeritpoints?: {
/**
* example:
* 0
*/
value?: number;
};
/**
*
*/
suspension?: {
/**
* Suspension Start Date
*/
startdate?: {
/**
* example:
*
*/
value?: string;
};
/**
* Suspension End Date
*/
enddate?: {
/**
* example:
*
*/
value?: string;
};
};
/**
*
*/
disqualification?: {
/**
* Disqualification Start Date
*/
startdate?: {
/**
* example:
*
*/
value?: string;
};
/**
* Disqualification End Date
*/
enddate?: {
/**
* example:
*
*/
value?: string;
};
};
/**
*
*/
revocation?: {
/**
* Revocation Start Date
*/
startdate?: {
/**
* example:
*
*/
value?: string;
};
/**
* Revocation End Date
*/
enddate?: {
/**
* example:
*
*/
value?: string;
};
};
/**
* Provisional Driving Licence (PDL)
*/
pdl?: {
/**
* Validity of PDL. Possible values:
*
* V - VALID
* E - EXPIRED
* I - INVALID
* N - NOT HOLDING
*/
validity?: {
/**
* example:
* V
*/
code?: "V" | "E" | "I" | "N";
/**
*
* example:
* VALID
*/
desc?: "VALID" | "EXPIRED" | "INVALID" | "NOT HOLDING";
};
/**
* PDL Expiry Date
*/
expirydate?: {
/**
* example:
* 2020-06-15
*/
value?: string;
};
/**
* PDL Classes
* example:
* [
* {
* "class": {
* "value": "2A"
* }
* },
* {
* "class": {
* "value": "3A"
* }
* }
* ]
*/
classes?: {
class?: {
value?: string;
};
}[];
};
/**
* Qualified Driving Licence (QDL)
*/
qdl?: {
/**
* Validity of QDL. Possible values:
*
* V - VALID
* E - EXPIRED
* I - INVALID
* N - NOT HOLDING
*/
validity?: {
/**
* example:
* V
*/
code?: "V" | "E" | "I" | "N";
/**
*
* example:
* VALID
*/
desc?: "VALID" | "EXPIRED" | "INVALID" | "NOT HOLDING";
};
/**
* QDL Expiry Date
*/
expirydate?: {
/**
* example:
* 2020-06-15
*/
value?: string;
};
/**
* QDL Classes. Includes Issue Date (e.g. 2B, 2018-01-01)
* example:
* [
* {
* "class": {
* "value": "2A"
* },
* "issuedate": {
* "value": "2018-06-06"
* }
* },
* {
* "class": {
* "value": "3A"
* },
* "issuedate": {
* "value": "2018-06-06"
* }
* }
* ]
*/
classes?: {
class?: {
value?: string;
};
issuedate?: {
value?: string;
};
}[];
};
/**
* Serial Number of the Photo Card
*/
photocardserialno?: {
/**
* example:
* 115616
*/
value?: string;
};
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* Academic Qualifications
* Academic Qualifications achieved
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
academicqualifications?: {
/**
* Transcript of qualification
*/
transcripts?: {
/**
* Qualification's Name
*/
name?: {
/**
* example:
* SINGAPORE-CAMBRIDGE GENERAL CERTIFICATE OF EDUCATION ORDINARY LEVEL
*/
value?: string;
};
/**
* Year this qualification was attained
*
* See "date-fullyear" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14'
*/
yearattained?: {
/**
* example:
* 2018
*/
value?: string;
};
results?: {
/**
* Subject taken
*/
subject?: {
/**
* example:
* English Language
*/
value?: string;
};
/**
* Level of subject taken
*/
level?: {
/**
* example:
* Ordinary
*/
value?: string;
};
/**
* Grade attained
*/
grade?: {
/**
* example:
* A
*/
value?: string;
};
/**
* Optional Sub Subject taken
*/
subsubject?: {
/**
* example:
* SPECIAL PAPER
*/
value?: string;
};
/**
* Optional grade attained for subSubject
*/
subgrade?: {
/**
* example:
* One
*/
value?: string;
};
}[];
/**
* Explanatory Notes
*/
explanatorynotes?: {
value?: string;
};
}[];
/**
* Electronic Certificates Uploaded
*/
certificates?: {
/**
* File name of the electronic certificate
*/
name?: {
/**
* example:
* nus.opencert
*/
value?: string;
};
/**
* File content of the electronic certificate, Base64 encoded
*/
content?: {
value?: string;
};
/**
* Open Certificate Information
*
* Note: The test environment for OpenCert is at https://dev.opencerts.io/ while production is
* at https://opencerts.io/
*/
opencertificate?: {
/**
* The OpenCert serial number.
*/
id?: {
/**
* example:
* 100000000343840
*/
value?: string;
};
/**
* Indicate whether this open certificate is primary certificate
*/
primary?: {
/**
* example:
* true
*/
value?: boolean;
};
};
/**
* Indicate whether this file is open certificate
*/
opencertificateindicator?: {
/**
* example:
* true
*/
value?: boolean;
};
}[];
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
pioneergen?: {
eligibility: {
value: boolean;
};
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
quantum: {
value: string;
};
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4" | "1" | "2" | "3" | "4" | "1" | "2" | "3" | "4";
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C" | "C" | "C";
/**
* Message code
*
* '1' - PG Eligibility Tag: N
* '2' - PG Eligibility Tag: Y, Sign-up Tag: Y, Invalid Address Tag: N
* '3' - PG Eligibility Tag: Y, Sign-up Tag: Y, Invalid Address Tag: Y
* '4' - PG Eligibility Tag: Y, Sign-up Tag: N, Invalid Address Tag: N
* '5' - PG Eligibility Tag: Y, Sign-up Tag: N, Invalid Address Tag: Y
* '6' - PG Eligibility Tag: Y, Opt-Out Tag: Y
* '7' - PG Eligibility Tag: Y, Sign-up Tag: Y, NIL Status: Y
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
message: {
code: "1" | "2" | "3" | "4" | "5" | "6" | "7" | "1" | "2" | "3" | "4" | "5" | "6" | "7";
desc: "We regret that you are not eligible for the Pioneer Generation Package. For further enquiries, please contact 1800-2222-888." | "You are eligible for the Pioneer Generation Package. For further enquiries, please contact 1800-2222-888." | "You are eligible for the Pioneer Generation Package. Please contact 1800-2222-888 to receive your Pioneer Generation card." | "You are eligible for the Pioneer Generation Package. Please contact 1800-2222-888 to start receiving your Pioneer Generation benefits, such as your MediSave top-up." | "You are eligible for the Pioneer Generation Package. Please contact 1800-2222-888 to start receiving your Pioneer Generation benefits." | "We understand that you have opted out of receiving the benefits under the Pioneer Generation Package. For further enquiries, please contact 1800-2222-888." | "Please call 1800-2222-888 to start receiving your PG benefits." | "We regret that you are not eligible for the Pioneer Generation Package. For further enquiries, please contact 1800-2222-888." | "You are eligible for the Pioneer Generation Package. For further enquiries, please contact 1800-2222-888." | "You are eligible for the Pioneer Generation Package. Please contact 1800-2222-888 to receive your Pioneer Generation card." | "You are eligible for the Pioneer Generation Package. Please contact 1800-2222-888 to start receiving your Pioneer Generation benefits, such as your MediSave top-up." | "You are eligible for the Pioneer Generation Package. Please contact 1800-2222-888 to start receiving your Pioneer Generation benefits." | "We understand that you have opted out of receiving the benefits under the Pioneer Generation Package. For further enquiries, please contact 1800-2222-888." | "Please call 1800-2222-888 to start receiving your PG benefits.";
};
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* MerdekaGen
* Merdekagen details
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
merdekagen?: {
/**
* Eligibility
*/
eligibility?: {
/**
* example:
* true
*/
value?: boolean;
};
/**
* Amount eligible for
*/
quantum?: {
/**
* example:
* 100
*/
value?: number;
};
/**
* Suggested user friendly display
*/
message?: {
/**
* example:
* 2
*/
code?: string;
/**
* example:
* You are eligible for the Merdeka Generation Package. For further enquiries, please contact 1800-2222-888.
*/
desc?: string;
};
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* SilverSupport
* Silver Support Scheme details
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
silversupport?: {
/**
* Eligibility
*/
eligibility?: {
/**
* example:
* true
*/
value?: boolean;
};
/**
* Amount eligible for
*/
amount?: {
/**
* example:
* 300
*/
value?: number;
};
/**
* Year given
*/
year?: {
/**
* Value of data field. See "date-fullyear" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14
* example:
* 2019
*/
value?: string;
};
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* GSTVoucher
* GST Voucher details
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
gstvoucher?: {
/**
* Indicator if user is excluded
*/
exclusion?: {
/**
* example:
* false
*/
value?: boolean;
};
/**
* Indicator if user needs to signup
*/
signup?: {
/**
* example:
* true
*/
value?: boolean;
};
/**
* Amount given for medisave account
*/
gstmedisave?: {
/**
* example:
* 100
*/
value?: number;
};
/**
* Amount given for ordinary account
*/
gstregular?: {
/**
* example:
* 100
*/
value?: number;
};
/**
* Amount given for special account
*/
gstspecial?: {
/**
* example:
* 100
*/
value?: number;
};
/**
* Year given
*/
year?: {
/**
* Value of data field. See "date-fullyear" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14
* example:
* 2019
*/
value?: string;
};
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* Summary of latest Notice of Assessment within the past three years.
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
"noa-basic"?: {
/**
* Assessable Income
*/
amount?: {
/**
* example:
* 100000.01
*/
value?: number;
};
/**
* The second latest annual assessable income available from IRAS within the past 3 years.
*/
yearofassessment?: {
/**
* example:
* 2018
*/
value?: string;
};
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* Detailed breakdown of latest Notice of Assessment within the past three years.
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
noa?: {
/**
* Assessable Income
*/
amount?: {
/**
* example:
* 100000.01
*/
value?: number;
};
/**
* value of data field
*/
yearofassessment?: {
/**
* example:
* 2018
*/
value?: string;
};
/**
* Assessable Income from employment
*/
employment?: {
/**
* example:
* 100000.01
*/
value?: number;
};
/**
* Assessable Income from trade
*/
trade?: {
/**
* example:
* 0
*/
value?: number;
};
/**
* Assessable Income from rent
*/
rent?: {
/**
* example:
* 0
*/
value?: number;
};
/**
* Assessable Income from interest
*/
interest?: {
/**
* example:
* 0
*/
value?: number;
};
/**
* Tax Clearance indicator. This means that tax clearance has been sought by the employer for this NOA assessment. For more information, please refer to [this](https://www.iras.gov.sg/irashome/Businesses/Employers/Tax-Clearance-for-Foreign-SPR-Employees/Getting-Tax-Clearance--A-Step-by-Step-Guide/)
*/
taxclearance?: {
/**
* example:
* N
*/
value?: "Y" | "N";
};
/**
* Type of 'Notice of Assessment' (NOA)
*/
category?: {
/**
* example:
* ORIGINAL
*/
value?: "ADDITIONAL" | "AMENDED" | "ORIGINAL" | "REPAYMENT";
};
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* History of Notice Of Assessment (Basic)
* Summary of latest 2 Notice of Assessments within the past three years.
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
"noahistory-basic"?: {
noas?: NOABasic[];
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* History of Notice Of Assessment
* Detailed breakdown of latest 2 Notice of Assessments within the past three years.
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
noahistory?: {
noas?: NOA[];
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* CPFContributions
* Employer CPF Contributions of Person in SGD. Does not include any non-employer contributions.
* Maximum past 15 months' of contributions.
*
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
cpfcontributions?: {
/**
* example:
* [
* {
* "date": {
* "value": "2016-12-01"
* },
* "amount": {
* "value": 500
* },
* "month": {
* "value": "2016-11"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "date": {
* "value": "2016-12-12"
* },
* "amount": {
* "value": 500
* },
* "month": {
* "value": "2016-12"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "date": {
* "value": "2016-12-21"
* },
* "amount": {
* "value": 500
* },
* "month": {
* "value": "2016-12"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "date": {
* "value": "2017-01-01"
* },
* "amount": {
* "value": 500
* },
* "month": {
* "value": "2016-12"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "date": {
* "value": "2017-01-12"
* },
* "amount": {
* "value": 500
* },
* "month": {
* "value": "2017-01"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "date": {
* "value": "2017-01-21"
* },
* "amount": {
* "value": 500
* },
* "month": {
* "value": "2017-01"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "date": {
* "value": "2017-02-01"
* },
* "amount": {
* "value": 500
* },
* "month": {
* "value": "2017-01"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "date": {
* "value": "2017-02-12"
* },
* "amount": {
* "value": 500
* },
* "month": {
* "value": "2017-02"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "date": {
* "value": "2017-02-21"
* },
* "amount": {
* "value": 500
* },
* "month": {
* "value": "2017-02"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "date": {
* "value": "2017-03-01"
* },
* "amount": {
* "value": 500
* },
* "month": {
* "value": "2017-02"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "date": {
* "value": "2017-03-12"
* },
* "amount": {
* "value": 500
* },
* "month": {
* "value": "2017-03"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "date": {
* "value": "2017-03-21"
* },
* "amount": {
* "value": 500
* },
* "month": {
* "value": "2017-03"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "date": {
* "value": "2017-04-01"
* },
* "amount": {
* "value": 500
* },
* "month": {
* "value": "2017-03"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "date": {
* "value": "2017-04-12"
* },
* "amount": {
* "value": 500
* },
* "month": {
* "value": "2017-04"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "date": {
* "value": "2017-04-21"
* },
* "amount": {
* "value": 500
* },
* "month": {
* "value": "2017-04"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "date": {
* "value": "2017-05-01"
* },
* "amount": {
* "value": 500
* },
* "month": {
* "value": "2017-04"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "date": {
* "value": "2017-05-12"
* },
* "amount": {
* "value": 500
* },
* "month": {
* "value": "2017-05"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "date": {
* "value": "2017-05-21"
* },
* "amount": {
* "value": 500
* },
* "month": {
* "value": "2017-05"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "date": {
* "value": "2017-06-01"
* },
* "amount": {
* "value": 500
* },
* "month": {
* "value": "2017-05"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "date": {
* "value": "2017-06-12"
* },
* "amount": {
* "value": 500
* },
* "month": {
* "value": "2017-06"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "date": {
* "value": "2017-06-21"
* },
* "amount": {
* "value": 500
* },
* "month": {
* "value": "2017-06"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "date": {
* "value": "2017-07-01"
* },
* "amount": {
* "value": 500
* },
* "month": {
* "value": "2017-06"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "date": {
* "value": "2017-07-12"
* },
* "amount": {
* "value": 500
* },
* "month": {
* "value": "2017-07"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "date": {
* "value": "2017-07-21"
* },
* "amount": {
* "value": 500
* },
* "month": {
* "value": "2017-07"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "date": {
* "value": "2017-08-01"
* },
* "amount": {
* "value": 500
* },
* "month": {
* "value": "2017-07"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "date": {
* "value": "2017-08-12"
* },
* "amount": {
* "value": 750
* },
* "month": {
* "value": "2017-08"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "date": {
* "value": "2017-08-21"
* },
* "amount": {
* "value": 750
* },
* "month": {
* "value": "2017-08"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "date": {
* "value": "2017-09-01"
* },
* "amount": {
* "value": 750
* },
* "month": {
* "value": "2017-08"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "date": {
* "value": "2017-09-12"
* },
* "amount": {
* "value": 750
* },
* "month": {
* "value": "2017-09"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "date": {
* "value": "2017-09-21"
* },
* "amount": {
* "value": 750
* },
* "month": {
* "value": "2017-09"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "date": {
* "value": "2017-10-01"
* },
* "amount": {
* "value": 750
* },
* "month": {
* "value": "2017-09"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "date": {
* "value": "2017-10-12"
* },
* "amount": {
* "value": 750
* },
* "month": {
* "value": "2017-10"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "date": {
* "value": "2017-10-21"
* },
* "amount": {
* "value": 750
* },
* "month": {
* "value": "2017-10"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "date": {
* "value": "2017-11-01"
* },
* "amount": {
* "value": 750
* },
* "month": {
* "value": "2017-10"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "date": {
* "value": "2017-11-12"
* },
* "amount": {
* "value": 750
* },
* "month": {
* "value": "2017-11"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "date": {
* "value": "2017-11-21"
* },
* "amount": {
* "value": 750
* },
* "month": {
* "value": "2017-11"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "date": {
* "value": "2017-12-01"
* },
* "amount": {
* "value": 750
* },
* "month": {
* "value": "2017-11"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "date": {
* "value": "2017-12-12"
* },
* "amount": {
* "value": 750
* },
* "month": {
* "value": "2017-12"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "date": {
* "value": "2017-12-21"
* },
* "amount": {
* "value": 750
* },
* "month": {
* "value": "2017-12"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "date": {
* "value": "2018-01-01"
* },
* "amount": {
* "value": 750
* },
* "month": {
* "value": "2017-12"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "date": {
* "value": "2018-01-12"
* },
* "amount": {
* "value": 750
* },
* "month": {
* "value": "2018-01"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "date": {
* "value": "2018-01-21"
* },
* "amount": {
* "value": 750
* },
* "month": {
* "value": "2018-01"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* }
* ]
*/
history?: {
/**
* Employer who paid the Contribution.
*/
employer?: {
/**
* example:
* Crystal Horse Invest Pte Ltd
*/
value?: string;
};
/**
* Date of Contribution Paid. See "full-date" in http://xml2rfc.ietf.org/public/rfc/htm
*/
date?: {
/**
* example:
* 2017-03-01
*/
value?: string;
};
/**
* Month for which CPF Contribution was paid. Format: YYYY-MM
*/
month?: {
/**
* example:
* 2017-02
*/
value?: string;
};
/**
* Amount of contribution in SGD
*/
amount?: {
/**
* example:
* 500
*/
value?: number;
};
}[];
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* CPFEmployers
* Employers who paid CPF Contributions. Maximum up to past 14 months.
*
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
cpfemployers?: {
/**
* example:
* [
* {
* "month": {
* "value": "2016-11"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "month": {
* "value": "2016-12"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "month": {
* "value": "2016-12"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "month": {
* "value": "2016-12"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "month": {
* "value": "2017-01"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "month": {
* "value": "2017-01"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "month": {
* "value": "2017-01"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "month": {
* "value": "2017-02"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "month": {
* "value": "2017-02"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "month": {
* "value": "2017-02"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "month": {
* "value": "2017-03"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "month": {
* "value": "2017-03"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "month": {
* "value": "2017-03"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "month": {
* "value": "2017-04"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "month": {
* "value": "2017-04"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "month": {
* "value": "2017-04"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "month": {
* "value": "2017-05"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "month": {
* "value": "2017-05"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "month": {
* "value": "2017-05"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "month": {
* "value": "2017-06"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "month": {
* "value": "2017-06"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "month": {
* "value": "2017-06"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "month": {
* "value": "2017-07"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "month": {
* "value": "2017-07"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "month": {
* "value": "2017-07"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "month": {
* "value": "2017-08"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "month": {
* "value": "2017-08"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "month": {
* "value": "2017-08"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "month": {
* "value": "2017-09"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "month": {
* "value": "2017-09"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "month": {
* "value": "2017-09"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "month": {
* "value": "2017-10"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "month": {
* "value": "2017-10"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "month": {
* "value": "2017-10"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "month": {
* "value": "2017-11"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "month": {
* "value": "2017-11"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "month": {
* "value": "2017-11"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "month": {
* "value": "2017-12"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "month": {
* "value": "2017-12"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "month": {
* "value": "2017-12"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "month": {
* "value": "2018-01"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "month": {
* "value": "2018-01"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* }
* ]
*/
history?: {
/**
* Employer who paid the Contribution.
*/
employer?: {
/**
* example:
* Crystal Horse Invest Pte Ltd
*/
value?: string;
};
/**
* Month for which CPF Contribution was paid. Format: YYYY-MM
*/
month?: {
/**
* example:
* 2017-03
*/
value?: string;
};
}[];
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* CPFBalances
* CPF Balances of Person in SGD.
*
* 'ra' will not appear in the results if user does not have a Retirement Account.
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
cpfbalances?: {
/**
* Amount Balance in CPF-MA
*/
ma?: {
/**
* example:
* 11470.71
*/
value?: number;
};
/**
* Amount Balance in CPF-OA
*/
oa?: {
/**
* example:
* 1581.48
*/
value?: number;
};
/**
* Amount Balance in CPF-SA
*/
sa?: {
/**
* example:
* 21967.09
*/
value?: number;
};
/**
* Amount Balance in CPF-RA
*/
ra?: {
/**
* example:
* 0.01
*/
value?: number;
};
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* CPFHousingWithdrawal
* CPF Housing Withdrawal of Person. Amounts in SGD.
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
cpfhousingwithdrawal?: {
/**
* Withdrawal details for properties
*/
withdrawaldetails?: {
/**
* Registered Address of Property which withdrawal is made.
*
* **Note:**
* - address can be either Singapore address (type: 'SG') or non Singapore address (type: 'UNFORMATTED')
* - check the `type` discriminator property to differentiate between the two address formats
*
*/
address?: AddressSG | /* Address details (Non-Singapore Format) */ AddressUnformatted;
/**
*
*/
accruedinterestamt?: {
/**
* example:
* 1581.48
*/
value?: number;
};
/**
*
*/
monthlyinstalmentamt?: {
/**
* example:
* 1196.09
*/
value?: number;
};
/**
*
*/
principalwithdrawalamt?: {
/**
* example:
* 2897.01
*/
value?: number;
};
/**
*
*/
totalamountofcpfallowedforproperty?: {
/**
* example:
* 10000.01
*/
value?: number;
};
}[];
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* CPF Home Protection Scheme
* CPF Home Protection Scheme
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
cpfhomeprotectionscheme?: {
coverage?: {
/**
* Indicator
* example:
* true
*/
value?: boolean;
};
premium?: {
/**
* Coverage premium. OPTIONAL attribute, present only if 'coverage' is true
* example:
* 100.01
*/
value?: number;
};
shareofcover?: {
/**
* Share of coverage (in percentage). OPTIONAL attribute, present only if 'coverage' is true
* example:
* 20
*/
value?: number;
};
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* CPF Dependant Protection Scheme
* CPF Dependant Protection Scheme
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
cpfdependantprotectionscheme?: {
coverage?: {
/**
* Indicator
* example:
* true
*/
value?: boolean;
};
insurercode?: {
/**
* Insurer Code
* example:
* 9GEL
*/
value?: string;
};
sumassuredamount?: {
/**
* Sum assured. OPTIONAL attribute, present only if 'coverage' is true
* example:
* 70000
*/
value?: number;
};
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* CPFInvestmentScheme
* CPF Investment Scheme.
*/
cpfinvestmentscheme?: {
/**
* Quantity of Special Discounted Shares shares held
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
sdsnetshareholdingqty?: {
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
/**
* example:
* 1360
*/
value?: number;
};
/**
* CPF Investment Account Details
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
account?: {
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
/**
* Agent Bank Code
*/
agentbankcode?: {
/**
* example:
* OCBC
*/
value?: string;
};
/**
* Account Number
*/
invbankacctno?: {
/**
* example:
* 098-26644-4
*/
value?: string;
};
};
/**
* Status of Self-Awareness Questionnaire Participation.
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
saqparticipationstatus?: {
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
/**
* Possible values:
*
* 'Y' – Participated
* 'X' – Existing CPFIS participant
* 'N' – Did not participate
* example:
* X
*/
code?: "Y" | "X" | "N";
/**
* example:
* Participated
*/
desc?: string;
};
};
}
/**
* Person instance's details (Basic Profile)
*/
interface PersonBasic {
/**
* Partial UINFIN
* Masked Singapore issued identification number of the Person. Only the last 3 digit and ending alphabet will be in clear.
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
partialuinfin?: {
/**
* Value of the field, should be displayed as it is.
* example:
* *****111D
*/
value?: string;
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* UINFIN
* Singapore issued identification number of the Person.
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
uinfin?: {
/**
* value of the field, should be displayed as it is.
* example:
* S1111111D
*/
value?: string;
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* Name
* Full Name of the Person.
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
name?: {
/**
* value of the field, should be displayed as it is.
* example:
* TAN XIAO HUI
*/
value?: string;
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* HanYuPinYin
* Han Yu Pin Yin name of the Person.
*
* Presentation Logic - If there is a value to `hanyupinyinname` (i.e. not empty), then `hanyupinyinname` should be displayed in a new line below `name`, and formatted with round brackets i.e. "(`hanyupinyinname`)"'*
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
hanyupinyinname?: {
/**
* example:
* CHEN XIAO HUI
*/
value?: string;
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* Alias
* Alias name of the Person.
*
* Presentation Logic - If there is a value to `aliasname` (i.e. not empty), then `aliasname` should be displayed in a new line below `hanyupinyinname`, and prefixed with the ''@'' symbol i.e. "@`aliasname`".'*
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
aliasname?: {
/**
* value of the field.
* example:
* TRICIA TAN XIAO HUI
*/
value?: string;
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* HanYuPinYinAlias
* Han Yu Pin Yin Alias name of the Person.
*
* Presentation Logic - If there is a value to `hanyupinyinaliasname` (i.e. not empty), then `hanyupinyinaliasname` should be displayed in a new line below `aliasname`, and prefixed with the ''@'' symbol i.e. "@`hanyupinyinaliasname`".*
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
hanyupinyinaliasname?: {
/**
* example:
* TRICIA CHEN XIAO HUI
*/
value?: string;
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* MarriedName
* Married name of the Person.
*
* Presentation Logic - If there is a value to `marriedname` (i.e. not empty), then `marriedname` should be displayed in a new line below `hanyupinyinaliasname`.*
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
marriedname?: {
/**
* value of the field, should be displayed as it is.
* example:
*
*/
value?: string;
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* Sex
* Sex of Person.
* 'F' - FEMALE
* 'M' - MALE
* 'U' - UNKNOWN
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
sex?: {
/**
* example:
* F
*/
code?: "F" | "M" | "U";
/**
*
* example:
* FEMALE
*/
desc?: "FEMALE" | "MALE" | "UNKNOWN";
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* Race
* Race of Person.
*
* Refer to the [Code reference tables](#section/Support) in the Support section for list of possible values.
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
race?: {
/**
* example:
* CN
*/
code?: string;
/**
* example:
* CHINESE
*/
desc?: string;
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* SecondaryRace
* Secondary Race of Person.
*
* Refer to the [Code reference tables](#section/Support) in the Support section for list of possible values.
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
secondaryrace?: {
/**
*
* example:
* EU
*/
code?: string;
/**
*
* example:
* EURASIAN
*/
desc?: string;
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* Dialect
* Dialect of Person.
*
* Refer to the [Code reference tables](#section/Support) in the Support section for list of possible values.
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
dialect?: {
/**
*
* example:
* SG
*/
code?: string;
/**
*
* example:
* SWISS GERMAN
*/
desc?: string;
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* Nationality
* Nationality/Citizenship of Person.
*
* Refer to the [Code reference tables](#section/Support) in the Support section for list of possible values.
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
nationality?: {
/**
*
* example:
* SG
*/
code?: string;
/**
*
* example:
* SINGAPORE CITIZEN
*/
desc?: string;
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* DOB
* Date of Birth of Person.
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
dob?: {
/**
* Value of data field.
* Format can be one of the below (with reference to http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14):
* - full-date
* - date-fullyear "-" date-month
* - date-fullyear
* example:
* 1958-05-17
*/
value?: string;
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* BirthCountry
* Country/Place of Birth of Person.
*
* Refer to the [Code reference tables](#section/Support) in the Support section for list of possible values.
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
birthcountry?: {
/**
*
* example:
* SG
*/
code?: string;
/**
*
* example:
* SINGAPORE
*/
desc?: string;
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* ResidentialStatus
* Residential Status of Person. Applicable to Singapore Citizens and Permanent Residents.
*
*
* **Note:** This data item is not applicable for FIN holders i.e. `source` will be '3'.
* In such cases, the `code` and `desc` properties will be blank or empty string ("").
*
* A - ALIEN
* C - CITIZEN
* P - PR
* U - UNKNOWN
* N - NOT APPLICABLE
* < BLANK > (for FIN holders only)
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
residentialstatus?: {
/**
* example:
* C
*/
code?: "A" | "C" | "P" | "U" | "N" | "";
/**
* example:
* CITIZEN
*/
desc?: "ALIEN" | "CITIZEN" | "PR" | "UNKNOWN" | "NOT APPLICABLE" | "";
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* PassportNumber
* Passport Number of Person.
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
passportnumber?: {
/**
* Value of data field.
* example:
* E35463874W
*/
value?: string;
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* PassportExpiryDate
* Passport Expiry Date of Person.
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
passportexpirydate?: {
/**
* Value of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14
* example:
* 2020-01-01
*/
value?: string;
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* RegAdd
* Registered Address of Person (including FIN holders)
*
* **Note:**
* - address can be either a Singapore address (type: 'SG') or non Singapore address (type: 'UNFORMATTED')
* - check the `type` discriminator property to differentiate between the two address formats
* - may be unavailable for some FIN holders
*/
regadd?:
/**
* Address details (Singapore Format)
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
DataitemAddressSg
/**
* Address details (Non-Singapore Format)
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
| DataitemAddressUnformatted;
/**
* MailAdd
* Mailing Address of Person
*
* **Note:**
* - address can be either a Singapore address (type: 'SG') or non Singapore address (type: 'UNFORMATTED')
* - check the `type` discriminator property to differentiate between the two address formats
*
*/
mailadd?:
/**
* Address details (Singapore Format)
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
DataitemAddressSg
/**
* Address details (Non-Singapore Format)
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
| DataitemAddressUnformatted;
/**
* BillAdd
* Billing Address of Person
*
* **Note:**
* - address can be either a Singapore address (type: 'SG') or non Singapore address (type: 'UNFORMATTED')
* - check the `type` discriminator property to differentiate between the two address formats
*
*/
billadd?:
/**
* Address details (Singapore Format)
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
DataitemAddressSg
/**
* Address details (Non-Singapore Format)
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
| DataitemAddressUnformatted;
/**
* HousingType
* Housing Type of Person (non-HDB only).
*
* **Note 1:** If `hdbtype` is available, this value will be null.
*
* **Note 2:** If `housingtype` & `hdbtype` are unavailable, make this field user editable.
*
* Refer to `hdbtype` for detailed HDB type.
*
* '121' - DETACHED HOUSE
* '122' - SEMI-DETACHED HOUSE
* '123' - TERRACE HOUSE
* '131' - CONDOMINIUM
* '132' - EXECUTIVE CONDOMINIUM
* '139' - APARTMENT
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
housingtype?: {
/**
*
* example:
* 123
*/
code?: "121" | "122" | "123" | "131" | "132" | "139";
/**
*
* example:
* TERRACE HOUSE
*/
desc?: "DETACHED HOUSE" | "SEMI-DETACHED HOUSE" | "TERRACE HOUSE" | "CONDOMINIUM" | "EXECUTIVE CONDOMINIUM" | "APARTMENT";
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* HDBType
* Flat Type of the HDB flat.
*
* **Note 1:** that this excludes Rental Flats, Pre-War SIT flat, PSA flat, HUDC flat, Executive Condominium and Shophouse.
*
* **Note 2:** If `housingtype` is available, this value will be null.
*
* **Note 3:** If `housingtype` & `hdbtype` are unavailable, make this field user editable.
*
* '111' - 1-ROOM FLAT (HDB)
* '112' - 2-ROOM FLAT (HDB)
* '113' - 3-ROOM FLAT (HDB)
* '114' - 4-ROOM FLAT (HDB)
* '115' - 5-ROOM FLAT (HDB)
* '116' - EXECUTIVE FLAT (HDB)
* '118' - STUDIO APARTMENT (HDB)
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
hdbtype?: {
/**
*
* example:
* 112
*/
code?: "111" | "112" | "113" | "114" | "115" | "116" | "118";
/**
*
* example:
* 2-ROOM FLAT (HDB)
*/
desc?: "1-ROOM FLAT (HDB)" | "2-ROOM FLAT (HDB)" | "3-ROOM FLAT (HDB)" | "4-ROOM FLAT (HDB)" | "5-ROOM FLAT (HDB)" | "EXECUTIVE FLAT (HDB)" | "STUDIO APARTMENT (HDB)";
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* HDBOwnership
* HDB Ownership details
*
*/
hdbownership?: {
/**
* Number of Owners. Note that this does not include executors, administrators or trustees.
*/
noofowners?: {
/**
* example:
* 2
*/
value?: number;
};
/**
* Address details (Singapore Format)
*/
address?: {
/**
* Type of Address (SG or UNFORMATTED for non SG)
*/
type?: "SG" | "UNFORMATTED";
/**
* Block/House of Address
*/
block?: {
/**
* example:
* 548
*/
value?: string;
};
/**
* Building of Address
*/
building?: {
/**
* example:
*
*/
value?: string;
};
/**
* Floor of Address
*/
floor?: {
/**
* example:
* 09
*/
value?: string;
};
/**
* Unit of Address
*/
unit?: {
/**
* example:
* 128
*/
value?: string;
};
/**
* Street of Address
*/
street?: {
/**
* example:
* BEDOK NORTH AVENUE 1
*/
value?: string;
};
/**
* Postal Code of Address
*/
postal?: {
/**
* example:
* 460548
*/
value?: string;
};
/**
* Country/Place of Address. For AddressSG this will always be "SG".
*/
country?: {
code?: string;
desc?: string;
};
};
/**
* HDBType
* Flat Type of the HDB flat.
*
* **Note 1:** that this excludes Rental Flats, Pre-War SIT flat, PSA flat, HUDC flat, Executive Condominium and Shophouse.
*
* **Note 2:** If `housingtype` is available, this value will be null.
*
* **Note 3:** If `housingtype` & `hdbtype` are unavailable, make this field user editable.
*
* '111' - 1-ROOM FLAT (HDB)
* '112' - 2-ROOM FLAT (HDB)
* '113' - 3-ROOM FLAT (HDB)
* '114' - 4-ROOM FLAT (HDB)
* '115' - 5-ROOM FLAT (HDB)
* '116' - EXECUTIVE FLAT (HDB)
* '118' - STUDIO APARTMENT (HDB)
*/
hdbtype?: {
/**
*
* example:
* 112
*/
code?: "111" | "112" | "113" | "114" | "115" | "116" | "118";
/**
*
* example:
* 2-ROOM FLAT (HDB)
*/
desc?: "1-ROOM FLAT (HDB)" | "2-ROOM FLAT (HDB)" | "3-ROOM FLAT (HDB)" | "4-ROOM FLAT (HDB)" | "5-ROOM FLAT (HDB)" | "EXECUTIVE FLAT (HDB)" | "STUDIO APARTMENT (HDB)";
};
/**
* Date from which the lease period starts. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14
*/
leasecommencementdate?: {
/**
* example:
* 2008-06-13
*/
value?: string;
};
/**
* Term of lease (in years) for the property computed from the lease commencement date.
*/
termoflease?: {
/**
* example:
* 99
*/
value?: number;
};
/**
* Effective date of flat purchase. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14
*/
dateofpurchase?: {
/**
* example:
* 2008-06-13
*/
value?: string;
};
/**
* Effective date of partial transfer without monetary consideration (e.g. addition, deletion or substitution of a co-owner) for an HDB sold flat.
*
* For partial transfer of flat where at least one of the current owner remains in the household, the Date of Purchase remains unchanged while the date of transfer of ownership will be updated.
*
* For outright transfer where there is a total change of all owner(s), only the Date of Purchase will be updated.
*
* See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14'
*/
dateofownershiptransfer?: {
/**
* example:
* 2018-06-13
*/
value?: string;
};
/**
* The amount of housing loan granted to owner(s) by HDB in SGD.
*/
loangranted?: {
/**
* example:
* 310000.01
*/
value?: number;
};
/**
* The number of years of loan repaymnet opted by owner(s) at the time the loan is first granted to him/her.
*/
originalloanrepayment?: {
/**
* example:
* 25
*/
value?: number;
};
/**
* The remaining term of repayment for the loan in the format `years` + `months`.
*/
balanceloanrepayment?: {
years?: {
/**
* example:
* 2
*/
value?: number;
};
months?: {
/**
* example:
* 6
*/
value?: number;
};
};
/**
* The amount of outstanding HDB loan owed by owner(s) in SGD.
*/
outstandingloanbalance?: {
/**
* example:
* 50000.01
*/
value?: number;
};
/**
* The amount of monthly instalment the owner(s) have to pay for his/her loan in SGD.
*/
monthlyloaninstalment?: {
/**
* example:
* 1000.01
*/
value?: number;
};
/**
* The amount of outstanding instalment the owner(s) have to pay for his/her loan in SGD.
*/
outstandinginstalment?: {
/**
* example:
* 1000.01
*/
value?: number;
};
/**
* The purchase price of the HDB flat in SGD.
*/
purchaseprice?: {
/**
* example:
* 1000.01
*/
value?: number;
};
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
}[];
/**
* OwnerPrivate
* Ownership of Private Property Status of Person (based on IRAS information).
*
* true
* false
* null (data not available)
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
ownerprivate?: {
/**
* Value of data field.
* example:
* false
*/
value?: boolean;
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* Email
* Email Address of Person.
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
email?: {
/**
* Value of data field.
* example:
* test@gmail.com
*/
value?: string;
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* HomeNo
* Home Contact Number of Person.
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
homeno?: {
/**
* Prefix of Phone Number. Defaults to '+'. If phone number is blank, prefix will be returned as blank.
*/
prefix?: {
/**
* example:
* +
*/
value?: string;
};
/**
* Area Code of Phone Number. Default to '65'. If phone number is blank, code will be returned as blank.
*/
areacode?: {
/**
* example:
* 65
*/
value?: string;
};
/**
* Phone Number.
*/
nbr?: {
/**
* example:
* 66132665
*/
value?: string;
};
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* MobileNo
* Mobile Number of Person.
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
mobileno?: {
/**
* Prefix of Phone Number. Defaults to '+'. If phone number is blank, prefix will be returned as blank.
*/
prefix?: {
/**
* example:
* +
*/
value?: string;
};
/**
* Area Code of Phone Number. Default to '65'. If phone number is blank, code will be returned as blank.
*/
areacode?: {
/**
* example:
* 65
*/
value?: string;
};
/**
* Phone Number.
*/
nbr?: {
/**
* example:
* 66132665
*/
value?: string;
};
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* Marital
* Marital Status of Person.
*
* '1' - SINGLE
* '2' - MARRIED
* '3' - WIDOWED
* '5' - DIVORCED
*
* **Note:** This field must be made **editable** on your digital service form even though `source` is '1' (Government Verified).
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
marital?: {
/**
*
* example:
* 2
*/
code?: "1" | "2" | "3" | "5";
/**
*
* example:
* MARRIED
*/
desc?: "SINGLE" | "MARRIED" | "WIDOWED" | "DIVORCED";
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* MarriageCertNo
* Certificate number of the latest marriage.
*
*
* **Note:** This field must be made **editable** on your digital service form even though `source` is '1' (Government Verified).
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
marriagecertno?: {
/**
* Value of data field.
* example:
* 123456789012345
*/
value?: string;
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* CountryOfMarriage
* Country/Place of the latest marriage.
*
*
* **Note:** This field must be made **editable** on your digital service form even though `source` is '1' (Government Verified).
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
countryofmarriage?: {
/**
*
* example:
* SG
*/
code?: string;
/**
*
* example:
* SINGAPORE
*/
desc?: string;
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* MarriageDate
* Latest Marriage Date of Person.
*
*
* **Note:** This field must be made **editable** on your digital service form even though `source` is '1' (Government Verified).
*
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
marriagedate?: {
/**
* Value of data field.
*
* See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14
* example:
* 2007-01-01
*/
value?: string;
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* DivorceDate
* Last Divorce Date of Person.
*
*
* **Note:** This field must be made **editable** on your digital service form even though `source` is '1' (Government Verified).
*
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
divorcedate?: {
/**
* Value of data field.
*
* See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14
* example:
*
*/
value?: string;
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* ChildrenBirthRecords
* This refers to only local registered birth records(based on ICA’s electronic Birth Certificate Records from 1985 onwards).
*
* This includes adoption of locally registered child.
*
* For child below 21, the child’s Birth Cert No, Name, Sex, Race, Dialect, Date of Birth and Time of Birth will be shown.
*
* For child above 21, only the child’s Birth Cert Number will be shown.
*/
childrenbirthrecords?: {
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
/**
* Birth certificate number of child.
*/
birthcertno?: {
/**
* example:
* S5562882C
*/
value?: string;
};
/**
* Full Name of child
*/
name?: {
/**
* example:
* Jo Tan Pei Ni
*/
value?: string;
};
/**
* Han Yu Pin Yin name of child.
*
* Presentation Logic - If there is a value to `hanyupinyinname` (i.e. not empty), then `hanyupinyinname` should be displayed in a new line below `name`, and formatted with round brackets i.e. \"(`hanyupinyinname`)\".*
*/
hanyupinyinname?: {
/**
* example:
* Cheng Pei Ni
*/
value?: string;
};
/**
* Alias name of child.
*
* Presentation Logic - If there is a value to `aliasname` (i.e. not empty), then `aliasname` should be displayed in a new line below `hanyupinyinname`, and prefixed with the ''@'' symbol i.e. \"@`aliasname`\".*
*/
aliasname?: {
/**
* example:
*
*/
value?: string;
};
/**
* Han Yu Pin Yin Alias name of child.
*
* Presentation Logic - If there is a value to `hanyupinyinaliasname` (i.e. not empty), then `hanyupinyinaliasname` should be displayed in a new line below `aliasname`, and prefixed with the ''@'' symbol i.e. \"@`hanyupinyinaliasname`\".*
*/
hanyupinyinaliasname?: {
/**
* example:
*
*/
value?: string;
};
/**
* Married name of child.
*
* Presentation Logic - If there is a value to `marriedname` (i.e. not empty), then `marriedname` should be displayed in a new line below `hanyupinyinaliasname`.*
*/
marriedname?: {
/**
* example:
*
*/
value?: string;
};
/**
* Sex of child. Possible values:
*
* 'F' - FEMALE
* 'M' - MALE
* 'U' - UNKNOWN
*/
sex?: {
/**
* example:
* F
*/
code?: "F" | "M" | "U";
/**
* example:
* FEMALE
*/
desc?: "FEMALE" | "MALE" | "UNKNOWN";
};
/**
* Race of child.
*
* Refer to the [Code reference tables](#section/Support) in the Support section for list of possible values.
*
*/
race?: {
/**
* example:
* CN
*/
code?: string;
/**
* example:
* CHINESE
*/
desc?: string;
};
/**
* Secondary Race of child.
*
* Refer to the [Code reference tables](#section/Support) in the Support section for list of possible values.
*/
secondaryrace?: {
/**
* example:
*
*/
code?: string;
/**
* example:
*
*/
desc?: string;
};
/**
* Dialect of child.
*
* Refer to the [Code reference tables](#section/Support) in the Support section for list of possible values.
*/
dialect?: {
/**
* example:
* HK
*/
code?: string;
/**
* example:
* HOKKIEN
*/
desc?: string;
};
/**
* Life Status of child. Possible values:
*
* A - ALIVE
* D - DECEASED
*/
lifestatus?: {
/**
* example:
* D
*/
code?: "A" | "D";
/**
* example:
* DECEASED
*/
desc?: "ALIVE" | "DECEASED";
};
/**
* Date of Birth of child.
*
* See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14
*/
dob?: {
/**
* example:
* 2011-09-10
*/
value?: string;
};
/**
* Time of Birth of child.
*
* Format: HHMM
*/
tob?: {
/**
* example:
* 0901
*/
value?: string;
};
vaccinationrequirements?: {
/**
* Vaccination Requirement.
*
* Refer to the [Code reference tables](#section/Support) in the Support section for list of possible values.
*/
requirement?: {
/**
* example:
* 1M3D
*/
code?: string;
/**
* example:
* MINIMUM VACCINATION REQUIREMENT FOR PRESCHOOL
*/
desc?: string;
};
fulfilled?: {
/**
* example:
* true
*/
value?: boolean;
};
}[];
/**
* Indicates whether the child is a Singapore Citizen at the time of birth.
*
* Y - Yes
* N - No
* < BLANK > - Not applicable
*/
sgcitizenatbirthind?: {
/**
* example:
* Y
*/
value?: "Y" | "N" | "";
};
}[];
/**
* SponsoredChildrenRecords
* Details of children sponsored to be SC/PR/LTVP
*
* For child below 21, the child's NRIC/FIN, Name, Sex, Race, Secondary Race, Dialect, Date of Birth, Country/Place of Birth, Residential Status and SC/PR/LTVP grant date will be shown.
*
* For child above 21, only the child's last known NRIC/FIN will be shown.
*/
sponsoredchildrenrecords?: {
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
/**
* NRIC/FIN of child
*/
nric?: {
/**
* example:
* S5562882C
*/
value?: string;
};
/**
* Full Name of child
*/
name?: {
/**
* example:
* Jo Tan Pei Ni
*/
value?: string;
};
/**
* Han Yu Pin Yin name of child.
*/
hanyupinyinname?: {
/**
* example:
* Cheng Pei Ni
*/
value?: string;
};
/**
* Alias name of child.
*/
aliasname?: {
/**
* example:
*
*/
value?: string;
};
/**
* Han Yu Pin Yin Alias name of child.
*/
hanyupinyinaliasname?: {
/**
* example:
*
*/
value?: string;
};
/**
* Married name of child.
*/
marriedname?: {
/**
* example:
*
*/
value?: string;
};
/**
* Sex of child. Possible values:
*
* 'F' - FEMALE
* 'M' - MALE
* 'U' - UNKNOWN
*/
sex?: {
/**
* example:
* F
*/
code?: "F" | "M" | "U";
/**
* example:
* FEMALE
*/
desc?: "FEMALE" | "MALE" | "UNKNOWN";
};
/**
* Race of child.
*
* Refer to the [Code reference tables](#section/Support) in the Support section for list of possible values.
*/
race?: {
/**
* example:
* CN
*/
code?: string;
/**
* example:
* CHINESE
*/
desc?: string;
};
/**
* Secondary Race of child.
*
* Refer to the [Code reference tables](#section/Support) in the Support section for list of possible values.
*/
secondaryrace?: {
/**
* example:
*
*/
code?: string;
/**
* example:
*
*/
desc?: string;
};
/**
* Dialect of child.
*
* Refer to the [Code reference tables](#section/Support) in the Support section for list of possible values.
*/
dialect?: {
/**
* example:
* HK
*/
code?: string;
/**
* example:
* HOKKIEN
*/
desc?: string;
};
/**
* Date of Birth of child.
*
* See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14
*/
dob?: {
/**
* example:
* 2011-09-10
*/
value?: string;
};
/**
* BirthCountry
* Country/Place of Birth of child.
*
* Refer to the [Code reference tables](#section/Support) in the Support section for list of possible values.
*/
birthcountry?: {
/**
* example:
* SG
*/
code?: string;
/**
* example:
* SINGAPORE
*/
desc?: string;
};
/**
* Life Status of child. Possible values:
*
* A - ALIVE
* D - DECEASED
*/
lifestatus?: {
/**
* example:
* A
*/
code?: "A" | "D";
/**
* example:
* ALIVE
*/
desc?: "ALIVE" | "DECEASED";
};
/**
* ResidentialStatus
* Residential Status of child. Possible values:
*
* A - ALIEN
* C - CITIZEN
* P - PR
* U - UNKNOWN
* N - NOT APPLICABLE
*/
residentialstatus?: {
/**
* example:
* C
*/
code?: "A" | "C" | "P" | "U" | "N";
/**
* example:
* Citizen
*/
desc?: "ALIEN" | "CITIZEN" | "PR" | "UNKNOWN" | "NOT APPLICABLE";
};
/**
* Nationality/Citizenship of child.
*
* Refer to the [Code reference tables](#section/Support) in the Support section for list of possible values.
*/
nationality?: {
/**
* example:
* SG
*/
code?: string;
/**
* example:
* SINGAPORE CITIZEN
*/
desc?: string;
};
/**
* Date granted Singapore Citizenship, Permanent Resident or Long-term Visit Pass
*
* See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14
*/
scprgrantdate?: {
/**
* example:
* 2015-06-13
*/
value?: string;
};
vaccinationrequirements?: {
/**
* Vaccination Requirement
*
* Refer to the [Code reference tables](#section/Support) in the Support section for list of possible values.
*/
requirement?: {
/**
* example:
* 1M3D
*/
code?: string;
/**
* example:
* MINIMUM VACCINATION REQUIREMENT FOR PRESCHOOL
*/
desc?: string;
};
fulfilled?: {
/**
* example:
* true
*/
value?: boolean;
};
}[];
}[];
/**
* EduLevel
* Highest Education Level of Person.
*
* '0' - NO FORMAL QUALIFICATION / PRE-PRIMARY / LOWER PRIMARY
* '1' - PRIMARY
* '2' - LOWER SECONDARY
* '3' - SECONDARY
* '4' - POST-SECONDARY (NON-TERTIARY): GENERAL & VOCATION
* '5' - POLYTECHNIC DIPLOMA
* '6' - PROFESSIONAL QUALIFICATION AND OTHER DIPLOMA
* '7' - BACHELOR'S OR EQUIVALENT
* '8' - POSTGRADUATE DIPLOMA / CERTIFICATE (EXCLUDING MASTER'S AND DOCTORATE)
* '9' - MASTER'S AND DOCTORATE OR EQUIVALENT
* 'N' - MODULAR CERTIFICATION (NON-AWARD COURSES / NON-FULL QUALIFICATIONS)
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
edulevel?: {
/**
*
* example:
* 7
*/
code?: "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" | "N";
/**
* example:
* BACHELOR'S OR EQUIVALENT
*/
desc?: "NO FORMAL QUALIFICATION / PRE-PRIMARY / LOWER PRIMARY" | "PRIMARY" | "LOWER SECONDARY" | "SECONDARY" | "POST-SECONDARY (NON-TERTIARY): GENERAL & VOCATION" | "POLYTECHNIC DIPLOMA" | "PROFESSIONAL QUALIFICATION AND OTHER DIPLOMA" | "BACHELOR'S OR EQUIVALENT" | "POSTGRADUATE DIPLOMA / CERTIFICATE (EXCLUDING MASTER'S AND DOCTORATE)" | "MASTER'S AND DOCTORATE OR EQUIVALENT" | "MODULAR CERTIFICATION (NON-AWARD COURSES / NON-FULL QUALIFICATIONS)";
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* GradYear
* Year of Graduation of Person. Format: YYYY
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
gradyear?: {
/**
* example:
* 2006
*/
value?: string;
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* SchoolName
* Name of School of Person.
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
schoolname?: {
/**
* Code value of school name.
*
* **Note:** Code+desc and value are mutually exclusive.
* example:
* T07GS3011J
*/
code?: string;
/**
* Name of school represented by 'code'
*
* **Note:** Code+desc and value are mutually exclusive.
* example:
* SIGLAP SECONDARY SCHOOL
*/
desc?: string;
/**
* Free text value of school name.
*
* **Note:** Code+desc and value are mutually exclusive.
* example:
*
*/
value?: string;
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* Occupation
* Occupation of Person.
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
occupation?: {
/**
* Free text.
*
* For SC/PR holders, blank will be returned.
* example:
*
*/
value?: string;
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* Employment
* Name of Employer.
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
employment?: {
/**
* example:
* ALPHA
*/
value?: string;
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* PassType
* Pass type of a FIN holder.
**Note:** Only applies to a foreigner with a valid pass.
*
* Refer to the [Code reference tables](#section/Support) in the Support section for list of possible values.
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
passtype?: {
/**
* Value of data field.
* example:
* RPass
*/
code?: string;
/**
* example:
* Work Permit
*/
desc?: string;
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* PassStatus
* Pass status of a FIN holder.
**Note:** Only applies to a foreigner with a valid pass.
* Live
* Approved
*
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
passstatus?: {
/**
* Value of data field.
* example:
* Live
*/
value?: "Live" | "Approved";
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* PassExpiryDate
* Pass expiry of a foreigner.
**Note:** Only applies to a foreigner with a valid pass.
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
passexpirydate?: {
/**
* Value of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14
* example:
* 2022-12-31
*/
value?: string;
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* EmploymentSector
* Employment Sector of a FIN holder.
*
* **Note:** Only applies to a foreigner with a valid work pass.
*
* Some examples of possible values are:
* MANUFACTURING
* CONSTRUCTION
* RECLAMATION
* SERVICE
* GRI-TECHNOLOGY
* LANDSCAPING
* INCINERATOR PLANT
* MARINE SHIPYARD
* PROCESS
* HARBOURCRAFT
* DOMESTIC
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
employmentsector?: {
/**
* example:
* MANUFACTURING
*/
value?: string;
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* HouseholdIncome
* Household Income of Person in SGD.
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
householdincome?: {
/**
* upper bound of the range of household income bracket
*/
high?: {
/**
* example:
* 5999
*/
value?: number;
};
/**
* lower bound of the range of household income bracket
*/
low?: {
/**
* example:
* 5000
*/
value?: number;
};
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
vehicles?: {
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
/**
* Vehicle Registration Number displayed on the vehicle number plates
*/
vehicleno?: {
/**
* example:
* SDF1235A
*/
value?: string;
};
/**
* Type of Vehicles such as 'MOTOR CAR', 'STATION /WAGON/JEEP/LAND ROVER'
*/
type?: {
/**
* example:
* PASSENGER MOTOR CAR
*/
value?: string;
};
/**
* In-Vehicle Unit (IU) number of the device fitted in Singapore-registered vehicles for Electronic Road Pricing (ERP) gantries and Electronic Parking System (EPS) car parks.
*/
iulabelno?: {
/**
* example:
*
*/
value?: string;
};
/**
* Vehicle Make such as 'TOYOTA', 'HONDA', 'AUDI'
*/
make?: {
/**
* example:
* TOYOTA
*/
value?: string;
};
/**
* Vehicle Model such as 'COROLLA ALTIS CLASSIC 1.6 CVT', 'HRV 1.5 DX CVT'
*/
model?: {
/**
* example:
* COROLLA ALTIS
*/
value?: string;
};
/**
* Vehicle Chassis Number
*/
chassisno?: {
/**
* example:
* ZC11S1735800
*/
value?: string;
};
/**
* Vehicle Engine Number
*/
engineno?: {
/**
* example:
* M13A1837453
*/
value?: string;
};
/**
* Vehicle Motor Number
*/
motorno?: {
/**
* example:
*
*/
value?: string;
};
/**
* Manufacturing year
*/
yearofmanufacture?: {
/**
* example:
* 2010
*/
value?: string;
};
/**
* Date when vehicle is registered with LTA. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14'
*/
firstregistrationdate?: {
/**
* example:
* 2010-06-06
*/
value?: string;
};
/**
* Date when vehicle is first registered in the country of origin. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14'
*/
originalregistrationdate?: {
/**
* example:
* 2010-06-06
*/
value?: string;
};
/**
* Vehicle Certificate of Entitlement (COE) bid category
*/
coecategory?: {
/**
* example:
* A - CAR UP TO 1600CC & 97KW (130BHP)
*/
value?: string;
};
/**
* Vehicle Certificate of Entitlement (COE) expiry date. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14'
*/
coeexpirydate?: {
/**
* example:
* 2020-06-05
*/
value?: string;
};
/**
* See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14'
*/
roadtaxexpirydate?: {
/**
* example:
* 2020-06-05
*/
value?: string;
};
/**
* Actual Quota Premium (QP) amount payable for the COE upon registration, conversion or COE revalidation in Singapore dollars (SGD). For renewal of COE, the value will contain actual PQP paid.
*/
quotapremium?: {
/**
* example:
* 14000.01
*/
value?: number;
};
/**
* Open Market Value is the value of manufacturer invoice price, freight and insurance in Singapore dollars (SGD).
*/
openmarketvalue?: {
/**
* example:
* 25000.01
*/
value?: number;
};
/**
* CO2 emission rate
*/
co2emission?: {
/**
* example:
* 146.01
*/
value?: number;
};
/**
* Status of the Vehicle.
*
* 1 - LIVE
* 2 - DE-REGISTERED
*/
status?: {
/**
* example:
* 1
*/
code?: "1" | "2";
/**
* example:
* LIVE
*/
desc?: "LIVE" | "DE-REGISTERED";
};
/**
* Vehicle Primary Colour (e.g. BLACK)
*/
primarycolour?: {
/**
* example:
* BLACK
*/
value?: string;
};
/**
* Vehicle Primary Colour (e.g. WHITE)
*/
secondarycolour?: {
/**
* example:
* WHITE
*/
value?: string;
};
/**
* Vehicle Attachment 1 (e.g. DISABLED)
*/
attachment1?: {
/**
* example:
* DISABLED
*/
value?: string;
};
/**
* Vehicle Attachment 2 (e.g. WITH SUN ROOF)
*/
attachment2?: {
/**
* example:
* WITH SUN ROOF
*/
value?: string;
};
/**
* Vehicle Attachment 3 (e.g. SIDE CURTAIN)
*/
attachment3?: {
/**
* example:
* SIDE CURTAIN
*/
value?: string;
};
/**
* Vehicle Scheme (e.g. REVISED OFF-PEAK CAR)
*/
scheme?: {
/**
* example:
* REVISED OFF-PEAK CAR
*/
value?: string;
};
/**
* Total Hydro Carbon (THC) emission rate
*/
thcemission?: {
/**
* example:
* 1.011001
*/
value?: number;
};
/**
* Carbon Monoxide emission rate
*/
coemission?: {
/**
* example:
* 1.100001
*/
value?: number;
};
/**
* Nitrogen Oxide (NOx) emission rate.
*/
noxemission?: {
/**
* example:
* 0.011001
*/
value?: number;
};
/**
* Particulates (PM - Atmospheric Particulate Matter) emission rate.
*/
pmemission?: {
/**
* example:
* 0.007
*/
value?: number;
};
/**
* Engine Capacity in cubic centimeter (cc)
*/
enginecapacity?: {
/**
* example:
* 1600
*/
value?: number;
};
/**
* Power Rate. Applicable to Electric and Hybrid vehicles powered by electric motors. Unit is Kilowatt.
*/
powerrate?: {
/**
* example:
* 1.41
*/
value?: number;
};
/**
* Effective Date/Time of Ownership. See "date-time" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14'
*/
effectiveownership?: {
/**
* example:
* 2010-08-31T20:12:12+08:00
*/
value?: string;
};
/**
* Propellant (e.g. Compressed Natural Gas, Diesel, Diesel-CNG, Diesel-Electric, Diesel-Electric (Plug-In), Electric, Gas, Liquefied Petroleum Gas (LPG), Petrol, Petrol-CNG, Petrol-Electric, Petrol-Electric (Plug-In), Petrol-LPG
*/
propellant?: {
/**
* example:
* Compressed Natural Gas
*/
value?: string;
};
/**
* Maximum Unladen Weight in kilograms (kg)
*/
maximumunladenweight?: {
/**
* example:
* 1500
*/
value?: number;
};
/**
* Maximum Laden Weight in kilograms (kg)
*/
maximumladenweight?: {
/**
* example:
* 1795
*/
value?: number;
};
/**
* Minimum PARF Benefit in Singapore dollars (SGD).
*/
minimumparfbenefit?: {
/**
* example:
* 8770.01
*/
value?: number;
};
/**
* Number of Transfer
*/
nooftransfers?: {
/**
* example:
* 2
*/
value?: number;
};
/**
* Vehicle Parking Certificate. Applicable for Heavy Vehicles.
*/
vpc?: {
/**
* example:
* 1234567890
*/
value?: string;
};
}[];
/**
* Driving Licence details of Person.
*
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
drivinglicence?: {
/**
* Status of Certificate of Merit. Possible values:
*
* Y - ELIGIBLE
* N - NOT ELIGIBLE
*/
comstatus?: {
/**
* example:
* Y
*/
code?: "Y" | "N";
/**
*
* example:
* ELIGIBLE
*/
desc?: "ELIGIBLE" | "NOT ELIGIBLE";
};
/**
* Total Demerit Points
*/
totaldemeritpoints?: {
/**
* example:
* 0
*/
value?: number;
};
/**
*
*/
suspension?: {
/**
* Suspension Start Date
*/
startdate?: {
/**
* example:
*
*/
value?: string;
};
/**
* Suspension End Date
*/
enddate?: {
/**
* example:
*
*/
value?: string;
};
};
/**
*
*/
disqualification?: {
/**
* Disqualification Start Date
*/
startdate?: {
/**
* example:
*
*/
value?: string;
};
/**
* Disqualification End Date
*/
enddate?: {
/**
* example:
*
*/
value?: string;
};
};
/**
*
*/
revocation?: {
/**
* Revocation Start Date
*/
startdate?: {
/**
* example:
*
*/
value?: string;
};
/**
* Revocation End Date
*/
enddate?: {
/**
* example:
*
*/
value?: string;
};
};
/**
* Provisional Driving Licence (PDL)
*/
pdl?: {
/**
* Validity of PDL. Possible values:
*
* V - VALID
* E - EXPIRED
* I - INVALID
* N - NOT HOLDING
*/
validity?: {
/**
* example:
* V
*/
code?: "V" | "E" | "I" | "N";
/**
*
* example:
* VALID
*/
desc?: "VALID" | "EXPIRED" | "INVALID" | "NOT HOLDING";
};
/**
* PDL Expiry Date
*/
expirydate?: {
/**
* example:
* 2020-06-15
*/
value?: string;
};
/**
* PDL Classes
* example:
* [
* {
* "class": {
* "value": "2A"
* }
* },
* {
* "class": {
* "value": "3A"
* }
* }
* ]
*/
classes?: {
class?: {
value?: string;
};
}[];
};
/**
* Qualified Driving Licence (QDL)
*/
qdl?: {
/**
* Validity of QDL. Possible values:
*
* V - VALID
* E - EXPIRED
* I - INVALID
* N - NOT HOLDING
*/
validity?: {
/**
* example:
* V
*/
code?: "V" | "E" | "I" | "N";
/**
*
* example:
* VALID
*/
desc?: "VALID" | "EXPIRED" | "INVALID" | "NOT HOLDING";
};
/**
* QDL Expiry Date
*/
expirydate?: {
/**
* example:
* 2020-06-15
*/
value?: string;
};
/**
* QDL Classes. Includes Issue Date (e.g. 2B, 2018-01-01)
* example:
* [
* {
* "class": {
* "value": "2A"
* },
* "issuedate": {
* "value": "2018-06-06"
* }
* },
* {
* "class": {
* "value": "3A"
* },
* "issuedate": {
* "value": "2018-06-06"
* }
* }
* ]
*/
classes?: {
class?: {
value?: string;
};
issuedate?: {
value?: string;
};
}[];
};
/**
* Serial Number of the Photo Card
*/
photocardserialno?: {
/**
* example:
* 115616
*/
value?: string;
};
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* Academic Qualifications
* Academic Qualifications achieved
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
academicqualifications?: {
/**
* Transcript of qualification
*/
transcripts?: {
/**
* Qualification's Name
*/
name?: {
/**
* example:
* SINGAPORE-CAMBRIDGE GENERAL CERTIFICATE OF EDUCATION ORDINARY LEVEL
*/
value?: string;
};
/**
* Year this qualification was attained
*
* See "date-fullyear" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14'
*/
yearattained?: {
/**
* example:
* 2018
*/
value?: string;
};
results?: {
/**
* Subject taken
*/
subject?: {
/**
* example:
* English Language
*/
value?: string;
};
/**
* Level of subject taken
*/
level?: {
/**
* example:
* Ordinary
*/
value?: string;
};
/**
* Grade attained
*/
grade?: {
/**
* example:
* A
*/
value?: string;
};
/**
* Optional Sub Subject taken
*/
subsubject?: {
/**
* example:
* SPECIAL PAPER
*/
value?: string;
};
/**
* Optional grade attained for subSubject
*/
subgrade?: {
/**
* example:
* One
*/
value?: string;
};
}[];
/**
* Explanatory Notes
*/
explanatorynotes?: {
value?: string;
};
}[];
/**
* Electronic Certificates Uploaded
*/
certificates?: {
/**
* File name of the electronic certificate
*/
name?: {
/**
* example:
* nus.opencert
*/
value?: string;
};
/**
* File content of the electronic certificate, Base64 encoded
*/
content?: {
value?: string;
};
/**
* Open Certificate Information
*
* Note: The test environment for OpenCert is at https://dev.opencerts.io/ while production is
* at https://opencerts.io/
*/
opencertificate?: {
/**
* The OpenCert serial number.
*/
id?: {
/**
* example:
* 100000000343840
*/
value?: string;
};
/**
* Indicate whether this open certificate is primary certificate
*/
primary?: {
/**
* example:
* true
*/
value?: boolean;
};
};
/**
* Indicate whether this file is open certificate
*/
opencertificateindicator?: {
/**
* example:
* true
*/
value?: boolean;
};
}[];
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
pioneergen?: {
eligibility: {
value: boolean;
};
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
quantum: {
value: string;
};
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4" | "1" | "2" | "3" | "4" | "1" | "2" | "3" | "4";
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C" | "C" | "C";
/**
* Message code
*
* '1' - PG Eligibility Tag: N
* '2' - PG Eligibility Tag: Y, Sign-up Tag: Y, Invalid Address Tag: N
* '3' - PG Eligibility Tag: Y, Sign-up Tag: Y, Invalid Address Tag: Y
* '4' - PG Eligibility Tag: Y, Sign-up Tag: N, Invalid Address Tag: N
* '5' - PG Eligibility Tag: Y, Sign-up Tag: N, Invalid Address Tag: Y
* '6' - PG Eligibility Tag: Y, Opt-Out Tag: Y
* '7' - PG Eligibility Tag: Y, Sign-up Tag: Y, NIL Status: Y
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
message: {
code: "1" | "2" | "3" | "4" | "5" | "6" | "7" | "1" | "2" | "3" | "4" | "5" | "6" | "7";
desc: "We regret that you are not eligible for the Pioneer Generation Package. For further enquiries, please contact 1800-2222-888." | "You are eligible for the Pioneer Generation Package. For further enquiries, please contact 1800-2222-888." | "You are eligible for the Pioneer Generation Package. Please contact 1800-2222-888 to receive your Pioneer Generation card." | "You are eligible for the Pioneer Generation Package. Please contact 1800-2222-888 to start receiving your Pioneer Generation benefits, such as your MediSave top-up." | "You are eligible for the Pioneer Generation Package. Please contact 1800-2222-888 to start receiving your Pioneer Generation benefits." | "We understand that you have opted out of receiving the benefits under the Pioneer Generation Package. For further enquiries, please contact 1800-2222-888." | "Please call 1800-2222-888 to start receiving your PG benefits." | "We regret that you are not eligible for the Pioneer Generation Package. For further enquiries, please contact 1800-2222-888." | "You are eligible for the Pioneer Generation Package. For further enquiries, please contact 1800-2222-888." | "You are eligible for the Pioneer Generation Package. Please contact 1800-2222-888 to receive your Pioneer Generation card." | "You are eligible for the Pioneer Generation Package. Please contact 1800-2222-888 to start receiving your Pioneer Generation benefits, such as your MediSave top-up." | "You are eligible for the Pioneer Generation Package. Please contact 1800-2222-888 to start receiving your Pioneer Generation benefits." | "We understand that you have opted out of receiving the benefits under the Pioneer Generation Package. For further enquiries, please contact 1800-2222-888." | "Please call 1800-2222-888 to start receiving your PG benefits.";
};
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* MerdekaGen
* Merdekagen details
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
merdekagen?: {
/**
* Eligibility
*/
eligibility?: {
/**
* example:
* true
*/
value?: boolean;
};
/**
* Amount eligible for
*/
quantum?: {
/**
* example:
* 100
*/
value?: number;
};
/**
* Suggested user friendly display
*/
message?: {
/**
* example:
* 2
*/
code?: string;
/**
* example:
* You are eligible for the Merdeka Generation Package. For further enquiries, please contact 1800-2222-888.
*/
desc?: string;
};
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* SilverSupport
* Silver Support Scheme details
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
silversupport?: {
/**
* Eligibility
*/
eligibility?: {
/**
* example:
* true
*/
value?: boolean;
};
/**
* Amount eligible for
*/
amount?: {
/**
* example:
* 300
*/
value?: number;
};
/**
* Year given
*/
year?: {
/**
* Value of data field. See "date-fullyear" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14
* example:
* 2019
*/
value?: string;
};
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* GSTVoucher
* GST Voucher details
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
gstvoucher?: {
/**
* Indicator if user is excluded
*/
exclusion?: {
/**
* example:
* false
*/
value?: boolean;
};
/**
* Indicator if user needs to signup
*/
signup?: {
/**
* example:
* true
*/
value?: boolean;
};
/**
* Amount given for medisave account
*/
gstmedisave?: {
/**
* example:
* 100
*/
value?: number;
};
/**
* Amount given for ordinary account
*/
gstregular?: {
/**
* example:
* 100
*/
value?: number;
};
/**
* Amount given for special account
*/
gstspecial?: {
/**
* example:
* 100
*/
value?: number;
};
/**
* Year given
*/
year?: {
/**
* Value of data field. See "date-fullyear" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14
* example:
* 2019
*/
value?: string;
};
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
}
/**
* Person instance's details
*/
interface PersonCommon {
/**
* Partial UINFIN
* Masked Singapore issued identification number of the Person. Only the last 3 digit and ending alphabet will be in clear.
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
partialuinfin?: {
/**
* Value of the field, should be displayed as it is.
* example:
* *****111D
*/
value?: string;
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* UINFIN
* Singapore issued identification number of the Person.
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
uinfin?: {
/**
* value of the field, should be displayed as it is.
* example:
* S1111111D
*/
value?: string;
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* Name
* Full Name of the Person.
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
name?: {
/**
* value of the field, should be displayed as it is.
* example:
* TAN XIAO HUI
*/
value?: string;
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* HanYuPinYin
* Han Yu Pin Yin name of the Person.
*
* Presentation Logic - If there is a value to `hanyupinyinname` (i.e. not empty), then `hanyupinyinname` should be displayed in a new line below `name`, and formatted with round brackets i.e. "(`hanyupinyinname`)"'*
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
hanyupinyinname?: {
/**
* example:
* CHEN XIAO HUI
*/
value?: string;
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* Alias
* Alias name of the Person.
*
* Presentation Logic - If there is a value to `aliasname` (i.e. not empty), then `aliasname` should be displayed in a new line below `hanyupinyinname`, and prefixed with the ''@'' symbol i.e. "@`aliasname`".'*
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
aliasname?: {
/**
* value of the field.
* example:
* TRICIA TAN XIAO HUI
*/
value?: string;
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* HanYuPinYinAlias
* Han Yu Pin Yin Alias name of the Person.
*
* Presentation Logic - If there is a value to `hanyupinyinaliasname` (i.e. not empty), then `hanyupinyinaliasname` should be displayed in a new line below `aliasname`, and prefixed with the ''@'' symbol i.e. "@`hanyupinyinaliasname`".*
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
hanyupinyinaliasname?: {
/**
* example:
* TRICIA CHEN XIAO HUI
*/
value?: string;
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* MarriedName
* Married name of the Person.
*
* Presentation Logic - If there is a value to `marriedname` (i.e. not empty), then `marriedname` should be displayed in a new line below `hanyupinyinaliasname`.*
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
marriedname?: {
/**
* value of the field, should be displayed as it is.
* example:
*
*/
value?: string;
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* Sex
* Sex of Person.
* 'F' - FEMALE
* 'M' - MALE
* 'U' - UNKNOWN
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
sex?: {
/**
* example:
* F
*/
code?: "F" | "M" | "U";
/**
*
* example:
* FEMALE
*/
desc?: "FEMALE" | "MALE" | "UNKNOWN";
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* Race
* Race of Person.
*
* Refer to the [Code reference tables](#section/Support) in the Support section for list of possible values.
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
race?: {
/**
* example:
* CN
*/
code?: string;
/**
* example:
* CHINESE
*/
desc?: string;
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* SecondaryRace
* Secondary Race of Person.
*
* Refer to the [Code reference tables](#section/Support) in the Support section for list of possible values.
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
secondaryrace?: {
/**
*
* example:
* EU
*/
code?: string;
/**
*
* example:
* EURASIAN
*/
desc?: string;
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* Dialect
* Dialect of Person.
*
* Refer to the [Code reference tables](#section/Support) in the Support section for list of possible values.
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
dialect?: {
/**
*
* example:
* SG
*/
code?: string;
/**
*
* example:
* SWISS GERMAN
*/
desc?: string;
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* Nationality
* Nationality/Citizenship of Person.
*
* Refer to the [Code reference tables](#section/Support) in the Support section for list of possible values.
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
nationality?: {
/**
*
* example:
* SG
*/
code?: string;
/**
*
* example:
* SINGAPORE CITIZEN
*/
desc?: string;
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* DOB
* Date of Birth of Person.
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
dob?: {
/**
* Value of data field.
* Format can be one of the below (with reference to http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14):
* - full-date
* - date-fullyear "-" date-month
* - date-fullyear
* example:
* 1958-05-17
*/
value?: string;
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* BirthCountry
* Country/Place of Birth of Person.
*
* Refer to the [Code reference tables](#section/Support) in the Support section for list of possible values.
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
birthcountry?: {
/**
*
* example:
* SG
*/
code?: string;
/**
*
* example:
* SINGAPORE
*/
desc?: string;
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* ResidentialStatus
* Residential Status of Person. Applicable to Singapore Citizens and Permanent Residents.
*
*
* **Note:** This data item is not applicable for FIN holders i.e. `source` will be '3'.
* In such cases, the `code` and `desc` properties will be blank or empty string ("").
*
* A - ALIEN
* C - CITIZEN
* P - PR
* U - UNKNOWN
* N - NOT APPLICABLE
* < BLANK > (for FIN holders only)
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
residentialstatus?: {
/**
* example:
* C
*/
code?: "A" | "C" | "P" | "U" | "N" | "";
/**
* example:
* CITIZEN
*/
desc?: "ALIEN" | "CITIZEN" | "PR" | "UNKNOWN" | "NOT APPLICABLE" | "";
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* PassportNumber
* Passport Number of Person.
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
passportnumber?: {
/**
* Value of data field.
* example:
* E35463874W
*/
value?: string;
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* PassportExpiryDate
* Passport Expiry Date of Person.
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
passportexpirydate?: {
/**
* Value of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14
* example:
* 2020-01-01
*/
value?: string;
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* RegAdd
* Registered Address of Person (including FIN holders)
*
* **Note:**
* - address can be either a Singapore address (type: 'SG') or non Singapore address (type: 'UNFORMATTED')
* - check the `type` discriminator property to differentiate between the two address formats
* - may be unavailable for some FIN holders
*/
regadd?:
/**
* Address details (Singapore Format)
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
DataitemAddressSg
/**
* Address details (Non-Singapore Format)
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
| DataitemAddressUnformatted;
/**
* MailAdd
* Mailing Address of Person
*
* **Note:**
* - address can be either a Singapore address (type: 'SG') or non Singapore address (type: 'UNFORMATTED')
* - check the `type` discriminator property to differentiate between the two address formats
*
*/
mailadd?:
/**
* Address details (Singapore Format)
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
DataitemAddressSg
/**
* Address details (Non-Singapore Format)
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
| DataitemAddressUnformatted;
/**
* BillAdd
* Billing Address of Person
*
* **Note:**
* - address can be either a Singapore address (type: 'SG') or non Singapore address (type: 'UNFORMATTED')
* - check the `type` discriminator property to differentiate between the two address formats
*
*/
billadd?:
/**
* Address details (Singapore Format)
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
DataitemAddressSg
/**
* Address details (Non-Singapore Format)
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
| DataitemAddressUnformatted;
/**
* HousingType
* Housing Type of Person (non-HDB only).
*
* **Note 1:** If `hdbtype` is available, this value will be null.
*
* **Note 2:** If `housingtype` & `hdbtype` are unavailable, make this field user editable.
*
* Refer to `hdbtype` for detailed HDB type.
*
* '121' - DETACHED HOUSE
* '122' - SEMI-DETACHED HOUSE
* '123' - TERRACE HOUSE
* '131' - CONDOMINIUM
* '132' - EXECUTIVE CONDOMINIUM
* '139' - APARTMENT
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
housingtype?: {
/**
*
* example:
* 123
*/
code?: "121" | "122" | "123" | "131" | "132" | "139";
/**
*
* example:
* TERRACE HOUSE
*/
desc?: "DETACHED HOUSE" | "SEMI-DETACHED HOUSE" | "TERRACE HOUSE" | "CONDOMINIUM" | "EXECUTIVE CONDOMINIUM" | "APARTMENT";
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* HDBType
* Flat Type of the HDB flat.
*
* **Note 1:** that this excludes Rental Flats, Pre-War SIT flat, PSA flat, HUDC flat, Executive Condominium and Shophouse.
*
* **Note 2:** If `housingtype` is available, this value will be null.
*
* **Note 3:** If `housingtype` & `hdbtype` are unavailable, make this field user editable.
*
* '111' - 1-ROOM FLAT (HDB)
* '112' - 2-ROOM FLAT (HDB)
* '113' - 3-ROOM FLAT (HDB)
* '114' - 4-ROOM FLAT (HDB)
* '115' - 5-ROOM FLAT (HDB)
* '116' - EXECUTIVE FLAT (HDB)
* '118' - STUDIO APARTMENT (HDB)
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
hdbtype?: {
/**
*
* example:
* 112
*/
code?: "111" | "112" | "113" | "114" | "115" | "116" | "118";
/**
*
* example:
* 2-ROOM FLAT (HDB)
*/
desc?: "1-ROOM FLAT (HDB)" | "2-ROOM FLAT (HDB)" | "3-ROOM FLAT (HDB)" | "4-ROOM FLAT (HDB)" | "5-ROOM FLAT (HDB)" | "EXECUTIVE FLAT (HDB)" | "STUDIO APARTMENT (HDB)";
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* HDBOwnership
* HDB Ownership details
*
*/
hdbownership?: {
/**
* Number of Owners. Note that this does not include executors, administrators or trustees.
*/
noofowners?: {
/**
* example:
* 2
*/
value?: number;
};
/**
* Address details (Singapore Format)
*/
address?: {
/**
* Type of Address (SG or UNFORMATTED for non SG)
*/
type?: "SG" | "UNFORMATTED";
/**
* Block/House of Address
*/
block?: {
/**
* example:
* 548
*/
value?: string;
};
/**
* Building of Address
*/
building?: {
/**
* example:
*
*/
value?: string;
};
/**
* Floor of Address
*/
floor?: {
/**
* example:
* 09
*/
value?: string;
};
/**
* Unit of Address
*/
unit?: {
/**
* example:
* 128
*/
value?: string;
};
/**
* Street of Address
*/
street?: {
/**
* example:
* BEDOK NORTH AVENUE 1
*/
value?: string;
};
/**
* Postal Code of Address
*/
postal?: {
/**
* example:
* 460548
*/
value?: string;
};
/**
* Country/Place of Address. For AddressSG this will always be "SG".
*/
country?: {
code?: string;
desc?: string;
};
};
/**
* HDBType
* Flat Type of the HDB flat.
*
* **Note 1:** that this excludes Rental Flats, Pre-War SIT flat, PSA flat, HUDC flat, Executive Condominium and Shophouse.
*
* **Note 2:** If `housingtype` is available, this value will be null.
*
* **Note 3:** If `housingtype` & `hdbtype` are unavailable, make this field user editable.
*
* '111' - 1-ROOM FLAT (HDB)
* '112' - 2-ROOM FLAT (HDB)
* '113' - 3-ROOM FLAT (HDB)
* '114' - 4-ROOM FLAT (HDB)
* '115' - 5-ROOM FLAT (HDB)
* '116' - EXECUTIVE FLAT (HDB)
* '118' - STUDIO APARTMENT (HDB)
*/
hdbtype?: {
/**
*
* example:
* 112
*/
code?: "111" | "112" | "113" | "114" | "115" | "116" | "118";
/**
*
* example:
* 2-ROOM FLAT (HDB)
*/
desc?: "1-ROOM FLAT (HDB)" | "2-ROOM FLAT (HDB)" | "3-ROOM FLAT (HDB)" | "4-ROOM FLAT (HDB)" | "5-ROOM FLAT (HDB)" | "EXECUTIVE FLAT (HDB)" | "STUDIO APARTMENT (HDB)";
};
/**
* Date from which the lease period starts. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14
*/
leasecommencementdate?: {
/**
* example:
* 2008-06-13
*/
value?: string;
};
/**
* Term of lease (in years) for the property computed from the lease commencement date.
*/
termoflease?: {
/**
* example:
* 99
*/
value?: number;
};
/**
* Effective date of flat purchase. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14
*/
dateofpurchase?: {
/**
* example:
* 2008-06-13
*/
value?: string;
};
/**
* Effective date of partial transfer without monetary consideration (e.g. addition, deletion or substitution of a co-owner) for an HDB sold flat.
*
* For partial transfer of flat where at least one of the current owner remains in the household, the Date of Purchase remains unchanged while the date of transfer of ownership will be updated.
*
* For outright transfer where there is a total change of all owner(s), only the Date of Purchase will be updated.
*
* See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14'
*/
dateofownershiptransfer?: {
/**
* example:
* 2018-06-13
*/
value?: string;
};
/**
* The amount of housing loan granted to owner(s) by HDB in SGD.
*/
loangranted?: {
/**
* example:
* 310000.01
*/
value?: number;
};
/**
* The number of years of loan repaymnet opted by owner(s) at the time the loan is first granted to him/her.
*/
originalloanrepayment?: {
/**
* example:
* 25
*/
value?: number;
};
/**
* The remaining term of repayment for the loan in the format `years` + `months`.
*/
balanceloanrepayment?: {
years?: {
/**
* example:
* 2
*/
value?: number;
};
months?: {
/**
* example:
* 6
*/
value?: number;
};
};
/**
* The amount of outstanding HDB loan owed by owner(s) in SGD.
*/
outstandingloanbalance?: {
/**
* example:
* 50000.01
*/
value?: number;
};
/**
* The amount of monthly instalment the owner(s) have to pay for his/her loan in SGD.
*/
monthlyloaninstalment?: {
/**
* example:
* 1000.01
*/
value?: number;
};
/**
* The amount of outstanding instalment the owner(s) have to pay for his/her loan in SGD.
*/
outstandinginstalment?: {
/**
* example:
* 1000.01
*/
value?: number;
};
/**
* The purchase price of the HDB flat in SGD.
*/
purchaseprice?: {
/**
* example:
* 1000.01
*/
value?: number;
};
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
}[];
/**
* OwnerPrivate
* Ownership of Private Property Status of Person (based on IRAS information).
*
* true
* false
* null (data not available)
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
ownerprivate?: {
/**
* Value of data field.
* example:
* false
*/
value?: boolean;
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* Email
* Email Address of Person.
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
email?: {
/**
* Value of data field.
* example:
* test@gmail.com
*/
value?: string;
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* HomeNo
* Home Contact Number of Person.
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
homeno?: {
/**
* Prefix of Phone Number. Defaults to '+'. If phone number is blank, prefix will be returned as blank.
*/
prefix?: {
/**
* example:
* +
*/
value?: string;
};
/**
* Area Code of Phone Number. Default to '65'. If phone number is blank, code will be returned as blank.
*/
areacode?: {
/**
* example:
* 65
*/
value?: string;
};
/**
* Phone Number.
*/
nbr?: {
/**
* example:
* 66132665
*/
value?: string;
};
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* MobileNo
* Mobile Number of Person.
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
mobileno?: {
/**
* Prefix of Phone Number. Defaults to '+'. If phone number is blank, prefix will be returned as blank.
*/
prefix?: {
/**
* example:
* +
*/
value?: string;
};
/**
* Area Code of Phone Number. Default to '65'. If phone number is blank, code will be returned as blank.
*/
areacode?: {
/**
* example:
* 65
*/
value?: string;
};
/**
* Phone Number.
*/
nbr?: {
/**
* example:
* 66132665
*/
value?: string;
};
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* Marital
* Marital Status of Person.
*
* '1' - SINGLE
* '2' - MARRIED
* '3' - WIDOWED
* '5' - DIVORCED
*
* **Note:** This field must be made **editable** on your digital service form even though `source` is '1' (Government Verified).
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
marital?: {
/**
*
* example:
* 2
*/
code?: "1" | "2" | "3" | "5";
/**
*
* example:
* MARRIED
*/
desc?: "SINGLE" | "MARRIED" | "WIDOWED" | "DIVORCED";
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* MarriageCertNo
* Certificate number of the latest marriage.
*
*
* **Note:** This field must be made **editable** on your digital service form even though `source` is '1' (Government Verified).
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
marriagecertno?: {
/**
* Value of data field.
* example:
* 123456789012345
*/
value?: string;
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* CountryOfMarriage
* Country/Place of the latest marriage.
*
*
* **Note:** This field must be made **editable** on your digital service form even though `source` is '1' (Government Verified).
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
countryofmarriage?: {
/**
*
* example:
* SG
*/
code?: string;
/**
*
* example:
* SINGAPORE
*/
desc?: string;
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* MarriageDate
* Latest Marriage Date of Person.
*
*
* **Note:** This field must be made **editable** on your digital service form even though `source` is '1' (Government Verified).
*
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
marriagedate?: {
/**
* Value of data field.
*
* See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14
* example:
* 2007-01-01
*/
value?: string;
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* DivorceDate
* Last Divorce Date of Person.
*
*
* **Note:** This field must be made **editable** on your digital service form even though `source` is '1' (Government Verified).
*
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
divorcedate?: {
/**
* Value of data field.
*
* See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14
* example:
*
*/
value?: string;
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* ChildrenBirthRecords
* This refers to only local registered birth records(based on ICA’s electronic Birth Certificate Records from 1985 onwards).
*
* This includes adoption of locally registered child.
*
* For child below 21, the child’s Birth Cert No, Name, Sex, Race, Dialect, Date of Birth and Time of Birth will be shown.
*
* For child above 21, only the child’s Birth Cert Number will be shown.
*/
childrenbirthrecords?: {
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
/**
* Birth certificate number of child.
*/
birthcertno?: {
/**
* example:
* S5562882C
*/
value?: string;
};
/**
* Full Name of child
*/
name?: {
/**
* example:
* Jo Tan Pei Ni
*/
value?: string;
};
/**
* Han Yu Pin Yin name of child.
*
* Presentation Logic - If there is a value to `hanyupinyinname` (i.e. not empty), then `hanyupinyinname` should be displayed in a new line below `name`, and formatted with round brackets i.e. \"(`hanyupinyinname`)\".*
*/
hanyupinyinname?: {
/**
* example:
* Cheng Pei Ni
*/
value?: string;
};
/**
* Alias name of child.
*
* Presentation Logic - If there is a value to `aliasname` (i.e. not empty), then `aliasname` should be displayed in a new line below `hanyupinyinname`, and prefixed with the ''@'' symbol i.e. \"@`aliasname`\".*
*/
aliasname?: {
/**
* example:
*
*/
value?: string;
};
/**
* Han Yu Pin Yin Alias name of child.
*
* Presentation Logic - If there is a value to `hanyupinyinaliasname` (i.e. not empty), then `hanyupinyinaliasname` should be displayed in a new line below `aliasname`, and prefixed with the ''@'' symbol i.e. \"@`hanyupinyinaliasname`\".*
*/
hanyupinyinaliasname?: {
/**
* example:
*
*/
value?: string;
};
/**
* Married name of child.
*
* Presentation Logic - If there is a value to `marriedname` (i.e. not empty), then `marriedname` should be displayed in a new line below `hanyupinyinaliasname`.*
*/
marriedname?: {
/**
* example:
*
*/
value?: string;
};
/**
* Sex of child. Possible values:
*
* 'F' - FEMALE
* 'M' - MALE
* 'U' - UNKNOWN
*/
sex?: {
/**
* example:
* F
*/
code?: "F" | "M" | "U";
/**
* example:
* FEMALE
*/
desc?: "FEMALE" | "MALE" | "UNKNOWN";
};
/**
* Race of child.
*
* Refer to the [Code reference tables](#section/Support) in the Support section for list of possible values.
*
*/
race?: {
/**
* example:
* CN
*/
code?: string;
/**
* example:
* CHINESE
*/
desc?: string;
};
/**
* Secondary Race of child.
*
* Refer to the [Code reference tables](#section/Support) in the Support section for list of possible values.
*/
secondaryrace?: {
/**
* example:
*
*/
code?: string;
/**
* example:
*
*/
desc?: string;
};
/**
* Dialect of child.
*
* Refer to the [Code reference tables](#section/Support) in the Support section for list of possible values.
*/
dialect?: {
/**
* example:
* HK
*/
code?: string;
/**
* example:
* HOKKIEN
*/
desc?: string;
};
/**
* Life Status of child. Possible values:
*
* A - ALIVE
* D - DECEASED
*/
lifestatus?: {
/**
* example:
* D
*/
code?: "A" | "D";
/**
* example:
* DECEASED
*/
desc?: "ALIVE" | "DECEASED";
};
/**
* Date of Birth of child.
*
* See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14
*/
dob?: {
/**
* example:
* 2011-09-10
*/
value?: string;
};
/**
* Time of Birth of child.
*
* Format: HHMM
*/
tob?: {
/**
* example:
* 0901
*/
value?: string;
};
vaccinationrequirements?: {
/**
* Vaccination Requirement.
*
* Refer to the [Code reference tables](#section/Support) in the Support section for list of possible values.
*/
requirement?: {
/**
* example:
* 1M3D
*/
code?: string;
/**
* example:
* MINIMUM VACCINATION REQUIREMENT FOR PRESCHOOL
*/
desc?: string;
};
fulfilled?: {
/**
* example:
* true
*/
value?: boolean;
};
}[];
/**
* Indicates whether the child is a Singapore Citizen at the time of birth.
*
* Y - Yes
* N - No
* < BLANK > - Not applicable
*/
sgcitizenatbirthind?: {
/**
* example:
* Y
*/
value?: "Y" | "N" | "";
};
}[];
/**
* SponsoredChildrenRecords
* Details of children sponsored to be SC/PR/LTVP
*
* For child below 21, the child's NRIC/FIN, Name, Sex, Race, Secondary Race, Dialect, Date of Birth, Country/Place of Birth, Residential Status and SC/PR/LTVP grant date will be shown.
*
* For child above 21, only the child's last known NRIC/FIN will be shown.
*/
sponsoredchildrenrecords?: {
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
/**
* NRIC/FIN of child
*/
nric?: {
/**
* example:
* S5562882C
*/
value?: string;
};
/**
* Full Name of child
*/
name?: {
/**
* example:
* Jo Tan Pei Ni
*/
value?: string;
};
/**
* Han Yu Pin Yin name of child.
*/
hanyupinyinname?: {
/**
* example:
* Cheng Pei Ni
*/
value?: string;
};
/**
* Alias name of child.
*/
aliasname?: {
/**
* example:
*
*/
value?: string;
};
/**
* Han Yu Pin Yin Alias name of child.
*/
hanyupinyinaliasname?: {
/**
* example:
*
*/
value?: string;
};
/**
* Married name of child.
*/
marriedname?: {
/**
* example:
*
*/
value?: string;
};
/**
* Sex of child. Possible values:
*
* 'F' - FEMALE
* 'M' - MALE
* 'U' - UNKNOWN
*/
sex?: {
/**
* example:
* F
*/
code?: "F" | "M" | "U";
/**
* example:
* FEMALE
*/
desc?: "FEMALE" | "MALE" | "UNKNOWN";
};
/**
* Race of child.
*
* Refer to the [Code reference tables](#section/Support) in the Support section for list of possible values.
*/
race?: {
/**
* example:
* CN
*/
code?: string;
/**
* example:
* CHINESE
*/
desc?: string;
};
/**
* Secondary Race of child.
*
* Refer to the [Code reference tables](#section/Support) in the Support section for list of possible values.
*/
secondaryrace?: {
/**
* example:
*
*/
code?: string;
/**
* example:
*
*/
desc?: string;
};
/**
* Dialect of child.
*
* Refer to the [Code reference tables](#section/Support) in the Support section for list of possible values.
*/
dialect?: {
/**
* example:
* HK
*/
code?: string;
/**
* example:
* HOKKIEN
*/
desc?: string;
};
/**
* Date of Birth of child.
*
* See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14
*/
dob?: {
/**
* example:
* 2011-09-10
*/
value?: string;
};
/**
* BirthCountry
* Country/Place of Birth of child.
*
* Refer to the [Code reference tables](#section/Support) in the Support section for list of possible values.
*/
birthcountry?: {
/**
* example:
* SG
*/
code?: string;
/**
* example:
* SINGAPORE
*/
desc?: string;
};
/**
* Life Status of child. Possible values:
*
* A - ALIVE
* D - DECEASED
*/
lifestatus?: {
/**
* example:
* A
*/
code?: "A" | "D";
/**
* example:
* ALIVE
*/
desc?: "ALIVE" | "DECEASED";
};
/**
* ResidentialStatus
* Residential Status of child. Possible values:
*
* A - ALIEN
* C - CITIZEN
* P - PR
* U - UNKNOWN
* N - NOT APPLICABLE
*/
residentialstatus?: {
/**
* example:
* C
*/
code?: "A" | "C" | "P" | "U" | "N";
/**
* example:
* Citizen
*/
desc?: "ALIEN" | "CITIZEN" | "PR" | "UNKNOWN" | "NOT APPLICABLE";
};
/**
* Nationality/Citizenship of child.
*
* Refer to the [Code reference tables](#section/Support) in the Support section for list of possible values.
*/
nationality?: {
/**
* example:
* SG
*/
code?: string;
/**
* example:
* SINGAPORE CITIZEN
*/
desc?: string;
};
/**
* Date granted Singapore Citizenship, Permanent Resident or Long-term Visit Pass
*
* See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14
*/
scprgrantdate?: {
/**
* example:
* 2015-06-13
*/
value?: string;
};
vaccinationrequirements?: {
/**
* Vaccination Requirement
*
* Refer to the [Code reference tables](#section/Support) in the Support section for list of possible values.
*/
requirement?: {
/**
* example:
* 1M3D
*/
code?: string;
/**
* example:
* MINIMUM VACCINATION REQUIREMENT FOR PRESCHOOL
*/
desc?: string;
};
fulfilled?: {
/**
* example:
* true
*/
value?: boolean;
};
}[];
}[];
/**
* EduLevel
* Highest Education Level of Person.
*
* '0' - NO FORMAL QUALIFICATION / PRE-PRIMARY / LOWER PRIMARY
* '1' - PRIMARY
* '2' - LOWER SECONDARY
* '3' - SECONDARY
* '4' - POST-SECONDARY (NON-TERTIARY): GENERAL & VOCATION
* '5' - POLYTECHNIC DIPLOMA
* '6' - PROFESSIONAL QUALIFICATION AND OTHER DIPLOMA
* '7' - BACHELOR'S OR EQUIVALENT
* '8' - POSTGRADUATE DIPLOMA / CERTIFICATE (EXCLUDING MASTER'S AND DOCTORATE)
* '9' - MASTER'S AND DOCTORATE OR EQUIVALENT
* 'N' - MODULAR CERTIFICATION (NON-AWARD COURSES / NON-FULL QUALIFICATIONS)
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
edulevel?: {
/**
*
* example:
* 7
*/
code?: "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" | "N";
/**
* example:
* BACHELOR'S OR EQUIVALENT
*/
desc?: "NO FORMAL QUALIFICATION / PRE-PRIMARY / LOWER PRIMARY" | "PRIMARY" | "LOWER SECONDARY" | "SECONDARY" | "POST-SECONDARY (NON-TERTIARY): GENERAL & VOCATION" | "POLYTECHNIC DIPLOMA" | "PROFESSIONAL QUALIFICATION AND OTHER DIPLOMA" | "BACHELOR'S OR EQUIVALENT" | "POSTGRADUATE DIPLOMA / CERTIFICATE (EXCLUDING MASTER'S AND DOCTORATE)" | "MASTER'S AND DOCTORATE OR EQUIVALENT" | "MODULAR CERTIFICATION (NON-AWARD COURSES / NON-FULL QUALIFICATIONS)";
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* GradYear
* Year of Graduation of Person. Format: YYYY
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
gradyear?: {
/**
* example:
* 2006
*/
value?: string;
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* SchoolName
* Name of School of Person.
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
schoolname?: {
/**
* Code value of school name.
*
* **Note:** Code+desc and value are mutually exclusive.
* example:
* T07GS3011J
*/
code?: string;
/**
* Name of school represented by 'code'
*
* **Note:** Code+desc and value are mutually exclusive.
* example:
* SIGLAP SECONDARY SCHOOL
*/
desc?: string;
/**
* Free text value of school name.
*
* **Note:** Code+desc and value are mutually exclusive.
* example:
*
*/
value?: string;
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* Occupation
* Occupation of Person.
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
occupation?: {
/**
* Free text.
*
* For SC/PR holders, blank will be returned.
* example:
*
*/
value?: string;
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* Employment
* Name of Employer.
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
employment?: {
/**
* example:
* ALPHA
*/
value?: string;
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* PassType
* Pass type of a FIN holder.
**Note:** Only applies to a foreigner with a valid pass.
*
* Refer to the [Code reference tables](#section/Support) in the Support section for list of possible values.
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
passtype?: {
/**
* Value of data field.
* example:
* RPass
*/
code?: string;
/**
* example:
* Work Permit
*/
desc?: string;
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* PassStatus
* Pass status of a FIN holder.
**Note:** Only applies to a foreigner with a valid pass.
* Live
* Approved
*
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
passstatus?: {
/**
* Value of data field.
* example:
* Live
*/
value?: "Live" | "Approved";
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* PassExpiryDate
* Pass expiry of a foreigner.
**Note:** Only applies to a foreigner with a valid pass.
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
passexpirydate?: {
/**
* Value of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14
* example:
* 2022-12-31
*/
value?: string;
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* EmploymentSector
* Employment Sector of a FIN holder.
*
* **Note:** Only applies to a foreigner with a valid work pass.
*
* Some examples of possible values are:
* MANUFACTURING
* CONSTRUCTION
* RECLAMATION
* SERVICE
* GRI-TECHNOLOGY
* LANDSCAPING
* INCINERATOR PLANT
* MARINE SHIPYARD
* PROCESS
* HARBOURCRAFT
* DOMESTIC
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
employmentsector?: {
/**
* example:
* MANUFACTURING
*/
value?: string;
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* HouseholdIncome
* Household Income of Person in SGD.
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
householdincome?: {
/**
* upper bound of the range of household income bracket
*/
high?: {
/**
* example:
* 5999
*/
value?: number;
};
/**
* lower bound of the range of household income bracket
*/
low?: {
/**
* example:
* 5000
*/
value?: number;
};
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
vehicles?: {
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
/**
* Vehicle Registration Number displayed on the vehicle number plates
*/
vehicleno?: {
/**
* example:
* SDF1235A
*/
value?: string;
};
/**
* Type of Vehicles such as 'MOTOR CAR', 'STATION /WAGON/JEEP/LAND ROVER'
*/
type?: {
/**
* example:
* PASSENGER MOTOR CAR
*/
value?: string;
};
/**
* In-Vehicle Unit (IU) number of the device fitted in Singapore-registered vehicles for Electronic Road Pricing (ERP) gantries and Electronic Parking System (EPS) car parks.
*/
iulabelno?: {
/**
* example:
*
*/
value?: string;
};
/**
* Vehicle Make such as 'TOYOTA', 'HONDA', 'AUDI'
*/
make?: {
/**
* example:
* TOYOTA
*/
value?: string;
};
/**
* Vehicle Model such as 'COROLLA ALTIS CLASSIC 1.6 CVT', 'HRV 1.5 DX CVT'
*/
model?: {
/**
* example:
* COROLLA ALTIS
*/
value?: string;
};
/**
* Vehicle Chassis Number
*/
chassisno?: {
/**
* example:
* ZC11S1735800
*/
value?: string;
};
/**
* Vehicle Engine Number
*/
engineno?: {
/**
* example:
* M13A1837453
*/
value?: string;
};
/**
* Vehicle Motor Number
*/
motorno?: {
/**
* example:
*
*/
value?: string;
};
/**
* Manufacturing year
*/
yearofmanufacture?: {
/**
* example:
* 2010
*/
value?: string;
};
/**
* Date when vehicle is registered with LTA. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14'
*/
firstregistrationdate?: {
/**
* example:
* 2010-06-06
*/
value?: string;
};
/**
* Date when vehicle is first registered in the country of origin. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14'
*/
originalregistrationdate?: {
/**
* example:
* 2010-06-06
*/
value?: string;
};
/**
* Vehicle Certificate of Entitlement (COE) bid category
*/
coecategory?: {
/**
* example:
* A - CAR UP TO 1600CC & 97KW (130BHP)
*/
value?: string;
};
/**
* Vehicle Certificate of Entitlement (COE) expiry date. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14'
*/
coeexpirydate?: {
/**
* example:
* 2020-06-05
*/
value?: string;
};
/**
* See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14'
*/
roadtaxexpirydate?: {
/**
* example:
* 2020-06-05
*/
value?: string;
};
/**
* Actual Quota Premium (QP) amount payable for the COE upon registration, conversion or COE revalidation in Singapore dollars (SGD). For renewal of COE, the value will contain actual PQP paid.
*/
quotapremium?: {
/**
* example:
* 14000.01
*/
value?: number;
};
/**
* Open Market Value is the value of manufacturer invoice price, freight and insurance in Singapore dollars (SGD).
*/
openmarketvalue?: {
/**
* example:
* 25000.01
*/
value?: number;
};
/**
* CO2 emission rate
*/
co2emission?: {
/**
* example:
* 146.01
*/
value?: number;
};
/**
* Status of the Vehicle.
*
* 1 - LIVE
* 2 - DE-REGISTERED
*/
status?: {
/**
* example:
* 1
*/
code?: "1" | "2";
/**
* example:
* LIVE
*/
desc?: "LIVE" | "DE-REGISTERED";
};
/**
* Vehicle Primary Colour (e.g. BLACK)
*/
primarycolour?: {
/**
* example:
* BLACK
*/
value?: string;
};
/**
* Vehicle Primary Colour (e.g. WHITE)
*/
secondarycolour?: {
/**
* example:
* WHITE
*/
value?: string;
};
/**
* Vehicle Attachment 1 (e.g. DISABLED)
*/
attachment1?: {
/**
* example:
* DISABLED
*/
value?: string;
};
/**
* Vehicle Attachment 2 (e.g. WITH SUN ROOF)
*/
attachment2?: {
/**
* example:
* WITH SUN ROOF
*/
value?: string;
};
/**
* Vehicle Attachment 3 (e.g. SIDE CURTAIN)
*/
attachment3?: {
/**
* example:
* SIDE CURTAIN
*/
value?: string;
};
/**
* Vehicle Scheme (e.g. REVISED OFF-PEAK CAR)
*/
scheme?: {
/**
* example:
* REVISED OFF-PEAK CAR
*/
value?: string;
};
/**
* Total Hydro Carbon (THC) emission rate
*/
thcemission?: {
/**
* example:
* 1.011001
*/
value?: number;
};
/**
* Carbon Monoxide emission rate
*/
coemission?: {
/**
* example:
* 1.100001
*/
value?: number;
};
/**
* Nitrogen Oxide (NOx) emission rate.
*/
noxemission?: {
/**
* example:
* 0.011001
*/
value?: number;
};
/**
* Particulates (PM - Atmospheric Particulate Matter) emission rate.
*/
pmemission?: {
/**
* example:
* 0.007
*/
value?: number;
};
/**
* Engine Capacity in cubic centimeter (cc)
*/
enginecapacity?: {
/**
* example:
* 1600
*/
value?: number;
};
/**
* Power Rate. Applicable to Electric and Hybrid vehicles powered by electric motors. Unit is Kilowatt.
*/
powerrate?: {
/**
* example:
* 1.41
*/
value?: number;
};
/**
* Effective Date/Time of Ownership. See "date-time" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14'
*/
effectiveownership?: {
/**
* example:
* 2010-08-31T20:12:12+08:00
*/
value?: string;
};
/**
* Propellant (e.g. Compressed Natural Gas, Diesel, Diesel-CNG, Diesel-Electric, Diesel-Electric (Plug-In), Electric, Gas, Liquefied Petroleum Gas (LPG), Petrol, Petrol-CNG, Petrol-Electric, Petrol-Electric (Plug-In), Petrol-LPG
*/
propellant?: {
/**
* example:
* Compressed Natural Gas
*/
value?: string;
};
/**
* Maximum Unladen Weight in kilograms (kg)
*/
maximumunladenweight?: {
/**
* example:
* 1500
*/
value?: number;
};
/**
* Maximum Laden Weight in kilograms (kg)
*/
maximumladenweight?: {
/**
* example:
* 1795
*/
value?: number;
};
/**
* Minimum PARF Benefit in Singapore dollars (SGD).
*/
minimumparfbenefit?: {
/**
* example:
* 8770.01
*/
value?: number;
};
/**
* Number of Transfer
*/
nooftransfers?: {
/**
* example:
* 2
*/
value?: number;
};
/**
* Vehicle Parking Certificate. Applicable for Heavy Vehicles.
*/
vpc?: {
/**
* example:
* 1234567890
*/
value?: string;
};
}[];
/**
* Driving Licence details of Person.
*
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
drivinglicence?: {
/**
* Status of Certificate of Merit. Possible values:
*
* Y - ELIGIBLE
* N - NOT ELIGIBLE
*/
comstatus?: {
/**
* example:
* Y
*/
code?: "Y" | "N";
/**
*
* example:
* ELIGIBLE
*/
desc?: "ELIGIBLE" | "NOT ELIGIBLE";
};
/**
* Total Demerit Points
*/
totaldemeritpoints?: {
/**
* example:
* 0
*/
value?: number;
};
/**
*
*/
suspension?: {
/**
* Suspension Start Date
*/
startdate?: {
/**
* example:
*
*/
value?: string;
};
/**
* Suspension End Date
*/
enddate?: {
/**
* example:
*
*/
value?: string;
};
};
/**
*
*/
disqualification?: {
/**
* Disqualification Start Date
*/
startdate?: {
/**
* example:
*
*/
value?: string;
};
/**
* Disqualification End Date
*/
enddate?: {
/**
* example:
*
*/
value?: string;
};
};
/**
*
*/
revocation?: {
/**
* Revocation Start Date
*/
startdate?: {
/**
* example:
*
*/
value?: string;
};
/**
* Revocation End Date
*/
enddate?: {
/**
* example:
*
*/
value?: string;
};
};
/**
* Provisional Driving Licence (PDL)
*/
pdl?: {
/**
* Validity of PDL. Possible values:
*
* V - VALID
* E - EXPIRED
* I - INVALID
* N - NOT HOLDING
*/
validity?: {
/**
* example:
* V
*/
code?: "V" | "E" | "I" | "N";
/**
*
* example:
* VALID
*/
desc?: "VALID" | "EXPIRED" | "INVALID" | "NOT HOLDING";
};
/**
* PDL Expiry Date
*/
expirydate?: {
/**
* example:
* 2020-06-15
*/
value?: string;
};
/**
* PDL Classes
* example:
* [
* {
* "class": {
* "value": "2A"
* }
* },
* {
* "class": {
* "value": "3A"
* }
* }
* ]
*/
classes?: {
class?: {
value?: string;
};
}[];
};
/**
* Qualified Driving Licence (QDL)
*/
qdl?: {
/**
* Validity of QDL. Possible values:
*
* V - VALID
* E - EXPIRED
* I - INVALID
* N - NOT HOLDING
*/
validity?: {
/**
* example:
* V
*/
code?: "V" | "E" | "I" | "N";
/**
*
* example:
* VALID
*/
desc?: "VALID" | "EXPIRED" | "INVALID" | "NOT HOLDING";
};
/**
* QDL Expiry Date
*/
expirydate?: {
/**
* example:
* 2020-06-15
*/
value?: string;
};
/**
* QDL Classes. Includes Issue Date (e.g. 2B, 2018-01-01)
* example:
* [
* {
* "class": {
* "value": "2A"
* },
* "issuedate": {
* "value": "2018-06-06"
* }
* },
* {
* "class": {
* "value": "3A"
* },
* "issuedate": {
* "value": "2018-06-06"
* }
* }
* ]
*/
classes?: {
class?: {
value?: string;
};
issuedate?: {
value?: string;
};
}[];
};
/**
* Serial Number of the Photo Card
*/
photocardserialno?: {
/**
* example:
* 115616
*/
value?: string;
};
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* Academic Qualifications
* Academic Qualifications achieved
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
academicqualifications?: {
/**
* Transcript of qualification
*/
transcripts?: {
/**
* Qualification's Name
*/
name?: {
/**
* example:
* SINGAPORE-CAMBRIDGE GENERAL CERTIFICATE OF EDUCATION ORDINARY LEVEL
*/
value?: string;
};
/**
* Year this qualification was attained
*
* See "date-fullyear" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14'
*/
yearattained?: {
/**
* example:
* 2018
*/
value?: string;
};
results?: {
/**
* Subject taken
*/
subject?: {
/**
* example:
* English Language
*/
value?: string;
};
/**
* Level of subject taken
*/
level?: {
/**
* example:
* Ordinary
*/
value?: string;
};
/**
* Grade attained
*/
grade?: {
/**
* example:
* A
*/
value?: string;
};
/**
* Optional Sub Subject taken
*/
subsubject?: {
/**
* example:
* SPECIAL PAPER
*/
value?: string;
};
/**
* Optional grade attained for subSubject
*/
subgrade?: {
/**
* example:
* One
*/
value?: string;
};
}[];
/**
* Explanatory Notes
*/
explanatorynotes?: {
value?: string;
};
}[];
/**
* Electronic Certificates Uploaded
*/
certificates?: {
/**
* File name of the electronic certificate
*/
name?: {
/**
* example:
* nus.opencert
*/
value?: string;
};
/**
* File content of the electronic certificate, Base64 encoded
*/
content?: {
value?: string;
};
/**
* Open Certificate Information
*
* Note: The test environment for OpenCert is at https://dev.opencerts.io/ while production is
* at https://opencerts.io/
*/
opencertificate?: {
/**
* The OpenCert serial number.
*/
id?: {
/**
* example:
* 100000000343840
*/
value?: string;
};
/**
* Indicate whether this open certificate is primary certificate
*/
primary?: {
/**
* example:
* true
*/
value?: boolean;
};
};
/**
* Indicate whether this file is open certificate
*/
opencertificateindicator?: {
/**
* example:
* true
*/
value?: boolean;
};
}[];
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
pioneergen?: {
eligibility: {
value: boolean;
};
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14
*/
lastupdated: string;
quantum: {
value: string;
};
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Message code
*
* '1' - PG Eligibility Tag: N
* '2' - PG Eligibility Tag: Y, Sign-up Tag: Y, Invalid Address Tag: N
* '3' - PG Eligibility Tag: Y, Sign-up Tag: Y, Invalid Address Tag: Y
* '4' - PG Eligibility Tag: Y, Sign-up Tag: N, Invalid Address Tag: N
* '5' - PG Eligibility Tag: Y, Sign-up Tag: N, Invalid Address Tag: Y
* '6' - PG Eligibility Tag: Y, Opt-Out Tag: Y
* '7' - PG Eligibility Tag: Y, Sign-up Tag: Y, NIL Status: Y
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
message: {
code: "1" | "2" | "3" | "4" | "5" | "6" | "7";
desc: "We regret that you are not eligible for the Pioneer Generation Package. For further enquiries, please contact 1800-2222-888." | "You are eligible for the Pioneer Generation Package. For further enquiries, please contact 1800-2222-888." | "You are eligible for the Pioneer Generation Package. Please contact 1800-2222-888 to receive your Pioneer Generation card." | "You are eligible for the Pioneer Generation Package. Please contact 1800-2222-888 to start receiving your Pioneer Generation benefits, such as your MediSave top-up." | "You are eligible for the Pioneer Generation Package. Please contact 1800-2222-888 to start receiving your Pioneer Generation benefits." | "We understand that you have opted out of receiving the benefits under the Pioneer Generation Package. For further enquiries, please contact 1800-2222-888." | "Please call 1800-2222-888 to start receiving your PG benefits.";
};
};
}
/**
* Person instance's details
*/
interface PersonCommunity {
/**
* MerdekaGen
* Merdekagen details
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
merdekagen?: {
/**
* Eligibility
*/
eligibility?: {
/**
* example:
* true
*/
value?: boolean;
};
/**
* Amount eligible for
*/
quantum?: {
/**
* example:
* 100
*/
value?: number;
};
/**
* Suggested user friendly display
*/
message?: {
/**
* example:
* 2
*/
code?: string;
/**
* example:
* You are eligible for the Merdeka Generation Package. For further enquiries, please contact 1800-2222-888.
*/
desc?: string;
};
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
pioneergen?: {
eligibility: {
value: boolean;
};
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
quantum: {
value: string;
};
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4" | "1" | "2" | "3" | "4";
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C" | "C";
/**
* Message code
*
* '1' - PG Eligibility Tag: N
* '2' - PG Eligibility Tag: Y, Sign-up Tag: Y, Invalid Address Tag: N
* '3' - PG Eligibility Tag: Y, Sign-up Tag: Y, Invalid Address Tag: Y
* '4' - PG Eligibility Tag: Y, Sign-up Tag: N, Invalid Address Tag: N
* '5' - PG Eligibility Tag: Y, Sign-up Tag: N, Invalid Address Tag: Y
* '6' - PG Eligibility Tag: Y, Opt-Out Tag: Y
* '7' - PG Eligibility Tag: Y, Sign-up Tag: Y, NIL Status: Y
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
message: {
code: "1" | "2" | "3" | "4" | "5" | "6" | "7";
desc: "We regret that you are not eligible for the Pioneer Generation Package. For further enquiries, please contact 1800-2222-888." | "You are eligible for the Pioneer Generation Package. For further enquiries, please contact 1800-2222-888." | "You are eligible for the Pioneer Generation Package. Please contact 1800-2222-888 to receive your Pioneer Generation card." | "You are eligible for the Pioneer Generation Package. Please contact 1800-2222-888 to start receiving your Pioneer Generation benefits, such as your MediSave top-up." | "You are eligible for the Pioneer Generation Package. Please contact 1800-2222-888 to start receiving your Pioneer Generation benefits." | "We understand that you have opted out of receiving the benefits under the Pioneer Generation Package. For further enquiries, please contact 1800-2222-888." | "Please call 1800-2222-888 to start receiving your PG benefits.";
};
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* SilverSupport
* Silver Support Scheme details
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
silversupport?: {
/**
* Eligibility
*/
eligibility?: {
/**
* example:
* true
*/
value?: boolean;
};
/**
* Amount eligible for
*/
amount?: {
/**
* example:
* 300
*/
value?: number;
};
/**
* Year given
*/
year?: {
/**
* Value of data field. See "date-fullyear" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14
* example:
* 2019
*/
value?: string;
};
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* GSTVoucher
* GST Voucher details
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
gstvoucher?: {
/**
* Indicator if user is excluded
*/
exclusion?: {
/**
* example:
* false
*/
value?: boolean;
};
/**
* Indicator if user needs to signup
*/
signup?: {
/**
* example:
* true
*/
value?: boolean;
};
/**
* Amount given for medisave account
*/
gstmedisave?: {
/**
* example:
* 100
*/
value?: number;
};
/**
* Amount given for ordinary account
*/
gstregular?: {
/**
* example:
* 100
*/
value?: number;
};
/**
* Amount given for special account
*/
gstspecial?: {
/**
* example:
* 100
*/
value?: number;
};
/**
* Year given
*/
year?: {
/**
* Value of data field. See "date-fullyear" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14
* example:
* 2019
*/
value?: string;
};
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
}
/**
* Person instance's details
*/
interface PersonFinancial {
/**
* Summary of latest Notice of Assessment within the past three years.
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
"noa-basic"?: {
/**
* Assessable Income
*/
amount?: {
/**
* example:
* 100000.01
*/
value?: number;
};
/**
* The second latest annual assessable income available from IRAS within the past 3 years.
*/
yearofassessment?: {
/**
* example:
* 2018
*/
value?: string;
};
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* Detailed breakdown of latest Notice of Assessment within the past three years.
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
noa?: {
/**
* Assessable Income
*/
amount?: {
/**
* example:
* 100000.01
*/
value?: number;
};
/**
* value of data field
*/
yearofassessment?: {
/**
* example:
* 2018
*/
value?: string;
};
/**
* Assessable Income from employment
*/
employment?: {
/**
* example:
* 100000.01
*/
value?: number;
};
/**
* Assessable Income from trade
*/
trade?: {
/**
* example:
* 0
*/
value?: number;
};
/**
* Assessable Income from rent
*/
rent?: {
/**
* example:
* 0
*/
value?: number;
};
/**
* Assessable Income from interest
*/
interest?: {
/**
* example:
* 0
*/
value?: number;
};
/**
* Tax Clearance indicator. This means that tax clearance has been sought by the employer for this NOA assessment. For more information, please refer to [this](https://www.iras.gov.sg/irashome/Businesses/Employers/Tax-Clearance-for-Foreign-SPR-Employees/Getting-Tax-Clearance--A-Step-by-Step-Guide/)
*/
taxclearance?: {
/**
* example:
* N
*/
value?: "Y" | "N";
};
/**
* Type of 'Notice of Assessment' (NOA)
*/
category?: {
/**
* example:
* ORIGINAL
*/
value?: "ADDITIONAL" | "AMENDED" | "ORIGINAL" | "REPAYMENT";
};
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* History of Notice Of Assessment (Basic)
* Summary of latest 2 Notice of Assessments within the past three years.
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
"noahistory-basic"?: {
noas?: NOABasic[];
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* History of Notice Of Assessment
* Detailed breakdown of latest 2 Notice of Assessments within the past three years.
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
noahistory?: {
noas?: NOA[];
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* CPFContributions
* Employer CPF Contributions of Person in SGD. Does not include any non-employer contributions.
* Maximum past 15 months' of contributions.
*
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
cpfcontributions?: {
/**
* example:
* [
* {
* "date": {
* "value": "2016-12-01"
* },
* "amount": {
* "value": 500
* },
* "month": {
* "value": "2016-11"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "date": {
* "value": "2016-12-12"
* },
* "amount": {
* "value": 500
* },
* "month": {
* "value": "2016-12"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "date": {
* "value": "2016-12-21"
* },
* "amount": {
* "value": 500
* },
* "month": {
* "value": "2016-12"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "date": {
* "value": "2017-01-01"
* },
* "amount": {
* "value": 500
* },
* "month": {
* "value": "2016-12"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "date": {
* "value": "2017-01-12"
* },
* "amount": {
* "value": 500
* },
* "month": {
* "value": "2017-01"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "date": {
* "value": "2017-01-21"
* },
* "amount": {
* "value": 500
* },
* "month": {
* "value": "2017-01"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "date": {
* "value": "2017-02-01"
* },
* "amount": {
* "value": 500
* },
* "month": {
* "value": "2017-01"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "date": {
* "value": "2017-02-12"
* },
* "amount": {
* "value": 500
* },
* "month": {
* "value": "2017-02"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "date": {
* "value": "2017-02-21"
* },
* "amount": {
* "value": 500
* },
* "month": {
* "value": "2017-02"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "date": {
* "value": "2017-03-01"
* },
* "amount": {
* "value": 500
* },
* "month": {
* "value": "2017-02"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "date": {
* "value": "2017-03-12"
* },
* "amount": {
* "value": 500
* },
* "month": {
* "value": "2017-03"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "date": {
* "value": "2017-03-21"
* },
* "amount": {
* "value": 500
* },
* "month": {
* "value": "2017-03"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "date": {
* "value": "2017-04-01"
* },
* "amount": {
* "value": 500
* },
* "month": {
* "value": "2017-03"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "date": {
* "value": "2017-04-12"
* },
* "amount": {
* "value": 500
* },
* "month": {
* "value": "2017-04"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "date": {
* "value": "2017-04-21"
* },
* "amount": {
* "value": 500
* },
* "month": {
* "value": "2017-04"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "date": {
* "value": "2017-05-01"
* },
* "amount": {
* "value": 500
* },
* "month": {
* "value": "2017-04"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "date": {
* "value": "2017-05-12"
* },
* "amount": {
* "value": 500
* },
* "month": {
* "value": "2017-05"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "date": {
* "value": "2017-05-21"
* },
* "amount": {
* "value": 500
* },
* "month": {
* "value": "2017-05"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "date": {
* "value": "2017-06-01"
* },
* "amount": {
* "value": 500
* },
* "month": {
* "value": "2017-05"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "date": {
* "value": "2017-06-12"
* },
* "amount": {
* "value": 500
* },
* "month": {
* "value": "2017-06"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "date": {
* "value": "2017-06-21"
* },
* "amount": {
* "value": 500
* },
* "month": {
* "value": "2017-06"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "date": {
* "value": "2017-07-01"
* },
* "amount": {
* "value": 500
* },
* "month": {
* "value": "2017-06"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "date": {
* "value": "2017-07-12"
* },
* "amount": {
* "value": 500
* },
* "month": {
* "value": "2017-07"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "date": {
* "value": "2017-07-21"
* },
* "amount": {
* "value": 500
* },
* "month": {
* "value": "2017-07"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "date": {
* "value": "2017-08-01"
* },
* "amount": {
* "value": 500
* },
* "month": {
* "value": "2017-07"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "date": {
* "value": "2017-08-12"
* },
* "amount": {
* "value": 750
* },
* "month": {
* "value": "2017-08"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "date": {
* "value": "2017-08-21"
* },
* "amount": {
* "value": 750
* },
* "month": {
* "value": "2017-08"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "date": {
* "value": "2017-09-01"
* },
* "amount": {
* "value": 750
* },
* "month": {
* "value": "2017-08"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "date": {
* "value": "2017-09-12"
* },
* "amount": {
* "value": 750
* },
* "month": {
* "value": "2017-09"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "date": {
* "value": "2017-09-21"
* },
* "amount": {
* "value": 750
* },
* "month": {
* "value": "2017-09"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "date": {
* "value": "2017-10-01"
* },
* "amount": {
* "value": 750
* },
* "month": {
* "value": "2017-09"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "date": {
* "value": "2017-10-12"
* },
* "amount": {
* "value": 750
* },
* "month": {
* "value": "2017-10"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "date": {
* "value": "2017-10-21"
* },
* "amount": {
* "value": 750
* },
* "month": {
* "value": "2017-10"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "date": {
* "value": "2017-11-01"
* },
* "amount": {
* "value": 750
* },
* "month": {
* "value": "2017-10"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "date": {
* "value": "2017-11-12"
* },
* "amount": {
* "value": 750
* },
* "month": {
* "value": "2017-11"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "date": {
* "value": "2017-11-21"
* },
* "amount": {
* "value": 750
* },
* "month": {
* "value": "2017-11"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "date": {
* "value": "2017-12-01"
* },
* "amount": {
* "value": 750
* },
* "month": {
* "value": "2017-11"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "date": {
* "value": "2017-12-12"
* },
* "amount": {
* "value": 750
* },
* "month": {
* "value": "2017-12"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "date": {
* "value": "2017-12-21"
* },
* "amount": {
* "value": 750
* },
* "month": {
* "value": "2017-12"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "date": {
* "value": "2018-01-01"
* },
* "amount": {
* "value": 750
* },
* "month": {
* "value": "2017-12"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "date": {
* "value": "2018-01-12"
* },
* "amount": {
* "value": 750
* },
* "month": {
* "value": "2018-01"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "date": {
* "value": "2018-01-21"
* },
* "amount": {
* "value": 750
* },
* "month": {
* "value": "2018-01"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* }
* ]
*/
history?: {
/**
* Employer who paid the Contribution.
*/
employer?: {
/**
* example:
* Crystal Horse Invest Pte Ltd
*/
value?: string;
};
/**
* Date of Contribution Paid. See "full-date" in http://xml2rfc.ietf.org/public/rfc/htm
*/
date?: {
/**
* example:
* 2017-03-01
*/
value?: string;
};
/**
* Month for which CPF Contribution was paid. Format: YYYY-MM
*/
month?: {
/**
* example:
* 2017-02
*/
value?: string;
};
/**
* Amount of contribution in SGD
*/
amount?: {
/**
* example:
* 500
*/
value?: number;
};
}[];
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* CPFEmployers
* Employers who paid CPF Contributions. Maximum up to past 14 months.
*
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
cpfemployers?: {
/**
* example:
* [
* {
* "month": {
* "value": "2016-11"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "month": {
* "value": "2016-12"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "month": {
* "value": "2016-12"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "month": {
* "value": "2016-12"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "month": {
* "value": "2017-01"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "month": {
* "value": "2017-01"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "month": {
* "value": "2017-01"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "month": {
* "value": "2017-02"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "month": {
* "value": "2017-02"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "month": {
* "value": "2017-02"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "month": {
* "value": "2017-03"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "month": {
* "value": "2017-03"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "month": {
* "value": "2017-03"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "month": {
* "value": "2017-04"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "month": {
* "value": "2017-04"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "month": {
* "value": "2017-04"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "month": {
* "value": "2017-05"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "month": {
* "value": "2017-05"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "month": {
* "value": "2017-05"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "month": {
* "value": "2017-06"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "month": {
* "value": "2017-06"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "month": {
* "value": "2017-06"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "month": {
* "value": "2017-07"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "month": {
* "value": "2017-07"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "month": {
* "value": "2017-07"
* },
* "employer": {
* "value": "Crystal Horse Invest Pte Ltd"
* }
* },
* {
* "month": {
* "value": "2017-08"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "month": {
* "value": "2017-08"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "month": {
* "value": "2017-08"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "month": {
* "value": "2017-09"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "month": {
* "value": "2017-09"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "month": {
* "value": "2017-09"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "month": {
* "value": "2017-10"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "month": {
* "value": "2017-10"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "month": {
* "value": "2017-10"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "month": {
* "value": "2017-11"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "month": {
* "value": "2017-11"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "month": {
* "value": "2017-11"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "month": {
* "value": "2017-12"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "month": {
* "value": "2017-12"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "month": {
* "value": "2017-12"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "month": {
* "value": "2018-01"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* },
* {
* "month": {
* "value": "2018-01"
* },
* "employer": {
* "value": "Delta Marine Consultants PL"
* }
* }
* ]
*/
history?: {
/**
* Employer who paid the Contribution.
*/
employer?: {
/**
* example:
* Crystal Horse Invest Pte Ltd
*/
value?: string;
};
/**
* Month for which CPF Contribution was paid. Format: YYYY-MM
*/
month?: {
/**
* example:
* 2017-03
*/
value?: string;
};
}[];
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* CPFBalances
* CPF Balances of Person in SGD.
*
* 'ra' will not appear in the results if user does not have a Retirement Account.
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
cpfbalances?: {
/**
* Amount Balance in CPF-MA
*/
ma?: {
/**
* example:
* 11470.71
*/
value?: number;
};
/**
* Amount Balance in CPF-OA
*/
oa?: {
/**
* example:
* 1581.48
*/
value?: number;
};
/**
* Amount Balance in CPF-SA
*/
sa?: {
/**
* example:
* 21967.09
*/
value?: number;
};
/**
* Amount Balance in CPF-RA
*/
ra?: {
/**
* example:
* 0.01
*/
value?: number;
};
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* CPFHousingWithdrawal
* CPF Housing Withdrawal of Person. Amounts in SGD.
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
cpfhousingwithdrawal?: {
/**
* Withdrawal details for properties
*/
withdrawaldetails?: {
/**
* Registered Address of Property which withdrawal is made.
*
* **Note:**
* - address can be either Singapore address (type: 'SG') or non Singapore address (type: 'UNFORMATTED')
* - check the `type` discriminator property to differentiate between the two address formats
*
*/
address?: AddressSG | /* Address details (Non-Singapore Format) */ AddressUnformatted;
/**
*
*/
accruedinterestamt?: {
/**
* example:
* 1581.48
*/
value?: number;
};
/**
*
*/
monthlyinstalmentamt?: {
/**
* example:
* 1196.09
*/
value?: number;
};
/**
*
*/
principalwithdrawalamt?: {
/**
* example:
* 2897.01
*/
value?: number;
};
/**
*
*/
totalamountofcpfallowedforproperty?: {
/**
* example:
* 10000.01
*/
value?: number;
};
}[];
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* CPF Home Protection Scheme
* CPF Home Protection Scheme
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
cpfhomeprotectionscheme?: {
coverage?: {
/**
* Indicator
* example:
* true
*/
value?: boolean;
};
premium?: {
/**
* Coverage premium. OPTIONAL attribute, present only if 'coverage' is true
* example:
* 100.01
*/
value?: number;
};
shareofcover?: {
/**
* Share of coverage (in percentage). OPTIONAL attribute, present only if 'coverage' is true
* example:
* 20
*/
value?: number;
};
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* CPF Dependant Protection Scheme
* CPF Dependant Protection Scheme
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
cpfdependantprotectionscheme?: {
coverage?: {
/**
* Indicator
* example:
* true
*/
value?: boolean;
};
insurercode?: {
/**
* Insurer Code
* example:
* 9GEL
*/
value?: string;
};
sumassuredamount?: {
/**
* Sum assured. OPTIONAL attribute, present only if 'coverage' is true
* example:
* 70000
*/
value?: number;
};
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
};
/**
* CPFInvestmentScheme
* CPF Investment Scheme.
*/
cpfinvestmentscheme?: {
/**
* Quantity of Special Discounted Shares shares held
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
sdsnetshareholdingqty?: {
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
/**
* example:
* 1360
*/
value?: number;
};
/**
* CPF Investment Account Details
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
account?: {
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
/**
* Agent Bank Code
*/
agentbankcode?: {
/**
* example:
* OCBC
*/
value?: string;
};
/**
* Account Number
*/
invbankacctno?: {
/**
* example:
* 098-26644-4
*/
value?: string;
};
};
/**
* Status of Self-Awareness Questionnaire Participation.
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
saqparticipationstatus?: {
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
/**
* Possible values:
*
* 'Y' – Participated
* 'X' – Existing CPFIS participant
* 'N' – Did not participate
* example:
* X
*/
code?: "Y" | "X" | "N";
/**
* example:
* Participated
*/
desc?: string;
};
};
}
interface PhoneNumLocal {
/**
* Prefix of Phone Number. Defaults to '+'. If phone number is blank, prefix will be returned as blank.
*/
prefix?: {
/**
* example:
* +
*/
value?: string;
};
/**
* Area Code of Phone Number. Default to '65'. If phone number is blank, code will be returned as blank.
*/
areacode?: {
/**
* example:
* 65
*/
value?: string;
};
/**
* Phone Number.
*/
nbr?: {
/**
* example:
* 66132665
*/
value?: string;
};
}
interface Pioneergen {
eligibility: {
value: boolean;
};
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14
*/
lastupdated: string;
quantum: {
value: string;
};
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Message code
*
* '1' - PG Eligibility Tag: N
* '2' - PG Eligibility Tag: Y, Sign-up Tag: Y, Invalid Address Tag: N
* '3' - PG Eligibility Tag: Y, Sign-up Tag: Y, Invalid Address Tag: Y
* '4' - PG Eligibility Tag: Y, Sign-up Tag: N, Invalid Address Tag: N
* '5' - PG Eligibility Tag: Y, Sign-up Tag: N, Invalid Address Tag: Y
* '6' - PG Eligibility Tag: Y, Opt-Out Tag: Y
* '7' - PG Eligibility Tag: Y, Sign-up Tag: Y, NIL Status: Y
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
message: {
code: "1" | "2" | "3" | "4" | "5" | "6" | "7";
desc: "We regret that you are not eligible for the Pioneer Generation Package. For further enquiries, please contact 1800-2222-888." | "You are eligible for the Pioneer Generation Package. For further enquiries, please contact 1800-2222-888." | "You are eligible for the Pioneer Generation Package. Please contact 1800-2222-888 to receive your Pioneer Generation card." | "You are eligible for the Pioneer Generation Package. Please contact 1800-2222-888 to start receiving your Pioneer Generation benefits, such as your MediSave top-up." | "You are eligible for the Pioneer Generation Package. Please contact 1800-2222-888 to start receiving your Pioneer Generation benefits." | "We understand that you have opted out of receiving the benefits under the Pioneer Generation Package. For further enquiries, please contact 1800-2222-888." | "Please call 1800-2222-888 to start receiving your PG benefits.";
};
}
/**
* Race
* Race of Person.
*
* Refer to the [Code reference tables](#section/Support) in the Support section for list of possible values.
*/
interface Race {
/**
* example:
* CN
*/
code?: string;
/**
* example:
* CHINESE
*/
desc?: string;
}
/**
* RegAdd
* Registered Address of Person (including FIN holders)
*
* **Note:**
* - address can be either a Singapore address (type: 'SG') or non Singapore address (type: 'UNFORMATTED')
* - check the `type` discriminator property to differentiate between the two address formats
* - may be unavailable for some FIN holders
*/
type Regadd =
/**
* RegAdd
* Registered Address of Person (including FIN holders)
*
* **Note:**
* - address can be either a Singapore address (type: 'SG') or non Singapore address (type: 'UNFORMATTED')
* - check the `type` discriminator property to differentiate between the two address formats
* - may be unavailable for some FIN holders
*/
/**
* Address details (Singapore Format)
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
DataitemAddressSg
/**
* Address details (Non-Singapore Format)
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
| DataitemAddressUnformatted;
/**
* ResidentialStatus
* Residential Status of Person. Applicable to Singapore Citizens and Permanent Residents.
*
*
* **Note:** This data item is not applicable for FIN holders i.e. `source` will be '3'.
* In such cases, the `code` and `desc` properties will be blank or empty string ("").
*
* A - ALIEN
* C - CITIZEN
* P - PR
* U - UNKNOWN
* N - NOT APPLICABLE
* < BLANK > (for FIN holders only)
*/
interface Residentialstatus {
/**
* example:
* C
*/
code?: "A" | "C" | "P" | "U" | "N" | "";
/**
* example:
* CITIZEN
*/
desc?: "ALIEN" | "CITIZEN" | "PR" | "UNKNOWN" | "NOT APPLICABLE" | "";
}
/**
* SchoolName
* Name of School of Person.
*/
interface Schoolname {
/**
* Code value of school name.
*
* **Note:** Code+desc and value are mutually exclusive.
* example:
* T07GS3011J
*/
code?: string;
/**
* Name of school represented by 'code'
*
* **Note:** Code+desc and value are mutually exclusive.
* example:
* SIGLAP SECONDARY SCHOOL
*/
desc?: string;
/**
* Free text value of school name.
*
* **Note:** Code+desc and value are mutually exclusive.
* example:
*
*/
value?: string;
}
/**
* SecondaryRace
* Secondary Race of Person.
*
* Refer to the [Code reference tables](#section/Support) in the Support section for list of possible values.
*/
interface Secondaryrace {
/**
*
* example:
* EU
*/
code?: string;
/**
*
* example:
* EURASIAN
*/
desc?: string;
}
/**
* Sex
* Sex of Person.
* 'F' - FEMALE
* 'M' - MALE
* 'U' - UNKNOWN
*/
interface Sex {
/**
* example:
* F
*/
code?: "F" | "M" | "U";
/**
*
* example:
* FEMALE
*/
desc?: "FEMALE" | "MALE" | "UNKNOWN";
}
/**
* SilverSupport
* Silver Support Scheme details
*/
interface Silversupport {
/**
* Eligibility
*/
eligibility?: {
/**
* example:
* true
*/
value?: boolean;
};
/**
* Amount eligible for
*/
amount?: {
/**
* example:
* 300
*/
value?: number;
};
/**
* Year given
*/
year?: {
/**
* Value of data field. See "date-fullyear" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14
* example:
* 2019
*/
value?: string;
};
}
/**
* example:
* {
* "classification": "C",
* "source": "1",
* "lastupdated": "2019-03-26"
* }
*/
interface Sponsoredchildrenrecords {
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
/**
* NRIC/FIN of child
*/
nric?: {
/**
* example:
* S5562882C
*/
value?: string;
};
/**
* Full Name of child
*/
name?: {
/**
* example:
* Jo Tan Pei Ni
*/
value?: string;
};
/**
* Han Yu Pin Yin name of child.
*/
hanyupinyinname?: {
/**
* example:
* Cheng Pei Ni
*/
value?: string;
};
/**
* Alias name of child.
*/
aliasname?: {
/**
* example:
*
*/
value?: string;
};
/**
* Han Yu Pin Yin Alias name of child.
*/
hanyupinyinaliasname?: {
/**
* example:
*
*/
value?: string;
};
/**
* Married name of child.
*/
marriedname?: {
/**
* example:
*
*/
value?: string;
};
/**
* Sex of child. Possible values:
*
* 'F' - FEMALE
* 'M' - MALE
* 'U' - UNKNOWN
*/
sex?: {
/**
* example:
* F
*/
code?: "F" | "M" | "U";
/**
* example:
* FEMALE
*/
desc?: "FEMALE" | "MALE" | "UNKNOWN";
};
/**
* Race of child.
*
* Refer to the [Code reference tables](#section/Support) in the Support section for list of possible values.
*/
race?: {
/**
* example:
* CN
*/
code?: string;
/**
* example:
* CHINESE
*/
desc?: string;
};
/**
* Secondary Race of child.
*
* Refer to the [Code reference tables](#section/Support) in the Support section for list of possible values.
*/
secondaryrace?: {
/**
* example:
*
*/
code?: string;
/**
* example:
*
*/
desc?: string;
};
/**
* Dialect of child.
*
* Refer to the [Code reference tables](#section/Support) in the Support section for list of possible values.
*/
dialect?: {
/**
* example:
* HK
*/
code?: string;
/**
* example:
* HOKKIEN
*/
desc?: string;
};
/**
* Date of Birth of child.
*
* See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14
*/
dob?: {
/**
* example:
* 2011-09-10
*/
value?: string;
};
/**
* BirthCountry
* Country/Place of Birth of child.
*
* Refer to the [Code reference tables](#section/Support) in the Support section for list of possible values.
*/
birthcountry?: {
/**
* example:
* SG
*/
code?: string;
/**
* example:
* SINGAPORE
*/
desc?: string;
};
/**
* Life Status of child. Possible values:
*
* A - ALIVE
* D - DECEASED
*/
lifestatus?: {
/**
* example:
* A
*/
code?: "A" | "D";
/**
* example:
* ALIVE
*/
desc?: "ALIVE" | "DECEASED";
};
/**
* ResidentialStatus
* Residential Status of child. Possible values:
*
* A - ALIEN
* C - CITIZEN
* P - PR
* U - UNKNOWN
* N - NOT APPLICABLE
*/
residentialstatus?: {
/**
* example:
* C
*/
code?: "A" | "C" | "P" | "U" | "N";
/**
* example:
* Citizen
*/
desc?: "ALIEN" | "CITIZEN" | "PR" | "UNKNOWN" | "NOT APPLICABLE";
};
/**
* Nationality/Citizenship of child.
*
* Refer to the [Code reference tables](#section/Support) in the Support section for list of possible values.
*/
nationality?: {
/**
* example:
* SG
*/
code?: string;
/**
* example:
* SINGAPORE CITIZEN
*/
desc?: string;
};
/**
* Date granted Singapore Citizenship, Permanent Resident or Long-term Visit Pass
*
* See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14
*/
scprgrantdate?: {
/**
* example:
* 2015-06-13
*/
value?: string;
};
vaccinationrequirements?: {
/**
* Vaccination Requirement
*
* Refer to the [Code reference tables](#section/Support) in the Support section for list of possible values.
*/
requirement?: {
/**
* example:
* 1M3D
*/
code?: string;
/**
* example:
* MINIMUM VACCINATION REQUIREMENT FOR PRESCHOOL
*/
desc?: string;
};
fulfilled?: {
/**
* example:
* true
*/
value?: boolean;
};
}[];
}
/**
* UINFIN
* Singapore issued identification number of the Person.
*/
interface Uinfin {
/**
* value of the field, should be displayed as it is.
* example:
* S1111111D
*/
value?: string;
}
type Vehicles = {
/**
* Data classification of data field. Default 'C' - Confidential.
*/
classification: "C";
/**
* Source of data.
*
* '1' - Government-verified
* '2' - User provided
* '3' - Field is Not Applicable to Person
* '4' - Verified by SingPass
*
* **Note:** All Government-verified fields must be **non-editable** on your digital service form (some exceptions apply - see individual field descriptions).
*/
source: "1" | "2" | "3" | "4";
/**
* Last updated date of data field. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14. Can be blank if the source agency does not have record for the user.
*/
lastupdated: string;
/**
* Optional flag to indicate if data is unavailable from data source.
*
* **NOTE:**
* - This optional property will be only present with value `true` if there is no data available from the data source; i.e. record not found.
* - When this flag is `true`, no other data attributes will be present (other than `classification`, `source`, and `lastupdated`).
* - If data is available from the data source, this property will not be present.
*
*/
unavailable?: boolean;
/**
* Vehicle Registration Number displayed on the vehicle number plates
*/
vehicleno?: {
/**
* example:
* SDF1235A
*/
value?: string;
};
/**
* Type of Vehicles such as 'MOTOR CAR', 'STATION /WAGON/JEEP/LAND ROVER'
*/
type?: {
/**
* example:
* PASSENGER MOTOR CAR
*/
value?: string;
};
/**
* In-Vehicle Unit (IU) number of the device fitted in Singapore-registered vehicles for Electronic Road Pricing (ERP) gantries and Electronic Parking System (EPS) car parks.
*/
iulabelno?: {
/**
* example:
*
*/
value?: string;
};
/**
* Vehicle Make such as 'TOYOTA', 'HONDA', 'AUDI'
*/
make?: {
/**
* example:
* TOYOTA
*/
value?: string;
};
/**
* Vehicle Model such as 'COROLLA ALTIS CLASSIC 1.6 CVT', 'HRV 1.5 DX CVT'
*/
model?: {
/**
* example:
* COROLLA ALTIS
*/
value?: string;
};
/**
* Vehicle Chassis Number
*/
chassisno?: {
/**
* example:
* ZC11S1735800
*/
value?: string;
};
/**
* Vehicle Engine Number
*/
engineno?: {
/**
* example:
* M13A1837453
*/
value?: string;
};
/**
* Vehicle Motor Number
*/
motorno?: {
/**
* example:
*
*/
value?: string;
};
/**
* Manufacturing year
*/
yearofmanufacture?: {
/**
* example:
* 2010
*/
value?: string;
};
/**
* Date when vehicle is registered with LTA. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14'
*/
firstregistrationdate?: {
/**
* example:
* 2010-06-06
*/
value?: string;
};
/**
* Date when vehicle is first registered in the country of origin. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14'
*/
originalregistrationdate?: {
/**
* example:
* 2010-06-06
*/
value?: string;
};
/**
* Vehicle Certificate of Entitlement (COE) bid category
*/
coecategory?: {
/**
* example:
* A - CAR UP TO 1600CC & 97KW (130BHP)
*/
value?: string;
};
/**
* Vehicle Certificate of Entitlement (COE) expiry date. See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14'
*/
coeexpirydate?: {
/**
* example:
* 2020-06-05
*/
value?: string;
};
/**
* See "full-date" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14'
*/
roadtaxexpirydate?: {
/**
* example:
* 2020-06-05
*/
value?: string;
};
/**
* Actual Quota Premium (QP) amount payable for the COE upon registration, conversion or COE revalidation in Singapore dollars (SGD). For renewal of COE, the value will contain actual PQP paid.
*/
quotapremium?: {
/**
* example:
* 14000.01
*/
value?: number;
};
/**
* Open Market Value is the value of manufacturer invoice price, freight and insurance in Singapore dollars (SGD).
*/
openmarketvalue?: {
/**
* example:
* 25000.01
*/
value?: number;
};
/**
* CO2 emission rate
*/
co2emission?: {
/**
* example:
* 146.01
*/
value?: number;
};
/**
* Status of the Vehicle.
*
* 1 - LIVE
* 2 - DE-REGISTERED
*/
status?: {
/**
* example:
* 1
*/
code?: "1" | "2";
/**
* example:
* LIVE
*/
desc?: "LIVE" | "DE-REGISTERED";
};
/**
* Vehicle Primary Colour (e.g. BLACK)
*/
primarycolour?: {
/**
* example:
* BLACK
*/
value?: string;
};
/**
* Vehicle Primary Colour (e.g. WHITE)
*/
secondarycolour?: {
/**
* example:
* WHITE
*/
value?: string;
};
/**
* Vehicle Attachment 1 (e.g. DISABLED)
*/
attachment1?: {
/**
* example:
* DISABLED
*/
value?: string;
};
/**
* Vehicle Attachment 2 (e.g. WITH SUN ROOF)
*/
attachment2?: {
/**
* example:
* WITH SUN ROOF
*/
value?: string;
};
/**
* Vehicle Attachment 3 (e.g. SIDE CURTAIN)
*/
attachment3?: {
/**
* example:
* SIDE CURTAIN
*/
value?: string;
};
/**
* Vehicle Scheme (e.g. REVISED OFF-PEAK CAR)
*/
scheme?: {
/**
* example:
* REVISED OFF-PEAK CAR
*/
value?: string;
};
/**
* Total Hydro Carbon (THC) emission rate
*/
thcemission?: {
/**
* example:
* 1.011001
*/
value?: number;
};
/**
* Carbon Monoxide emission rate
*/
coemission?: {
/**
* example:
* 1.100001
*/
value?: number;
};
/**
* Nitrogen Oxide (NOx) emission rate.
*/
noxemission?: {
/**
* example:
* 0.011001
*/
value?: number;
};
/**
* Particulates (PM - Atmospheric Particulate Matter) emission rate.
*/
pmemission?: {
/**
* example:
* 0.007
*/
value?: number;
};
/**
* Engine Capacity in cubic centimeter (cc)
*/
enginecapacity?: {
/**
* example:
* 1600
*/
value?: number;
};
/**
* Power Rate. Applicable to Electric and Hybrid vehicles powered by electric motors. Unit is Kilowatt.
*/
powerrate?: {
/**
* example:
* 1.41
*/
value?: number;
};
/**
* Effective Date/Time of Ownership. See "date-time" in http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14'
*/
effectiveownership?: {
/**
* example:
* 2010-08-31T20:12:12+08:00
*/
value?: string;
};
/**
* Propellant (e.g. Compressed Natural Gas, Diesel, Diesel-CNG, Diesel-Electric, Diesel-Electric (Plug-In), Electric, Gas, Liquefied Petroleum Gas (LPG), Petrol, Petrol-CNG, Petrol-Electric, Petrol-Electric (Plug-In), Petrol-LPG
*/
propellant?: {
/**
* example:
* Compressed Natural Gas
*/
value?: string;
};
/**
* Maximum Unladen Weight in kilograms (kg)
*/
maximumunladenweight?: {
/**
* example:
* 1500
*/
value?: number;
};
/**
* Maximum Laden Weight in kilograms (kg)
*/
maximumladenweight?: {
/**
* example:
* 1795
*/
value?: number;
};
/**
* Minimum PARF Benefit in Singapore dollars (SGD).
*/
minimumparfbenefit?: {
/**
* example:
* 8770.01
*/
value?: number;
};
/**
* Number of Transfer
*/
nooftransfers?: {
/**
* example:
* 2
*/
value?: number;
};
/**
* Vehicle Parking Certificate. Applicable for Heavy Vehicles.
*/
vpc?: {
/**
* example:
* 1234567890
*/
value?: string;
};
}[];
}
}
//# sourceMappingURL=myinfo-domain.d.ts.map