For the complete documentation index, see llms.txt. This page is also available as Markdown.

Personal

Download the OpenAPI specification file for the full list of Myinfo person data scopes, field structures, value types, accepted formats, and maximum field lengths. This serves as the technical reference for developers integrating with the Myinfo API.

ID
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

Includes Surname if any. Note that Principal Name does not represent the full name as printed on the NRIC/FIN card or Digital IC (Read here for more info)

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

Date of Birth of Person.

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

Passport number of the user.

SC

ICA

passportexpirydate

Passport Expiry Date

Passport expiry date of the user.

SC

ICA

passtype

Pass Type

This refers to the pass type of a FIN holder.

Refer to Code Listing (PassTypeCode) 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.

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.

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

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

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). Has no association with HDB ownership. Refer to Code Listing for list of possible values.

Available for SC, PR, and FIN

HDB

housingtype

Type of Housing

Note that this is determined based on user's Registered Address (if it is not a HDB flat). Has no association with housing ownership. Refer to Code Listing for list of possible values.

Available for SC, PR, and FIN

URA

Last updated

Was this helpful?