Scopes
The following table shows the list of available scopes from Singpass that a relying party can request. The scopes that your application can access are determined during client registration.
Personal
| Scope | Name | Description | Data Available | Source |
|---|---|---|---|---|
hdbownership.noofowners | HDB Ownership - Number of Owners | Number of Owners. Note that this does not include executors, administrators or trustees. | SC,PR,FIN | HDB |
hdbownership.address | HDB Ownership - Address | Flat Address. | SC,PR,FIN | HDB |
hdbownership.hdbtype | HDB Ownership - Type of HDB Dwelling | HDB Flat Type. Refer to Code Listing (HDBTypeCode)(.XLSX, 84KB) for list of possible values. | SC,PR,FIN | HDB |
hdbownership.leasecommencementdate | HDB Ownership - Lease Commencement Date | Lease Period Start Date. | SC,PR,FIN | HDB |
hdbownership.termoflease | HDB Ownership - Term of Lease | Term of lease for the property computed from the lease commencement date. | SC,PR,FIN | HDB |
hdbownership.dateofpurchase | HDB Ownership - Date of Purchase | Effective Date of flat purchase. | SC,PR,FIN | HDB |
hdbownership.dateofownershiptransfer | HDB Ownership - Date of Transfer of Ownership | 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. | SC,PR,FIN | HDB |
hdbownership.loangranted | HDB Ownership - Loan Granted | The amount of housing loan granted to owner(s) by HDB. | SC,PR,FIN | HDB |
hdbownership.originalloanrepayment | HDB Ownership - Original Loan Repayment Period | The number of years for loan repayment opted by owner(s) at the time the loan is first granted to him/her. | SC,PR,FIN | HDB |
hdbownership.balanceloanrepayment | HDB Ownership - Balance Loan Repayment Period | The remaining number of year(s) and month(s) available to repay the loan. | SC,PR,FIN | HDB |
hdbownership.outstandingloanbalance | HDB Ownership - Outstanding HDB Loan Balance | Outstanding amount payable to HDB. | SC,PR,FIN | HDB |
hdbownership.monthlyloaninstalment | HDB Ownership - Monthly Loan Instalment | Monthly instalment payable to HDB. | SC,PR,FIN | HDB |
hdbownership.purchaseprice | HDB Ownership - Purchase Price | This refers to the price at which the flat owner paid for the flat. | SC,PR,FIN | HDB |
hdbownership.outstandinginstalment | HDB Ownership - Outstanding Instalment | This refers to the outstanding instalment owed by the flat owner(s) which includes the current month instalment. GST is not applicable. If there is advance payment, the value will be 0. | SC,PR,FIN | HDB |
Finance
| Scope | Name | Description | Data Available | Source |
|---|---|---|---|---|
cpfbalances | CPF Account Balance | The Central Provident Fund is a mandatory social security savings scheme funded by contributions from employers and employees. The CPF balance would include Ordinary Account (OA), Special Account (SA), Medisave Account (MA) and Retirement Account (RA) if applicable to the user. Note these values could be negative. Click here to refer to the CPF display guidelines. | SC,PR | CPFB |
cpfcontributions | CPF Contribution History (up to 15 months) | The Central Provident Fund is a mandatory social security savings scheme funded by contributions from employers and employees. For each contribution record, the 4 fields (Paid for Month, Paid On, Employer Name, Contribution Total) will be provided. Only Contribution(s) related to employment will be provided. Other contributions, such as self-employed or government top-ups, are presently excluded. CPF will return the contributions received (or paid on) in the past 15 months up to the preceding month. Note that a member could have multiple contributions per month from the same employer. 1. Example 1: If the query is made in March-24, contribution provided will be for contribution received in the period from January-23 to March-24 (inclusive). This is provided that March-24 contribution had been received, else contribution provided will be January-23 to February-24 2. Example 2: Assuming a member has a late CPF contribution for work done in Nov-22 (beyond January-23 to March-24) that was credited only in Jan-23. If the query is made in March-24, contribution provided will include the late contribution as it was received in the period from January-23 to March-24. The contribution period range of January-23 to March-24 (inclusive) remains. Click here to refer to the CPF display guidelines. | SC,PR | CPFB |
cpfhousingwithdrawal | CPF Housing Withdrawal | The Central Provident Fund is a mandatory social security savings scheme funded by contributions from employers and employees. The CPF Housing Withdrawal data include the following for the purpose of financing a HDB flat or private residential property: a) Address: This is the registered address of property for which withdrawal is made b) Principal Withdrawal Amount: This is the CPF principal amount user has withdrawn under the CPF housing schemes c) Monthly Instalment Amount: This is the monthly CPF deduction for payment of user's property d) Accrued Interest Amount: This is the interest that user would have earned had user's savings remained in the CPF account. e) Total Amount of CPF Allowed for Property: The maximum CPF savings allowed to be used for the financing the property, excluding the amount used for stamp duty and legal fees. | SC,PR | CPFB |
noa-basic | Notice of Assessment (Basic, Latest Year) | This refers to the taxpayer's total income after deducting allowable expenses and approved donations. Total income includes: (i) Trade (ii) Employment (iii) Rent (iv) Interest This field will only return: (i) 1 yearly assessable income and (ii) the corresponding year value. The yearly assessable income will be the latest available income up to the last 2 Years of Assessments. If the subscriber does not have any assessment record for up to 2 back years, Myinfo will return the following: a) Assessable Income= 'NA' or '-' b) Year Assessed='NA'. To note: i. Assessable Income details is only available for finalised assessment. Thus, income information will not be available if the subscriber has a Default Assessment (e.g. taxpayers who have not submitted their tax return). ii. This may not be applicable for foreigners depending on their tax residency. For example, in the case of double tax treaties with other countries, foreigner may not need to pay Singapore tax. | SC,PR,FIN | IRAS |
noahistory-basic | Notice of Assessment (Basic, Last 2 Years) | Similar to 'Notice of Assessment (Basic, Latest Year)' data field, but for the last 2 years instead. | SC,PR,FIN | IRAS |
noa | Notice of Assessment (Detailed, Latest Year) | Similar to 'Notice of Assessment (Basic, Latest Year)' data field, including the following income breakdown a) Employment b) Trade c) Rent d) Interest Additional details in this data field: a) Tax clearance : Indicator will be 'Y' for scenario where non-Singapore Citizen employee that ceases employment in Singapore, and goes on an overseas posting or plans to leave Singapore for more than three months. Only need to display this field if the value = 'Y'. b) Tax Category : Type of Income Tax Bill. For more details, click here. | SC,PR,FIN | IRAS |
noahistory | Notice of Assessment (Detailed, Last 2 Years) | Similar to 'Notice of Assessment (Basic, Latest Year)' data field, but for the last 2 years instead. | SC,PR,FIN | IRAS |
ownerprivate | Ownership of Private Residential Property | This refers to the ownership of private residential property. Note that this does not include shophouses which are assessed as commercial properties. This field will be 'Y', if the corresponding NRIC/FIN, in IRAS records, is a primarily, secondary or CC owner of an active private residential property and is required to pay property tax. Otherwise will be 'N' Where the NRIC/FIN is not found in IRAS records, it will be returned as 'NA'. | SC,PR,FIN | IRAS |
cpfinvestmentscheme.account | CPF Investment Scheme - Account | The Central Provident Fund is a mandatory social security savings scheme funded by contributions from employers and employees. CPF savings can be used in these investment schemes - CPF Investment Scheme (CPFIS) & Special Discounted Shares (SDS) Scheme. CPFIS account data includes Agent Bank under CPFIS-OA and Investment Account number which refer to the CPF Investment account that user has opened with one of the CPFIS-OA agent banks under the CPFIS. | SC,PR | CPFB |
cpfinvestmentscheme.sdsnetshareholdingqty | CPF Investment Scheme - Number of Discounted Singtel Shares | The Central Provident Fund is a mandatory social security savings scheme funded by contributions from employers and employees. CPF savings can be used in these investment schemes - CPF Investment Scheme (CPFIS) & Special Discounted Shares (SDS) Scheme. Number of Discounted Singtel Shares refers to the number of discounted Singtel shareholdings held under the SDS Scheme. | SC,PR | CPFB |
cpfinvestmentscheme.saqparticipationstatus | CPF Investment Scheme - Self-Awareness Questionnaire (SAQ) Participation Status | The Central Provident Fund is a mandatory social security savings scheme funded by contributions from employers and employees. CPF savings can be used in these investment schemes - CPF Investment Scheme (CPFIS) & Special Discounted Shares (SDS) Scheme. Self-Awareness Questionnaire (SAQ) Participation Status refers to whether the user has taken the CPFIS Self-Awareness Questionnaire (SAQ) to help assess if CPFIS is suitable for the user. | SC,PR | CPFB |
Employment and Education
| Scope | Name | Description | Data Available | Source |
|---|---|---|---|---|
employment | Name of Employer | FIN | MOM | |
occupation | Occupation | For FIN - Value will be returned in the description. | FIN | MOM |
cpfemployers | CPF Employers | Employer Name for the CPF Contribution. Includes contribution month/year. Only Contribution(s) related to employment will be provided. Other contributions, such as self-employed or government top-ups, are presently excluded. CPF will return the contributions received (or paid on) in the past 15 months up to the preceding month. Note that a member could have multiple contributions per month from the same employer. | SC,PR | CPFB |
academicqualifications.transcripts | Singapore-Cambridge Examination | Singapore-Cambridge (GCE N, O, A Levels) Examination results attained. _ | SC,PR,FIN | MOE |
academicqualifications.certificates | Singapore-Cambridge Examination (OpenCert) | Singapore-Cambridge (GCE N, O, A Levels) Examination results attained. Data to be returned in OpenCert format. Click here to find out about OpenCert format. | SC,PR,FIN | MOE |
ltavocationallicences.tdvl.licencename | LTA Vocational Licences - TDVL Licence Name | A Taxi Driver's Vocational Licence allows one to drive a taxi Licence Name of LTA Vocational Licence | SC,PR,FIN | LTA |
ltavocationallicences.tdvl.vocationallicencenumber | LTA Vocational Licences - TDVL Vocational Licence Number | A Taxi Driver's Vocational Licence allows one to drive a taxi Unique Vocational Licence Number for LTA Vocational Licence holder | SC,PR,FIN | LTA |
ltavocationallicences.tdvl.expirydate | LTA Vocational Licences - TDVL Expiry Date | A Taxi Driver's Vocational Licence allows one to drive a taxi Expiry date of LTA Vocational Licence | SC,PR,FIN | LTA |
ltavocationallicences.tdvl.status | LTA Vocational Licences - TDVL Status | A Taxi Driver's Vocational Licence allows one to drive a taxi Status of LTA Vocational Licence | SC,PR,FIN | LTA |
ltavocationallicences.pdvl.licencename | LTA Vocational Licences - PDVL Licence Name | A Private Hire Car Driver's Vocational Licence allows one to drive a private hire car Licence Name of LTA Vocational Licence | SC,PR,FIN | LTA |
ltavocationallicences.pdvl.vocationallicencenumber | LTA Vocational Licences - PDVL Vocational Licence Number | A Private Hire Car Driver's Vocational Licence allows one to drive a private hire car Unique Vocational Licence Number for LTA Vocational Licence holder | SC,PR,FIN | LTA |
ltavocationallicences.pdvl.expirydate | LTA Vocational Licences - PDVL Expiry Date | A Private Hire Car Driver's Vocational Licence allows one to drive a private hire car Expiry date of LTA Vocational Licence | SC,PR,FIN | LTA |
ltavocationallicences.pdvl.status | LTA Vocational Licences - PDVL Status | A Private Hire Car Driver's Vocational Licence allows one to drive a private hire car Status of LTA Vocational Licence | SC,PR,FIN | LTA |
ltavocationallicences.bavl.licencename | LTA Vocational Licences - BAVL Licence Name | A Bus Attendant's Vocational Licence allows one to work as a bus attendant on a school bus Licence Name of LTA Vocational Licence | SC,PR,FIN | LTA |
ltavocationallicences.bavl.vocationallicencenumber | LTA Vocational Licences - BAVL Vocational Licence Number | A Bus Attendant's Vocational Licence allows one to work as a bus attendant on a school bus Unique Vocational Licence Number for LTA Vocational Licence holder | SC,PR,FIN | LTA |
ltavocationallicences.bavl.expirydate | LTA Vocational Licences - BAVL Expiry Date | A Bus Attendant's Vocational Licence allows one to work as a bus attendant on a school bus Expiry date of LTA Vocational Licence | SC,PR,FIN | LTA |
ltavocationallicences.bavl.status | LTA Vocational Licences - BAVL Status | A Bus Attendant's Vocational Licence allows one to work as a bus attendant on a school bus Status of LTA Vocational Licence | SC,PR,FIN | LTA |
ltavocationallicences.bdvl.licencename | LTA Vocational Licences - BDVL Licence Name | A Bus Driver's Vocational Licence allows one to drive a private hire bus/excursion bus/ school bus Licence Name of LTA Vocational Licence | SC,PR,FIN | LTA |
ltavocationallicences.bdvl.vocationallicencenumber | LTA Vocational Licences - BDVL Vocational Licence Number | A Bus Driver's Vocational Licence allows one to drive a private hire bus/excursion bus/ school bus Unique Vocational Licence Number for LTA Vocational Licence holder | SC,PR,FIN | LTA |
ltavocationallicences.bdvl.expirydate | LTA Vocational Licences - BDVL Expiry Date | A Bus Driver's Vocational Licence allows one to drive a private hire bus/excursion bus/ school bus Expiry date of LTA Vocational Licence | SC,PR,FIN | LTA |
ltavocationallicences.bdvl.status | LTA Vocational Licences - BDVL Status | A Bus Driver's Vocational Licence allows one to drive a private hire bus/excursion bus/ school bus Status of LTA Vocational Licence | SC,PR,FIN | LTA |
ltavocationallicences.odvl.licencename | LTA Vocational Licences - ODVL Licence Name | An Omnibus Driver’s Vocational Licence allows one to drive an omnibus Licence Name of LTA Vocational Licence | SC,PR,FIN | LTA |
ltavocationallicences.odvl.vocationallicencenumber | LTA Vocational Licences - ODVL Vocational Licence Number | An Omnibus Driver’s Vocational Licence allows one to drive an omnibus Unique Vocational Licence Number for LTA Vocational Licence holder | SC,PR,FIN | LTA |
ltavocationallicences.odvl.expirydate | LTA Vocational Licences - ODVL Expiry Date | An Omnibus Driver’s Vocational Licence allows one to drive an omnibus Expiry date of LTA Vocational Licence | SC,PR,FIN | LTA |
ltavocationallicences.odvl.status | LTA Vocational Licences - ODVL Status | An Omnibus Driver’s Vocational Licence allows one to drive an omnibus Status of LTA Vocational Licence | SC,PR,FIN | LTA |
Family
| Scope | Name | Description | Data Available | Source |
|---|---|---|---|---|
marital | Marital Status | Marital status is based on records that had been reasonably verified by the relevant Government agency upon receipt.<br/><br/>Marital Status must be made editable at digital services even though data source is MSF.<br/><br/>Refer to <a href='https://public.cloud.myinfo.gov.sg/dpp/frontend/assets/api-lib/myinfo/downloads/myinfo-api-code-tables.xlsx' target='_blank'>Code Listing (MaritalStatusCode)</a> for list of possible values | SC,PR | MSF |
marriagedate | Marriage Date | Marriage Date refers to the latest date of most recent Marriage.<br/><br/>Note that Marriage Date shall be made editable at digital services even though data source is MSF. | SC,PR | MSF |
marriagecertno | Marriage Certificate Number | This refers to the certificate number of the latest marriage.<br/><br/>Note that Marriage Certificate Number shall be made editable at digital services even though data source is MSF. | SC,PR | MSF |
countryofmarriage | Country/Place of Marriage | This refers to the country/place of the latest marriage. <br><br>Note that Marriage Country/Place shall be made editable at digital services even though data source is MSF. <br/><br/>Refer to <a href='https://public.cloud.myinfo.gov.sg/dpp/frontend/assets/api-lib/myinfo/downloads/myinfo-api-code-tables.xlsx' target='_blank'>Code Listing (CountryPlaceCode)</a> for list of possible values. | SC,PR | MSF |
divorcedate | Divorce Date | Divorce Date refers to the latest date of most recent Divorce.<br/><br/>Note that Divorce Date shall be made editable at digital services even though data source is MSF. | SC,PR | MSF |
childrenbirthrecords.birthcertno | Children Birth Records - Birth Cert Number | Birth Certificate Number is the unique identifier given for births in Singapore.<br><br>Note that the records are only based on ICA's electronic birth certificate records from 1985 onwards. | SC,PR,FIN | ICA |
childrenbirthrecords.name | Children Birth Records - Name | Name displayed on the Birth Certificate.<br><br>This field will only be returned if the child's age is below 21. | SC,PR,FIN | ICA |
childrenbirthrecords.aliasname | Children Birth Records - Alias Name | Alias Name displayed on the Birth Certificate.<br><br>This field will only be returned if the child's age is below 21. | SC,PR,FIN | ICA |
childrenbirthrecords.hanyupinyinname | Children Birth Records - Hanyu Pinyin Name | Hanyu Pinyin Name displayed on the Birth Certificate.<br><br>This field will only be returned if the child's age is below 21. | SC,PR,FIN | ICA |
childrenbirthrecords.hanyupinyinaliasname | Children Birth Records - Hanyu Pinyin Alias Name | Hanyu Pinyin Alias Name displayed on the Birth Certificate.<br><br>This field will only be returned if the child's age is below 21. | SC,PR,FIN | ICA |
childrenbirthrecords.marriedname | Children Birth Records - Married Name | Married Name displayed on the Birth Certificate.<br><br>This field will only be returned if the child's age is below 21. | SC,PR,FIN | ICA |
childrenbirthrecords.sex | Children Birth Records - Sex | Gender of the child.<br><br>Refer to <a href='https://public.cloud.myinfo.gov.sg/dpp/frontend/assets/api-lib/myinfo/downloads/myinfo-api-code-tables.xlsx' target='_blank'>Code Listing (SexCode)</a>(.XLSX, 84KB) for list of possible values.<br><br>This field will only be returned if the child's age is below 21. | SC,PR,FIN | ICA |
childrenbirthrecords.race | Children Birth Records - Race | Race of the child.<br><br>Refer to <a href='https://public.cloud.myinfo.gov.sg/dpp/frontend/assets/api-lib/myinfo/downloads/myinfo-api-code-tables.xlsx' target='_blank'>Code Listing (RaceCode)</a>(.XLSX, 84KB) for list of possible values.<br><br>This field will only be returned if the child's age is below 21. | SC,PR,FIN | ICA |
childrenbirthrecords.secondaryrace | Children Birth Records - Secondary Race | Secondary Race of the child.<br><br>Refer to <a href='https://public.cloud.myinfo.gov.sg/dpp/frontend/assets/api-lib/myinfo/downloads/myinfo-api-code-tables.xlsx' target='_blank'>Code Listing (RaceCode)</a>(.XLSX, 84KB) for list of possible values.<br><br>This field will only be returned if the child's age is below 21. | SC,PR,FIN | ICA |
childrenbirthrecords.dob | Children Birth Records - Date of Birth | This field will only be returned if the child's age is below 21. | SC,PR,FIN | ICA |
childrenbirthrecords.tob | Children Birth Records - Time of Birth | This field will only be returned if the child's age is below 21. | SC,PR,FIN | ICA |
childrenbirthrecords.dialect | Children Birth Records - Dialect | Refer to <a href='https://public.cloud.myinfo.gov.sg/dpp/frontend/assets/api-lib/myinfo/downloads/myinfo-api-code-tables.xlsx' target='_blank'>Code Listing (DialectCode)</a>(.XLSX, 84KB) for list of possible values.<br><br>This field will only be returned if the child's age is below 21. | SC,PR,FIN | ICA |
childrenbirthrecords.lifestatus | Children Birth Records - Life Status | Indicates the life status of the child.<br><br>This field will only be returned if the child's age is below 21. | SC,PR,FIN | ICA |
childrenbirthrecords.sgcitizenatbirthind | Children Birth Records - Singapore Citizen at Birth Indicator | Indicates whether the child is a Singapore Citizen at the time of birth.<br><br>This field will only be returned if the child's age is below 21. | SC,PR,FIN | ICA |
childrenbirthrecords.vaccinationrequirements | Children Birth Records - Child Vaccination | <p>The Child Vaccination data include the following: <br/><br/> a) Child Vaccination Requirement Fulfilled: This refers to whether a child has fulfilled the preschool vaccination minimum requirements. This data is based on Health Promotion Board (HPB) National Immunisation Registry (NIR) records where the child is born from 2014 onwards. <br/><br/> b) Child Vaccination Requirement Code: Refer to <a href='https://public.cloud.myinfo.gov.sg/dpp/frontend/assets/api-lib/myinfo/downloads/myinfo-api-code-tables.xlsx' target='_blank'>Code Listing (ChildVaccReqCode)</a> for list of possible values. </p> | SC,PR,FIN | HPB |
sponsoredchildrenrecords.nric | Sponsored Children Records - NRIC / FIN | NRIC / FIN is the unique identifier given to sponsor child whom have obtained citizenship or permanent residency or long-term visit pass via sponsorship by their parents. | SC,PR | ICA |
sponsoredchildrenrecords.name | Sponsored Children Records - Name | Name of the Sponsored Child.<br><br>This field will only be returned if the child's age is below 21. | SC,PR | ICA |
sponsoredchildrenrecords.aliasname | Sponsored Children Records - Alias Name | Alias Name of the Sponsored Child.<br><br>This field will only be returned if the child's age is below 21. | SC,PR | ICA |
sponsoredchildrenrecords.hanyupinyinname | Sponsored Children Records - Hanyu Pinyin Name | Hanyu Pinyin Name of the Sponsored Child.<br><br>This field will only be returned if the child's age is below 21. | SC,PR | ICA |
sponsoredchildrenrecords.hanyupinyinaliasname | Sponsored Children Records - Hanyu Pinyin Alias Name | Hanyu Pinyin Alias Name of the Sponsored Child.<br><br>This field will only be returned if the child's age is below 21. | SC,PR | ICA |
sponsoredchildrenrecords.marriedname | Sponsored Children Records - Married Name | Married Name of the Sponsored Child.<br><br>This field will only be returned if the child's age is below 21. | SC,PR | ICA |
sponsoredchildrenrecords.sex | Sponsored Children Records - Sex | Gender of the Sponsored Child.<br><br>Refer to <a href='https://public.cloud.myinfo.gov.sg/dpp/frontend/assets/api-lib/myinfo/downloads/myinfo-api-code-tables.xlsx' target='_blank'>Code Listing (SexCode)</a>(.XLSX, 84KB) for list of possible values.<br><br>This field will only be returned if the child's age is below 21. | SC,PR | ICA |
sponsoredchildrenrecords.race | Sponsored Children Records - Race | Race of the Sponsored Child.<br><br>Refer to <a href='https://public.cloud.myinfo.gov.sg/dpp/frontend/assets/api-lib/myinfo/downloads/myinfo-api-code-tables.xlsx' target='_blank'>Code Listing (RaceCode)</a>(.XLSX, 84KB) for list of possible values.<br><br>This field will only be returned if the child's age is below 21. | SC,PR | ICA |
sponsoredchildrenrecords.secondaryrace | Sponsored Children Records - Secondary Race | Secondary Race of the Sponsored Child.<br><br>Refer to <a href='https://public.cloud.myinfo.gov.sg/dpp/frontend/assets/api-lib/myinfo/downloads/myinfo-api-code-tables.xlsx' target='_blank'>Code Listing (RaceCode)</a>(.XLSX, 84KB) for list of possible values.<br><br>This field will only be returned if the child's age is below 21. | SC,PR | ICA |
sponsoredchildrenrecords.dialect | Sponsored Children Records - Dialect | Refer to <a href='https://public.cloud.myinfo.gov.sg/dpp/frontend/assets/api-lib/myinfo/downloads/myinfo-api-code-tables.xlsx' target='_blank'>Code Listing (DialectCode)</a>(.XLSX, 84KB) for list of possible values. | SC,PR | ICA |
sponsoredchildrenrecords.dob | Sponsored Children Records - Date of Birth | This field will only be returned if the child's age is below 21. | SC,PR | ICA |
sponsoredchildrenrecords.birthcountry | Sponsored Children Records - Country/Place of Birth | Refer to <a href='https://public.cloud.myinfo.gov.sg/dpp/frontend/assets/api-lib/myinfo/downloads/myinfo-api-code-tables.xlsx' target='_blank'>Code Listing (CountryPlaceCode)</a>(.XLSX, 84KB) for list of possible values.<br><br>This field will only be returned if the child's age is below 21. | SC,PR | ICA |
sponsoredchildrenrecords.lifestatus | Sponsored Children Records - Life Status | Indicates the life status of the Sponsored Child.<br><br>This field will only be returned if the child's age is below 21. | SC,PR | ICA |
sponsoredchildrenrecords.residentialstatus | Sponsored Children Records - Residential Status | Indicates if the Sponsored Child is a Citizen, PR or others.<br><br>Refer to <a href='https://public.cloud.myinfo.gov.sg/dpp/frontend/assets/api-lib/myinfo/downloads/myinfo-api-code-tables.xlsx' target='_blank'>Code Listing (ResidentialCode)</a>(.XLSX, 84KB) for list of possible values. | SC,PR | ICA |
sponsoredchildrenrecords.nationality | Sponsored Children Records - Nationality/Citizenship | Refer to <a href='https://public.cloud.myinfo.gov.sg/dpp/frontend/assets/api-lib/myinfo/downloads/myinfo-api-code-tables.xlsx' target='_blank'>Code Listing (NationalityCitizenshipCode)</a>(.XLSX, 84KB) for list of possible values. | SC,PR | ICA |
sponsoredchildrenrecords.scprgrantdate | Sponsored Children Records - SC / PR / LTVP Grant Date | Date when Sponsored child was granted Singapore Citizenship, Permanent Resident or Long Term Visit Pass. | SC,PR | ICA |
sponsoredchildrenrecords.vaccinationrequirements | Sponsored Children Records - Child Vaccination | <p> The Child Vaccination data include the following: <br/><br/> a) Child Vaccination Requirement Fulfilled: This refers to whether a child has fulfilled the preschool vaccination minimum requirements. This data is based on Health Promotion Board (HPB) National Immunisation Registry (NIR) records where the child is born from 2014 onwards. <br/><br/> b) Child Vaccination Requirement Code: Refer to <a href='https://public.cloud.myinfo.gov.sg/dpp/frontend/assets/api-lib/myinfo/downloads/myinfo-api-code-tables.xlsx' target='_blank'>Code Listing (ChildVaccReqCode)</a> for list of possible values. </p> | SC,PR,FIN | HPB |
Vehicles and Driving Licence
| Scope | Name | Description | Data Available | Source |
|---|---|---|---|---|
vehicles.vehicleno | Vehicles - Vehicle Number | Vehicle Registration Number displayed on the vehicle number plates. | SC,PR,FIN | LTA |
vehicles.type | Vehicles - Vehicle Type | Type of Vehicle such as 'MOTOR CAR', 'STATION /WAGON/JEEP/LAND ROVER'. | SC,PR,FIN | LTA |
vehicles.iulabelno | Vehicles - IU Label Number | 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. | SC,PR,FIN | LTA |
vehicles.make | Vehicles - Vehicle Make | Vehicle Make such as 'TOYOTA', 'HONDA', 'AUDI'. | SC,PR,FIN | LTA |
vehicles.model | Vehicles - Vehicle Model | Vehicle Model such as 'COROLLA ALTIS CLASSIC 1.6 CVT', 'HRV 1.5 DX CVT'. | SC,PR,FIN | LTA |
vehicles.chassisno | Vehicles - Chassis Number | Vehicle Chassis Number. | SC,PR,FIN | LTA |
vehicles.engineno | Vehicles - Engine Number | Vehicle Engine Number. | SC,PR,FIN | LTA |
vehicles.motorno | Vehicles - Motor Number | Vehicle Motor Number. | SC,PR,FIN | LTA |
vehicles.yearofmanufacture | Vehicles - Year of Manufacture | Manufacturing Year. | SC,PR,FIN | LTA |
vehicles.firstregistrationdate | Vehicles - First Registration Date | Date when vehicle is registered with LTA. | SC,PR,FIN | LTA |
vehicles.originalregistrationdate | Vehicles - Original Registration Date | Date when vehicle is first registered in the Country of Origin. | SC,PR,FIN | LTA |
vehicles.coecategory | Vehicles - COE Category | Vehicle Certificate of Entitlement (COE) bid category. | SC,PR,FIN | LTA |
vehicles.coeexpirydate | Vehicles - COE Expiry Date | Vehicle Certificate of Entitlement (COE) expiry date. | SC,PR,FIN | LTA |
vehicles.roadtaxexpirydate | Vehicles - Road Tax Expiry Date | SC,PR,FIN | LTA | |
vehicles.quotapremium | Vehicles - Quota Premium | Actual Quota Premium (QP) amount payable for the COE upon registration, conversion or COE revalidation. For renewal of COE, the value will contain actual PQP paid. | SC,PR,FIN | LTA |
vehicles.openmarketvalue | Vehicles - Open Market Value | Open Market Value is the value of manufacturer invoice price, freight and insurance. | SC,PR,FIN | LTA |
vehicles.co2emission | Vehicles - CO2 Emission Rate | CO2 emission rate (e.g. 8040). | SC,PR,FIN | LTA |
vehicles.status | Vehicles - Vehicle Status | Status of the Vehicle.<br><br>Refer to <a href='https://public.cloud.myinfo.gov.sg/dpp/frontend/assets/api-lib/myinfo/downloads/myinfo-api-code-tables.xlsx' target='_blank'>Code Listing (VehicleStatus)</a>(.XLSX, 84KB) for list of possible values. | SC,PR,FIN | LTA |
vehicles.primarycolour | Vehicles - Primary Colour | Vehicle Primary Colour (e.g. BLACK). | SC,PR,FIN | LTA |
vehicles.secondarycolour | Vehicles - Secondary Colour | Vehicle Secondary Colour (e.g. WHITE). | SC,PR,FIN | LTA |
vehicles.attachment1 | Vehicles - Attachment 1 | Vehicle Attachment 1 (e.g. DISABLED). | SC,PR,FIN | LTA |
vehicles.attachment2 | Vehicles - Attachment 2 | Vehicle Attachment 2 (e.g. WITH SUN ROOF). | SC,PR,FIN | LTA |
vehicles.attachment3 | Vehicles - Attachment 3 | Vehicle Attachment 3 (e.g. SIDE CURTAIN). | SC,PR,FIN | LTA |
vehicles.scheme | Vehicles - Vehicle Scheme | Vehicle Scheme (e.g. REVISED OFF-PEAK CAR). | SC,PR,FIN | LTA |
vehicles.thcemission | Vehicles - THC Emission Rate | Total Hydro Carbon (THC) emission rate (e.g. 1011000). | SC,PR,FIN | LTA |
vehicles.coemission | Vehicles - CO Emission Rate | Carbon Monoxide emission rate (e.g. 1100000). | SC,PR,FIN | LTA |
vehicles.noxemission | Vehicles - NOx Emission Rate | Nitrogen Oxide (NOx) emission rate (e.g. 11000). | SC,PR,FIN | LTA |
vehicles.pmemission | Vehicles - PM Emission Rate | Particulates (PM - Atmospheric Particulate Matter) emission rate (e.g. 7000). | SC,PR,FIN | LTA |
vehicles.enginecapacity | Vehicles - Engine Capacity | Engine Capacity (E.g. 1600 = 1,600cc). | SC,PR,FIN | LTA |
vehicles.powerrate | Vehicles - Power Rate | Power Rate. Applicable to Electric and Hybrid vehicles powered by electric motors. Unit is Kilowatt. (e.g. 1400). | SC,PR,FIN | LTA |
vehicles.effectiveownership | Vehicles - Effective Date/Time of Ownership | Effective Date/Time of Ownership in DDMMYYYYHHMMSS format. | SC,PR,FIN | LTA |
vehicles.propellant | Vehicles - Propellant | 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). | SC,PR,FIN | LTA |
vehicles.maximumunladenweight | Vehicles - Max Unladen Weight | Maximum Unladen Weight. | SC,PR,FIN | LTA |
vehicles.maximumladenweight | Vehicles - Max Laden Weight | Maximum Laden Weight. | SC,PR,FIN | LTA |
vehicles.minimumparfbenefit | Vehicles - Minimum PARF Benefit | Minimum PARF Benefit. | SC,PR,FIN | LTA |
vehicles.nooftransfers | Vehicles - No. of Transfers | Number of Transfers. | SC,PR,FIN | LTA |
vehicles.vpc | Vehicles - Vehicle Parking Certificate | Vehicle Parking Certificate. Applicable for Heavy Vehicles. | SC,PR,FIN | LTA |
drivinglicence.comstatus | Driving Licence - Certificate of Merit Status | Status of Certificate of Merit (e.g. Y - Eligible, N - Not Eligible). | SC,PR,FIN | TP |
drivinglicence.totaldemeritpoints | Driving Licence - Total Demerit Points | Total Demerit Points. | SC,PR,FIN | TP |
drivinglicence.suspension.startdate | Driving Licence - Suspension Start Date | Suspension Start Date. | SC,PR,FIN | TP |
drivinglicence.suspension.enddate | Driving Licence - Suspension End Date | Suspension End Date. | SC,PR,FIN | TP |
drivinglicence.disqualification.startdate | Driving Licence - Disqualification Start Date | Disqualification Start Date | SC,PR,FIN | TP |
drivinglicence.disqualification.enddate | Driving Licence - Disqualification End Date | Disqualification End Date | SC,PR,FIN | TP |
drivinglicence.revocation.startdate | Driving Licence - Revocation Start Date | Revocation Start Date | SC,PR,FIN | TP |
drivinglicence.revocation.enddate | Driving Licence - Revocation End Date | Revocation End Date | SC,PR,FIN | TP |
drivinglicence.pdl.validity | Driving Licence - Provisional Driving Licence Validity | Validity of PDL (e.g. V - Valid, E - Expired, I - Invalid, N - Not Holding PDL). | SC,PR,FIN | TP |
drivinglicence.pdl.expirydate | Driving Licence - Provisional Driving Licence Expiry Date | PDL Expiry Date | SC,PR,FIN | TP |
drivinglicence.pdl.classes | Driving Licence - Provisional Driving Licence Class | PDL Class | SC,PR,FIN | TP |
drivinglicence.qdl.validity | Driving Licence - Qualified Driving Licence Validity | Validity of QDL (e.g. V - Valid, E - Expired, I - Invalid, N - Not Holding QDL). | SC,PR,FIN | TP |
drivinglicence.qdl.expirydate | Driving Licence - Qualified Driving Licence Expiry Date | QDL Expiry Date | SC,PR,FIN | TP |
drivinglicence.qdl.classes | Driving Licence - Qualified Driving Licence Class | QDL Class. Includes Issue Date (e.g. 2B, 2018-01-01). | SC,PR,FIN | TP |
drivinglicence.photocardserialno | Driving Licence - Photo Card Serial Number | Serial Number of the Photo Card. | SC,PR,FIN | TP |
Property
| Scope | Name | Description | Data Available | Source |
|---|---|---|---|---|
hdbownership.noofowners | HDB Ownership - Number of Owners | Number of Owners.<br><br>Note that this does not include executors, administrators or trustees. | SC,PR,FIN | HDB |
hdbownership.address | HDB Ownership - Address | Flat Address. | SC,PR,FIN | HDB |
hdbownership.hdbtype | HDB Ownership - Type of HDB Dwelling | HDB Flat Type.<br><br>Refer to <a href='https://public.cloud.myinfo.gov.sg/dpp/frontend/assets/api-lib/myinfo/downloads/myinfo-api-code-tables.xlsx' target='_blank'>Code Listing (HDBTypeCode)</a>(.XLSX, 84KB) for list of possible values. | SC,PR,FIN | HDB |
hdbownership.leasecommencementdate | HDB Ownership - Lease Commencement Date | Lease Period Start Date. | SC,PR,FIN | HDB |
hdbownership.termoflease | HDB Ownership - Term of Lease | Term of lease for the property computed from the lease commencement date. | SC,PR,FIN | HDB |
hdbownership.dateofpurchase | HDB Ownership - Date of Purchase | Effective Date of flat purchase. | SC,PR,FIN | HDB |
hdbownership.dateofownershiptransfer | HDB Ownership - Date of Transfer of Ownership | Effective date of partial transfer without monetary consideration (e.g. addition, deletion or substitution of a co-owner) for an HDB sold flat.<br><br>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.<br><br>For outright transfer where there is a total change of all owner(s), only the Date of Purchase will be updated. | SC,PR,FIN | HDB |
hdbownership.loangranted | HDB Ownership - Loan Granted | The amount of housing loan granted to owner(s) by HDB. | SC,PR,FIN | HDB |
hdbownership.originalloanrepayment | HDB Ownership - Original Loan Repayment Period | The number of years for loan repayment opted by owner(s) at the time the loan is first granted to him/her. | SC,PR,FIN | HDB |
hdbownership.balanceloanrepayment | HDB Ownership - Balance Loan Repayment Period | The remaining number of year(s) and month(s) available to repay the loan. | SC,PR,FIN | HDB |
hdbownership.outstandingloanbalance | HDB Ownership - Outstanding HDB Loan Balance | Outstanding amount payable to HDB. | SC,PR,FIN | HDB |
hdbownership.monthlyloaninstalment | HDB Ownership - Monthly Loan Instalment | Monthly instalment payable to HDB. | SC,PR,FIN | HDB |
hdbownership.purchaseprice | HDB Ownership - Purchase Price | This refers to the price at which the flat owner paid for the flat. | SC,PR,FIN | HDB |
hdbownership.outstandinginstalment | HDB Ownership - Outstanding Instalment | This refers to the outstanding instalment owed by the flat owner(s) which includes the current month instalment. GST is not applicable. If there is advance payment, the value will be 0. | SC,PR,FIN | HDB |
Government Scheme
| Scope | Name | Description | Source | |
|---|---|---|---|---|
pioneergen | Pioneer Generation Eligibility | The Government has introduced the Pioneer Generation Package to honour and thank our pioneers for their hard work and dedication in making Singapore what it is today. The package includes a host of initiatives aimed at making healthcare affordable for our Pioneer Generation for life. | SC | MOF/CPFB |
merdekagen | Merdeka Generation Eligibility | The Government has introduced the Merdeka Generation Package to honour and thank our Merdeka Generation for their contributions. The package supports the aspirations of Merdeka Generation seniors in their silver years by helping them to stay active and healthy and providing them better peace of mind over future healthcare costs. | SC | MOF/CPFB |
| Scope | Name | Description | Data Available | Source |
|---|---|---|---|---|
uinfin | NRIC/FIN | NRIC number or FIN of user. NRIC number is the unique identifier given to every Singapore Citizens (SC) and Permanent Residents (PR), while FIN is the unique identifier for Foreigners. | SC,PR,FIN | ICA/MOM |
partialuinfin | Partial NRIC/FIN | Last 3 numerical digits and checksum of the NRIC/FIN number, prefixed with '*****' (e.g. "*****567A" from the full NRIC number of "S1234567A"). | SC,PR,FIN | - |
name | Principal Name | Full name of user printed on NRIC or FIN card. Includes Surname if any. | SC,PR,FIN | ICA/MOM |
aliasname | Alias Name | Refers to an alternate/additional name of the user that is legally recognised. | SC,PR | ICA |
hanyupinyinname | Hanyu Pinyin Name | Refers to the officially romanised Chinese name of the user. | SC,PR | ICA |
hanyupinyinaliasname | Hanyu Pinyin Alias Name | Refers to the legally-recognised alternate officially romanised Chinese name of the user. | SC,PR | ICA |
marriedname | Married Name | Refers to the family name or surname adopted by the user upon marriage. | SC,PR | ICA |
sex | Sex | Gender of the user. Refer to Code Listing (SexCode) for list of possible values. | SC,PR,FIN | ICA/MOM |
race | Race | Refer to Code Listing (RaceCode) for list of possible values | SC,PR,FIN | ICA/MOM |
secondaryrace | Secondary Race | Refers to secondary racial category of the Person, if any. Refer to Code Listing (RaceCode) for list of possible values | SC,PR | ICA |
dialect | Dialect | Refer to Code Listing (DialectCode) for list of possible values | SC,PR | ICA |
dob | Date of Birth | SC,PR,FIN | ICA/MOM | |
residentialstatus | Residential Status | Indicate if the user is a Citizen, PR or others. Blank value will be returned for FIN holder. Refer to Code Listing (ResidentialCode) for list of possible values | SC,PR | ICA |
nationality | Nationality/Citizenship | Refer to Code Listing (NationalityCitizenshipCode) for list of possible values | SC,PR,FIN | ICA/MOM |
birthcountry | Country/Place of Birth | Refer to Code Listing (CountryPlaceCode) for list of possible values | SC,PR,FIN | ICA/MOM |
passportnumber | Passport Number | SC | ICA | |
passportexpirydate | Passport Expiry Date | SC | ICA | |
passtype | Pass Type | This refers to the pass type of a FIN holder. Refer to Code Listing (PassTypeCode)(.XLSX, 84KB) for list of possible values. Note that this only applies to a FIN holder with a valid pass issued by ICA/MOM. | FIN | ICA/MOM |
passstatus | Pass Status | This refers to the pass status of a FIN holder. Note that this only applies to a FIN holder with a valid pass issued by ICA/MOM. | FIN | ICA/MOM |
passexpirydate | Pass Expiry Date | This refers to the pass expiry date of a FIN holder. Note that this only applies to a FIN holder with a valid pass issued by ICA/MOM. | FIN | ICA/MOM |
employmentsector | Employment Sector | This refers to the employment sector of a FIN holder. Note that this only applies to a FIN holder with a valid pass issued by MOM. | FIN | MOM |
mobileno | Mobile Number | Mobile number must be made editable at digital services even though data source is Singpass. | SC,PR,FIN | Singpass |
Email Address | Email address must be made editable at digital services even though data source is Singpass. | SC,PR,FIN | Singpass | |
regadd | Registered Address | For SC/PR - Registered address is the address that is printed on the NRIC card. For FIN - Registered address is applicable for foreigners under the following Pass Types:
ICA-issued Passes
MOM-issued Passes
| SC,PR,FIN | ICA/MOM |
hdbtype | Type of HDB | Note that this is determined based on user's Registered Address (if it is a HDB flat). It therefore has no association with HDB ownership. Refer to Code Listing (HDBTypeCode) for list of possible values | SC,PR,FIN | HDB |
housingtype | Type of Housing | Note that this is determined based on user's Registered Address (if it is not a HDB flat). It has no association with housing ownership. Refer to Code Listing (HousingTypeCode) for list of possible values. | SC,PR,FIN | URA |