Comment on page
Data Catalog
What data fields / scopes are provided by sgID?
The following table shows the list of available scopes from MyInfo that a sgID relying party can request. The scopes that your application can access are determined during client registration.
Please note that for all string fields, you might receive a value of
NA
if the data does not exist for that individualData item | Scope | Description | Value |
---|---|---|---|
Principle name | myinfo.name | Full name of user printed on NRIC or FIN card. Includes Surname if any | string
e.g. Denise Tan Hui Min |
NRIC/FIN | myinfo.nric_number | 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 (FIN) | string
e.g. S9876543A |
Date of Birth | myinfo.date_of_birth | Date of birth of the user | string (YYYY-MM-DD)
e.g. 1965-08-09
However, on occasion, you might also observe the following formats for individuals for whom date of birth data is missing:
- (YYYY-MM) e.g. 1965-08
- (YYYY) e.g 1965 |
Passport number | myinfo.passport_number | Passport number of the user | string
e.g. E35463874W |
Passport expiry date | myinfo.passport_expiry_date | Passport expiry date of the user | string (YYYY-MM-DD)
e.g. 2030-08-09 |
Mobile number | myinfo.mobile_number | Mobile number of the user | string (8-digit number without Country Code)
e.g. 87654321 |
Email address | myinfo.email | Email address of the user | string
e.g. [email protected] |
Registered address | myinfo.registered_address | Registered address of the user. For SC/PR - Registered address is the address that is printed on the NRIC card. | string (with \n)
e.g. 102 BEDOK NORTH AVENUE 4\n#09-128\nSINGAPORE 460102 |
Sex | myinfo.sex | Gender of the user | string
e.g. MALE |
Race | myinfo.race | Race of the user | string
e.g. MALAY |
Nationality | myinfo.nationality | Nationality of the user | string
e.g. SINGAPOREAN |
Residential Status | myinfo.residentialstatus | Residential status of the user | string
e.g. SINGAPORE CITIZEN |
Housing Type | myinfo.housingtype | Housing Type of the user | string
e.g. HDB |
HDB Type | myinfo.hdbtype | HDB Type of the user | string
e.g. 4-ROOM FLAT (HDB) |
Birth Country | myinfo.birth_country | Birth Country of the user | string
e.g. SINGAPORE |
Vehicles Details | myinfo.vehicles | Details of vehicles owned by the user | string (stringified array of objects with the following attributes:
- vehicle_number )
e.g. [] or[{"vehicle_number":"SJH2353"}] |
(MOM) Name of Employer | myinfo.name_of_employer | Name of user's employer registered with MOM | string
e.g. GovTech |
(MOM) Workpass Status | myinfo.workpass_status | Workpass status of the user | string
e.g. Active |
(MOM) Workpass Expiry Date | myinfo.workpass_expiry_date | Workpass expiry date of the user | string
e.g. 2025-12-04 |
Marital Status | myinfo.marital_status | Marital status of the user | string
e.g. SINGLE |
Mobile Number (Formatted with country code) | myinfo.mobile_number_with_country_code | Mobile number of the user formatted with prefix and country code | string
e.g. +65 81235678 |
Dialect | myinfo.dialect | Dialect of the user | string
e.g. TEO CHEW |
Occupation | myinfo.occupation | Occupation of the user | string
e.g. ACCOUNTANT |
Country of Marriage | myinfo.country_of_marriage | Country of Marriage of the user | string
e.g. SINGAPORE |
Marriage Certificate Number | myinfo.marriage_certificate_number | Marriage Certificate Number of the user | string
e.g. 35678 |
Marriage Date | myinfo.marriage_date | Marriage date of the user | string
e.g. 2025-12-04 |
Divorce Date | myinfo.divorce_date | Divorce date of the user | string
e.g. 2025-12-04 |
Children Birth Records | myinfo.children_birth_records | For Singaporean citizens and Permanent Residents only. | string (stringified array of objects with the following attributes:
- birth_cert_no
- name
- date_of_birth
- sex
- race - life_status
- secondary_race
- vaccination_requirements
- is_sg_citizen_at_birth )
e.g. [] or [{"birth_cert_no":"T1808765G", "name":"ABC", "date_of_birth":"2018-04-13","sex":"FEMALE","race":"CHINESE","life_status":"ALIVE", "secondary_race":"MALAY","vaccination_requirements":[{"fulfilled":"TRUE","requirement":"Preschool Admission Vaccination Min Requirement Fulfilled"}],"is_sg_citizen_at_birth":"Y"}] |
Sponsored Children Records | myinfo.sponsored_children_records | For Singaporean citizens, Permanent Residents, and Long Term Visit Pass holders only. | string (stringified array of objects with the following attributes:
- nric
- name
- date_of_birth
- sex
- race - life_status - nationality
- residential_status
- secondary_race
)
e.g [] or [{"nric":"T1872646C","name":"ABC","date_of_birth":"2018-05-05","sex":"MALE","race":"MALAY","life_status":"ALIVE","nationality":"BRITISH OVERSEAS TERRITORIES CITIZEN","residential_status":"PR","secondary_race":"EURASIAN"}] |
Last four characters of NRIC | myinfo.nric_last_four_characters | The last 4 characters of an individual's NRIC / FIN.
Derived from the myinfo.nric_number field. | string
e.g. *****123A |
Age above 18 years old | myinfo.is_age_above_18 | Indicates whether the individual is 18 years of age or older.
Derived from the myinfo.date_of_birth field. | string (enum: true and false)
e.g. true |
Age above 21 years old | myinfo.is_age_above_21 | Indicates whether the individual is 21 years of age or older.
Derived from the myinfo.date_of_birth field. | string (enum: true and false)
e.g. true |
Public Officer Employment Details | pocdex.public_officer_details | List of public officer employments according to Public Officer Core Data Exchange (POCDEX). | string (stringified array of objects with the following attributes:
- work_email
- agency_name
- department_name
- employment_type
- employment_title )
e.g. [] or[{"work_email":"[email protected]","agency_name":"Government Technology Agency","department_name":"","employment_type":"Fixed Term","employment_title":"Software Engineer (GVT)"}] |
Number of Public Officer Employments | pocdex.number_of_employments | Number of public officer employments according to Public Officer Core Data Exchange (POCDEX). | string (to be casted as number )
e.g. 1 |
Please note that if you are not a public sector employee, you will only have access to two data fields:
OpenID
and NAME
. If you require additional user data fields, please fill out this request form. Any additional data fields that are requested must adhere to our privacy and data protection policies. We will then review your request and get back to you as soon as possible.Last modified 9d ago