> For the complete documentation index, see [llms.txt](https://docs.corppass.gov.sg/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.corppass.gov.sg/technical-specifications/corppass-authorization-api-fapi-2.0/scopes/myinfo-business-scopes/person-scopes.md). # Person Scopes Myinfo Business person scopes provide access to **personal information** about the **user acting on behalf of the entity**. These scopes are only available to [Myinfo Business applications](/products/myinfo-business.md). The corresponding data is returned via the [Userinfo Endpoint](/technical-specifications/corppass-authorization-api-fapi-2.0/integration-guide/4.-userinfo-endpoint.md) under `person_info`. Refer to [Person Info](/technical-specifications/corppass-authorization-api-fapi-2.0/integration-guide/4.-userinfo-endpoint/person-info.md) for more details. ## Personal

Name	Scope	Available For	Description
NRIC / FIN	`user.uinfin`	SC, PR, 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.
Alias Name	`user.aliasname`	SC, PR	Refers to an alternate/additional name of the user that is legally recognised.
Date of Birth	`user.dob`	SC, PR, FIN
Employment Sector	`user.employmentsector`	FIN	Refers to the employment sector of a FIN holder. Only applies to a FIN holder with a valid pass issued by MOM.
Hanyu Pinyin Name	`user.hanyupinyinname`	SC, PR	Refers to the officially romanised Chinese name of the user.
Hanyu Pinyin Alias Name	`user.hanyupinyinaliasname`	SC, PR	Refers to the legally-recognised alternate officially romanised Chinese name of the user.
Type of Housing	`user.housingtype`	SC, PR, FIN	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 the OpenAPI specification for possible values.
Married Name	`user.marriedname`	SC, PR	Refers to the family name or surname adopted by the user upon marriage.
Marital Status	`user.marital`	SC, PR	Marital status is based on records that had been reasonably verified by the relevant Government agency upon receipt. Marital Status must be made editable at digital services even though data source is MSF. Refer to the OpenAPI specification for possible values.
Principal Name	`user.name`	SC, PR, FIN	Full name of user printed on NRIC or FIN card. Includes Surname if any.
Nationality/Citizenship	`user.nationality`	SC, PR, FIN	Refer to the OpenAPI specification for possible values.
Passport Expiry Date	`user.passportexpirydate`	SC	Passport expiry date of the user.
Passport Number	`user.passportnumber`	SC	Passport number of the user.
Pass Type	`user.passtype`	FIN	Refer to the OpenAPI specification for possible values.
Pass Status	`user.passstatus`	FIN	This refers to the pass status of a FIN holder. Available values: Live Approved. (Interim status in which the FIN holder has yet to receive the pass) Note that this only applies to a FIN holder with a valid pass issued by ICA/MOM.
Residential Status	`user.residentialstatus`	SC, PR	Indicate if the user is a Citizen, PR or others. Blank value will be returned for FIN holder. Refer to the OpenAPI specification for possible values.
Secondary Race	`user.secondaryrace`	SC, PR	Refers to secondary racial category of the Person, if any. Refer to the OpenAPI specification for possible values.
Race	`user.race`	SC, PR, FIN	Refer to the OpenAPI specification for possible values.
Sex	`user.sex`	SC, PR, FIN	Gender of the user. Refer to the OpenAPI specification for possible values.
Registered Address	`user.regadd`	SC, PR, FIN	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 Long Term Visit Pass / Long Term Visit Pass + Student Pass Immigration Exemption Order MOM-issued Passes S Pass Employment Pass Personalised Employment Pass EntrePass Dependent Pass

## Vehicle and Driving License

Name	Scope	Description
Driving Licence - Provisional Driving Licence Validity	`user.drivinglicence.pdl.validity`	Validity of PDL (e.g. V - Valid, E - Expired, I - Invalid, N - Not Holding PDL).
Driving Licence - Qualified Driving Licence Class	`user.drivinglicence.qdl.classes`	QDL Class. Includes Issue Date (e.g. 2B, 2018-01-01).
Driving Licence - Qualified Driving Licence Validity	`user.drivinglicence.qdl.validity`	Validity of QDL (e.g. V - Valid, E - Expired, I - Invalid, N - Not Holding QDL).
Vehicles - Vehicle Make	`user.vehicles.make`	Vehicle Make such as 'TOYOTA', 'HONDA', 'AUDI'.
Vehicles - Vehicle Model	`user.vehicles.model`	Vehicle Model such as 'COROLLA ALTIS CLASSIC 1.6 CVT', 'HRV 1.5 DX CVT'.
Vehicles - Vehicle Number	`user.vehicles.vehicleno`	Vehicle Registration Number displayed on the vehicle number plates.

## Property

Name	Scope	Description
HDB Ownership - Address	`user.hdbownership.address`	Flat Address.
HDB Ownership - Date of Purchase	`user.hdbownership.dateofpurchase`	Effective Date of flat purchase.
HDB Ownership - Type of HDB Dwelling	`user.hdbownership.hdbtype`	HDB Flat Type. Refer to the OpenAPI specification for possible values.
HDB Ownership - Monthly Loan Instalment	`user.hdbownership.monthlyloaninstalment`	Monthly instalment payable to HDB.
HDB Ownership - Number of Owners	`user.hdbownership.noofowners`	Number of Owners. Note that this does not include executors, administrators or trustees.
HDB Ownership - Outstanding HDB Loan Balance	`user.hdbownership.outstandingloanbalance`	Outstanding amount payable to HDB.
HDB Ownership - Type of HDB Dwelling	`user.hdbtype`	HDB Flat Type. Refer to the OpenAPI specification for possible values.

## Finance

Name	Scope	Description
CPF Contribution History (up to 15 months)	`user.cpfcontributions`	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. 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. 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. Refer to the CPF display guidelines.
CPF Housing Withdrawal	`user.cpfhousingwithdrawal`	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: Address: This is the registered address of property which withdrawal is made. Principal Withdrawal Amount: This is the CPF principal amount user has withdrawn under the CPF housing schemes. Monthly Instalment Amount: This is the monthly CPF deduction for payment of user's property. Accrued Interest Amount: This is the interest that user would have earned had user's savings remained in the CPF account. 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. Refer to the CPF display guidelines.
Notice of Assessment (Basic, Latest Year)	`user.noa-basic`	This refers to the taxpayer's total income after deducting allowable expenses and approved donations. Total income includes: Trade Employment Rent Interest This field will only return: 1 yearly assessable income and 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: Assessable Income= 'NA' or '-' Year Assessed='NA'. To note: 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). 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.
Notice of Assessment (Detailed, Latest Year)	`user.noa`	Similar to 'Notice of Assessment (Basic, Latest Year)' data field, including the following income breakdown Employment Trade Rent Interest Additional details in this data field: 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'. Tax Category : Type of Income Tax Bill. Refer to IRAS tax assessment for details.
Notice of Assessment (Detailed, Last 2 Years)	`user.noahistory`	Similar to 'Notice of Assessment (Basic, Latest Year)' data field, but for the last 2 years instead.
Notice of Assessment (Basic, Last 2 Years)	`user.noahistory-basic`	Similar to 'Notice of Assessment (Basic, Latest Year)' data field, but for the last 2 years instead.
Ownership of Private Residential Property	`user.ownerprivate`	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'.

## Employment

Name Scope Description

CPF Employers

Name	Scope	Description
CPF Employers	`user.cpfemployers`	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.
Name of Employer	`user.employment`	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.

user.cpfemployers

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.

Name of Employer

user.employment

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.

--- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.corppass.gov.sg/technical-specifications/corppass-authorization-api-fapi-2.0/scopes/myinfo-business-scopes/person-scopes.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.