Singpass Developer Docs
Developer Docs for Singpass
Developer Docs for SingpassCIBALegacy Myinfo v3/v4Verify API (legacy)
Developer Docs for Singpass
Developer Docs for SingpassCIBALegacy Myinfo v3/v4Verify API (legacy)
  • INTRODUCTION
    • Overview of Singpass
    • Understanding the basics of OIDC
  • Products
    • Login
      • Introduction
      • Key Principles
      • User Journey
      • Logo Download and Brand Guidelines
      • Singpass Button Guidelines (For developers and designers)
    • FAQ
      • Login
      • Myinfo
    • Myinfo
      • Introduction
      • Key Principles
      • User Journey
      • Logo Download and Brand Guidelines
      • Data Display Guidelines
      • Scheduled Downtimes
  • GETTING STARTED
    • Onboarding Checklist
    • User Journey
    • Create Singpass Application
    • Start Integration - Demo App
  • Technical Specifications
    • Singpass Authentication API
      • Overview of Singpass Flow
      • 1. Authorization Endpoint
        • Redirection on success
        • For Mobile Developers
      • 2. Token Endpoint
        • Authorization Code Grant
        • Client JWK Requirements
      • 3. Userinfo Endpoint
        • Requesting Userinfo
        • Validating the payload
      • .well-known Endpoints
        • OpenID Discovery Endpoint
        • JWKS Endpoint
      • Error Response
      • Frame busting for web views
    • Staging and Production URLs
  • Singpass Developer Portal (SDP)
    • User Guide
      • Obtain Access to SDP
      • Login to SDP
      • Toggle Staging vs Production
      • Create Staging App
      • Edit Staging App
      • Create Staging Test Account
      • Create Production App
      • Edit Production App
      • Consent to Singpass Service Agreement
      • View Singpass Service Agreement
      • Updating Billing Contact Information
      • Deactivate Production App
      • Activate Production App
      • How to View Production App Transactions
    • Understanding the App Config Fields
      • App Name
      • App Description
      • Site URL
      • Support Emails
      • Allowed Scopes
      • Redirect URL
      • Token-based Authentication
  • Data Catalog (Myinfo)
    • Understanding the Data
      • Local Registered Birth Records and Sponsored Child Records
      • CPF Contribution History (up to 15 months)
      • Notice of Assessment (Basic)
      • Notice of Assessment (Detailed)
    • Catalog
      • Personal
      • Finance
      • Education and Employment
      • Family
      • Vehicle and Driving Licence
      • Property
      • Government Scheme
  • TESTING
    • Testing with Singpass App
    • Myinfo Test Personas
  • MORE INFORMATION
    • Contact
Powered by GitBook
On this page

Was this helpful?

  1. Data Catalog (Myinfo)
  2. Catalog

Family

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

Marital Status must be made editable at digital services even though data source is MSF.

SC,PR

MSF

marriagedate

Marriage Date

Marriage Date refers to the latest date of most recent Marriage.

Note that Marriage Date shall be made editable at digital services even though data source is MSF.

SC,PR

MSF

divorcedate

Divorce Date

Divorce Date refers to the latest date of most recent Divorce.

Note that Divorce 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.

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.

Note that Marriage Country/Place 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.

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.

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.

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.

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.

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.

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.

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.

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.

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

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.

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

The Child Vaccination data include the following: 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.

SC,PR,FIN

HPB

childrenbirthrecords.sgcitizenatbirthind

Children Birth Records - Singapore Citizen at Birth Indicator

Indicates whether the child is a Singapore Citizen at the time of birth.

This field will only be returned if the child's age is below 21.

SC,PR,FIN

ICA

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.

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.

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.

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.

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.

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.

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.

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.

This field will only be returned if the child's age is below 21.

SC,PR

ICA

sponsoredchildrenrecords.dialect

Sponsored Children Records - Dialect

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

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.

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.

SC,PR

ICA

sponsoredchildrenrecords.nationality

Sponsored Children Records - Nationality/Citizenship

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

The Child Vaccination data include the following:

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.

SC,PR,FIN

HPB

PreviousEducation and EmploymentNextVehicle and Driving Licence

Last updated 17 hours ago

Was this helpful?

Refer to (MaritalStatusCode) for list of possible values.

Refer to (CountryPlaceCode) for list of possible values.

Refer to (SexCode) for list of possible values.

Refer to (RaceCode) for list of possible values.

Refer to (RaceCode) for list of possible values.

Refer to (DialectCode) for list of possible values.

b) Child Vaccination Requirement Code: Refer to (ChildVaccReqCode) for list of possible values.

Refer to (SexCode) for list of possible values.

Refer to (RaceCode) for list of possible values.

Refer to (RaceCode) for list of possible values.

Refer to (DialectCode) for list of possible values.

Refer to (CountryPlaceCode) for list of possible values.

Refer to (ResidentialCode) for list of possible values.

Refer to (NationalityCitizenshipCode) for list of possible values.

b) Child Vaccination Requirement Code: Refer to (ChildVaccReqCode) for list of possible values.

Code Listing
Code Listing
Code Listing
Code Listing
Code Listing
Code Listing
Code Listing
Code Listing
Code Listing
Code Listing
Code Listing
Code Listing
Code Listing
Code Listing
Code Listing