API Specifications

Please see API Specification v4.0 for in depth specification

Person-Sample

get

https://test.api.myinfo.gov.sghttps://api.myinfo.gov.sg

/com/v4/person-sample/{uinfin}/

Retrieves a sample Person data from Myinfo based on UIN/FIN.

This API does not use OAuth2.0 to perform authentication or authorisation, and does not require authorisation token and digital signature.

Note: Null value indicates that an attribute is unavailable.

Path parameters

uinfinstringRequiredExample: S9812381D

Query parameters

scopestring[]Optional

Space separated list of scope requested. Possible scopes are listed in the scopes of the OAuth2 Security Schema above.

Example: name hanyupinyinname

Responses

200

OK.

Note:

• Response will be a JSON object.

application/json

Responseall of

Person instance's details

get

/com/v4/person-sample/{uinfin}/

Shell

curl https://sandbox.api.myinfo.gov.sg/com/v4/person-sample/S9812381D

200

OK.

Note:

• Response will be a JSON object.

{
  "partialuinfin": {
    "value": "*****111D",
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "uinfin": {
    "value": "S1111111D",
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "name": {
    "value": "TAN XIAO HUI",
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "hanyupinyinname": {
    "value": "CHEN XIAO HUI",
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "aliasname": {
    "value": "TRICIA TAN XIAO HUI",
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "hanyupinyinaliasname": {
    "value": "TRICIA CHEN XIAO HUI",
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "marriedname": {
    "value": "",
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "sex": {
    "code": "F",
    "desc": "FEMALE",
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "race": {
    "code": "CN",
    "desc": "CHINESE",
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "secondaryrace": {
    "code": "EU",
    "desc": "EURASIAN",
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "dialect": {
    "code": "SG",
    "desc": "SWISS GERMAN",
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "nationality": {
    "code": "SG",
    "desc": "SINGAPORE CITIZEN",
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "dob": {
    "value": "1958-05-17",
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "birthcountry": {
    "code": "SG",
    "desc": "SINGAPORE",
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "residentialstatus": {
    "code": "C",
    "desc": "CITIZEN",
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "passportnumber": {
    "value": "E35463874W",
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "passportexpirydate": {
    "value": "2020-01-01",
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "regadd": {
    "type": "SG",
    "block": {
      "value": "548"
    },
    "building": {
      "value": ""
    },
    "floor": {
      "value": "09"
    },
    "unit": {
      "value": "128"
    },
    "street": {
      "value": "BEDOK NORTH AVENUE 1"
    },
    "postal": {
      "value": "460548"
    },
    "country": {
      "code": "SG",
      "desc": "SINGAPORE"
    },
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "housingtype": {
    "code": "123",
    "desc": "TERRACE HOUSE",
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "hdbtype": {
    "code": "112",
    "desc": "2-ROOM FLAT (HDB)",
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "hdbownership": [
    {
      "noofowners": {
        "value": 2
      },
      "address": {
        "type": "SG",
        "block": {
          "value": "548"
        },
        "building": {
          "value": ""
        },
        "floor": {
          "value": "09"
        },
        "unit": {
          "value": "128"
        },
        "street": {
          "value": "BEDOK NORTH AVENUE 1"
        },
        "postal": {
          "value": "460548"
        },
        "country": {
          "code": "SG",
          "desc": "SINGAPORE"
        }
      },
      "hdbtype": {
        "code": "112",
        "desc": "2-ROOM FLAT (HDB)"
      },
      "leasecommencementdate": {
        "value": "2008-06-13"
      },
      "termoflease": {
        "value": 99
      },
      "dateofpurchase": {
        "value": "2008-06-13"
      },
      "dateofownershiptransfer": {
        "value": "2018-06-13"
      },
      "loangranted": {
        "value": 310000.01
      },
      "originalloanrepayment": {
        "value": 25
      },
      "balanceloanrepayment": {
        "years": {
          "value": 2
        },
        "months": {
          "value": 6
        }
      },
      "outstandingloanbalance": {
        "value": 50000.01
      },
      "monthlyloaninstalment": {
        "value": 1000.01
      },
      "outstandinginstalment": {
        "value": 1000.01
      },
      "purchaseprice": {
        "value": 1000.01
      },
      "classification": "C",
      "source": "1",
      "lastupdated": "2019-03-26"
    }
  ],
  "ownerprivate": {
    "value": false,
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "email": {
    "value": "[email protected]",
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "mobileno": {
    "prefix": {
      "value": "+"
    },
    "areacode": {
      "value": "65"
    },
    "nbr": {
      "value": "66132665"
    },
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "marital": {
    "code": "2",
    "desc": "MARRIED",
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "marriagecertno": {
    "value": "123456789012345",
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "countryofmarriage": {
    "code": "SG",
    "desc": "SINGAPORE",
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "marriagedate": {
    "value": "2007-01-01",
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "divorcedate": {
    "value": "",
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "childrenbirthrecords": [
    {
      "birthcertno": {
        "value": "S5562882C"
      },
      "name": {
        "value": "Jo Tan Pei Ni"
      },
      "hanyupinyinname": {
        "value": "Cheng Pei Ni"
      },
      "aliasname": {
        "value": ""
      },
      "hanyupinyinaliasname": {
        "value": ""
      },
      "marriedname": {
        "value": ""
      },
      "sex": {
        "code": "F",
        "desc": "FEMALE"
      },
      "race": {
        "code": "CN",
        "desc": "CHINESE"
      },
      "secondaryrace": {
        "code": "",
        "desc": ""
      },
      "dialect": {
        "code": "HK",
        "desc": "HOKKIEN"
      },
      "lifestatus": {
        "code": "D",
        "desc": "DECEASED"
      },
      "dob": {
        "value": "2011-09-10"
      },
      "tob": {
        "value": "0901"
      },
      "vaccinationrequirements": [
        {
          "requirement": {
            "code": "1M3D",
            "desc": "MINIMUM VACCINATION REQUIREMENT FOR PRESCHOOL"
          },
          "fulfilled": {
            "value": true
          }
        }
      ],
      "sgcitizenatbirthind": {
        "value": "Y"
      },
      "classification": "C",
      "source": "1",
      "lastupdated": "2019-03-26"
    }
  ],
  "sponsoredchildrenrecords": [
    {
      "nric": {
        "value": "S5562882C"
      },
      "name": {
        "value": "Jo Tan Pei Ni"
      },
      "hanyupinyinname": {
        "value": "Cheng Pei Ni"
      },
      "aliasname": {
        "value": ""
      },
      "hanyupinyinaliasname": {
        "value": ""
      },
      "marriedname": {
        "value": ""
      },
      "sex": {
        "code": "F",
        "desc": "FEMALE"
      },
      "race": {
        "code": "CN",
        "desc": "CHINESE"
      },
      "secondaryrace": {
        "code": "",
        "desc": ""
      },
      "dialect": {
        "code": "HK",
        "desc": "HOKKIEN"
      },
      "dob": {
        "value": "2011-09-10"
      },
      "birthcountry": {
        "code": "SG",
        "desc": "SINGAPORE"
      },
      "lifestatus": {
        "code": "A",
        "desc": "ALIVE"
      },
      "residentialstatus": {
        "code": "C",
        "desc": "Citizen"
      },
      "nationality": {
        "code": "SG",
        "desc": "SINGAPORE CITIZEN"
      },
      "scprgrantdate": {
        "value": "2015-06-13"
      },
      "vaccinationrequirements": [
        {
          "requirement": {
            "code": "1M3D",
            "desc": "MINIMUM VACCINATION REQUIREMENT FOR PRESCHOOL"
          },
          "fulfilled": {
            "value": true
          }
        }
      ],
      "classification": "C",
      "source": "1",
      "lastupdated": "2019-03-26"
    }
  ],
  "occupation": {
    "value": "",
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "employment": {
    "value": "ALPHA",
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "passtype": {
    "code": "RPass",
    "desc": "Work Permit",
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "passstatus": {
    "value": "Live",
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "passexpirydate": {
    "value": "2022-12-31",
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "employmentsector": {
    "value": "MANUFACTURING",
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "vehicles": {
    "0": {
      "classification": "C",
      "source": "1",
      "lastupdated": "2019-03-26"
    }
  },
  "drivinglicence": {
    "comstatus": {
      "code": "Y",
      "desc": "ELIGIBLE"
    },
    "totaldemeritpoints": {
      "value": 0
    },
    "suspension": {
      "startdate": {
        "value": ""
      },
      "enddate": {
        "value": ""
      }
    },
    "disqualification": {
      "startdate": {
        "value": ""
      },
      "enddate": {
        "value": ""
      }
    },
    "revocation": {
      "startdate": {
        "value": ""
      },
      "enddate": {
        "value": ""
      }
    },
    "pdl": {
      "validity": {
        "code": "V",
        "desc": "VALID"
      },
      "expirydate": {
        "value": "2020-06-15"
      },
      "classes": [
        {
          "class": {
            "value": "2A"
          }
        },
        {
          "class": {
            "value": "3A"
          }
        }
      ]
    },
    "qdl": {
      "validity": {
        "code": "V",
        "desc": "VALID"
      },
      "expirydate": {
        "value": "2020-06-15"
      },
      "classes": [
        {
          "class": {
            "value": "2A"
          },
          "issuedate": {
            "value": "2018-06-06"
          }
        },
        {
          "class": {
            "value": "3A"
          },
          "issuedate": {
            "value": "2018-06-06"
          }
        }
      ]
    },
    "photocardserialno": {
      "value": "115616"
    },
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "academicqualifications": {
    "transcripts": [
      {
        "name": {
          "value": "SINGAPORE-CAMBRIDGE GENERAL CERTIFICATE OF EDUCATION ORDINARY LEVEL"
        },
        "yearattained": {
          "value": "2018"
        },
        "results": [
          {
            "subject": {
              "value": "English Language"
            },
            "level": {
              "value": "Ordinary"
            },
            "grade": {
              "value": "A"
            },
            "subsubject": {
              "value": "SPECIAL PAPER"
            },
            "subgrade": {
              "value": "One"
            }
          }
        ],
        "explanatorynotes": {
          "value": "text"
        }
      }
    ],
    "certificates": [
      {
        "name": {
          "value": "nus.opencert"
        },
        "content": {
          "value": "text"
        },
        "opencertificate": {
          "id": {
            "value": 100000000343840
          },
          "primary": {
            "value": true
          }
        },
        "opencertificateindicator": {
          "value": true
        }
      }
    ],
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "ltavocationallicences": {
    "tdvl": {
      "licencename": {
        "value": "TAXI DRIVER'S VOCATIONAL LICENCE (TDVL)"
      },
      "vocationallicencenumber": {
        "value": "E00000001"
      },
      "expirydate": {
        "value": "2025-03-30"
      },
      "status": {
        "code": "ACT",
        "desc": "ACTIVE"
      },
      "classification": "C",
      "source": "1",
      "lastupdated": "2019-03-26"
    },
    "pdvl": {
      "licencename": {
        "value": "PRIVATE HIRE CAR DRIVER'S VOCATIONAL LICENCE (PDVL)"
      },
      "vocationallicencenumber": {
        "value": "E00000001"
      },
      "expirydate": {
        "value": "2025-03-30"
      },
      "status": {
        "code": "ACT",
        "desc": "ACTIVE"
      },
      "classification": "C",
      "source": "1",
      "lastupdated": "2019-03-26"
    },
    "bdvl": {
      "licencename": {
        "value": "BUS DRIVER'S VOCATIONAL LICENCE (BDVL)"
      },
      "vocationallicencenumber": {
        "value": "E00000001"
      },
      "expirydate": {
        "value": "2025-03-30"
      },
      "status": {
        "code": "ACT",
        "desc": "ACTIVE"
      },
      "classification": "C",
      "source": "1",
      "lastupdated": "2019-03-26"
    },
    "bavl": {
      "licencename": {
        "value": "BUS ATTENDANT VOCATIONAL LICENCE (BAVL)"
      },
      "vocationallicencenumber": {
        "value": "E00000001"
      },
      "expirydate": {
        "value": "2025-03-30"
      },
      "status": {
        "code": "ACT",
        "desc": "ACTIVE"
      },
      "classification": "C",
      "source": "1",
      "lastupdated": "2019-03-26"
    },
    "odvl": {
      "licencename": {
        "value": "OMNIBUS DRIVER'S VOCATIONAL LICENCE"
      },
      "vocationallicencenumber": {
        "value": "E00000001"
      },
      "expirydate": {
        "value": "2025-03-30"
      },
      "status": {
        "code": "ACT",
        "desc": "ACTIVE"
      },
      "classification": "C",
      "source": "1",
      "lastupdated": "2019-03-26"
    }
  },
  "merdekagen": {
    "eligibility": {
      "value": true
    },
    "quantum": {
      "value": 100
    },
    "message": {
      "code": "2",
      "desc": "You are eligible for the Merdeka Generation Package. For further enquiries, please contact 1800-2222-888."
    },
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "pioneergen": {
    "eligibility": {
      "value": true
    },
    "quantum": {
      "value": 100
    },
    "message": {
      "code": "2",
      "desc": "You are eligible for the Pioneer Generation Package. For further enquiries, please contact 1800-2222-888."
    },
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "noa-basic": {
    "amount": {
      "value": 100000.01
    },
    "yearofassessment": {
      "value": "2018"
    },
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "noa": {
    "amount": {
      "value": 100000.01
    },
    "yearofassessment": {
      "value": "2018"
    },
    "employment": {
      "value": 100000.01
    },
    "trade": {
      "value": 0
    },
    "rent": {
      "value": 0
    },
    "interest": {
      "value": 0
    },
    "taxclearance": {
      "value": "N"
    },
    "category": {
      "value": "ORIGINAL"
    },
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "noahistory-basic": {
    "noas": [
      {
        "amount": {
          "value": 100000.01
        },
        "yearofassessment": {
          "value": "2018"
        }
      }
    ],
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "noahistory": {
    "noas": [
      {
        "amount": {
          "value": 100000.01
        },
        "yearofassessment": {
          "value": "2018"
        },
        "employment": {
          "value": 100000.01
        },
        "trade": {
          "value": 0
        },
        "rent": {
          "value": 0
        },
        "interest": {
          "value": 0
        },
        "taxclearance": {
          "value": "N"
        },
        "category": {
          "value": "ORIGINAL"
        }
      }
    ],
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "cpfcontributions": {
    "history": [
      {
        "date": {
          "value": "2016-12-01"
        },
        "amount": {
          "value": 500
        },
        "month": {
          "value": "2016-11"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "date": {
          "value": "2016-12-12"
        },
        "amount": {
          "value": 500
        },
        "month": {
          "value": "2016-12"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "date": {
          "value": "2016-12-21"
        },
        "amount": {
          "value": 500
        },
        "month": {
          "value": "2016-12"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "date": {
          "value": "2017-01-01"
        },
        "amount": {
          "value": 500
        },
        "month": {
          "value": "2016-12"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "date": {
          "value": "2017-01-12"
        },
        "amount": {
          "value": 500
        },
        "month": {
          "value": "2017-01"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "date": {
          "value": "2017-01-21"
        },
        "amount": {
          "value": 500
        },
        "month": {
          "value": "2017-01"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "date": {
          "value": "2017-02-01"
        },
        "amount": {
          "value": 500
        },
        "month": {
          "value": "2017-01"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "date": {
          "value": "2017-02-12"
        },
        "amount": {
          "value": 500
        },
        "month": {
          "value": "2017-02"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "date": {
          "value": "2017-02-21"
        },
        "amount": {
          "value": 500
        },
        "month": {
          "value": "2017-02"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "date": {
          "value": "2017-03-01"
        },
        "amount": {
          "value": 500
        },
        "month": {
          "value": "2017-02"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "date": {
          "value": "2017-03-12"
        },
        "amount": {
          "value": 500
        },
        "month": {
          "value": "2017-03"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "date": {
          "value": "2017-03-21"
        },
        "amount": {
          "value": 500
        },
        "month": {
          "value": "2017-03"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "date": {
          "value": "2017-04-01"
        },
        "amount": {
          "value": 500
        },
        "month": {
          "value": "2017-03"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "date": {
          "value": "2017-04-12"
        },
        "amount": {
          "value": 500
        },
        "month": {
          "value": "2017-04"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "date": {
          "value": "2017-04-21"
        },
        "amount": {
          "value": 500
        },
        "month": {
          "value": "2017-04"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "date": {
          "value": "2017-05-01"
        },
        "amount": {
          "value": 500
        },
        "month": {
          "value": "2017-04"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "date": {
          "value": "2017-05-12"
        },
        "amount": {
          "value": 500
        },
        "month": {
          "value": "2017-05"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "date": {
          "value": "2017-05-21"
        },
        "amount": {
          "value": 500
        },
        "month": {
          "value": "2017-05"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "date": {
          "value": "2017-06-01"
        },
        "amount": {
          "value": 500
        },
        "month": {
          "value": "2017-05"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "date": {
          "value": "2017-06-12"
        },
        "amount": {
          "value": 500
        },
        "month": {
          "value": "2017-06"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "date": {
          "value": "2017-06-21"
        },
        "amount": {
          "value": 500
        },
        "month": {
          "value": "2017-06"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "date": {
          "value": "2017-07-01"
        },
        "amount": {
          "value": 500
        },
        "month": {
          "value": "2017-06"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "date": {
          "value": "2017-07-12"
        },
        "amount": {
          "value": 500
        },
        "month": {
          "value": "2017-07"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "date": {
          "value": "2017-07-21"
        },
        "amount": {
          "value": 500
        },
        "month": {
          "value": "2017-07"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "date": {
          "value": "2017-08-01"
        },
        "amount": {
          "value": 500
        },
        "month": {
          "value": "2017-07"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "date": {
          "value": "2017-08-12"
        },
        "amount": {
          "value": 750
        },
        "month": {
          "value": "2017-08"
        },
        "employer": {
          "value": "Delta Marine Consultants PL"
        }
      },
      {
        "date": {
          "value": "2017-08-21"
        },
        "amount": {
          "value": 750
        },
        "month": {
          "value": "2017-08"
        },
        "employer": {
          "value": "Delta Marine Consultants PL"
        }
      },
      {
        "date": {
          "value": "2017-09-01"
        },
        "amount": {
          "value": 750
        },
        "month": {
          "value": "2017-08"
        },
        "employer": {
          "value": "Delta Marine Consultants PL"
        }
      },
      {
        "date": {
          "value": "2017-09-12"
        },
        "amount": {
          "value": 750
        },
        "month": {
          "value": "2017-09"
        },
        "employer": {
          "value": "Delta Marine Consultants PL"
        }
      },
      {
        "date": {
          "value": "2017-09-21"
        },
        "amount": {
          "value": 750
        },
        "month": {
          "value": "2017-09"
        },
        "employer": {
          "value": "Delta Marine Consultants PL"
        }
      },
      {
        "date": {
          "value": "2017-10-01"
        },
        "amount": {
          "value": 750
        },
        "month": {
          "value": "2017-09"
        },
        "employer": {
          "value": "Delta Marine Consultants PL"
        }
      },
      {
        "date": {
          "value": "2017-10-12"
        },
        "amount": {
          "value": 750
        },
        "month": {
          "value": "2017-10"
        },
        "employer": {
          "value": "Delta Marine Consultants PL"
        }
      },
      {
        "date": {
          "value": "2017-10-21"
        },
        "amount": {
          "value": 750
        },
        "month": {
          "value": "2017-10"
        },
        "employer": {
          "value": "Delta Marine Consultants PL"
        }
      },
      {
        "date": {
          "value": "2017-11-01"
        },
        "amount": {
          "value": 750
        },
        "month": {
          "value": "2017-10"
        },
        "employer": {
          "value": "Delta Marine Consultants PL"
        }
      },
      {
        "date": {
          "value": "2017-11-12"
        },
        "amount": {
          "value": 750
        },
        "month": {
          "value": "2017-11"
        },
        "employer": {
          "value": "Delta Marine Consultants PL"
        }
      },
      {
        "date": {
          "value": "2017-11-21"
        },
        "amount": {
          "value": 750
        },
        "month": {
          "value": "2017-11"
        },
        "employer": {
          "value": "Delta Marine Consultants PL"
        }
      },
      {
        "date": {
          "value": "2017-12-01"
        },
        "amount": {
          "value": 750
        },
        "month": {
          "value": "2017-11"
        },
        "employer": {
          "value": "Delta Marine Consultants PL"
        }
      },
      {
        "date": {
          "value": "2017-12-12"
        },
        "amount": {
          "value": 750
        },
        "month": {
          "value": "2017-12"
        },
        "employer": {
          "value": "Delta Marine Consultants PL"
        }
      },
      {
        "date": {
          "value": "2017-12-21"
        },
        "amount": {
          "value": 750
        },
        "month": {
          "value": "2017-12"
        },
        "employer": {
          "value": "Delta Marine Consultants PL"
        }
      },
      {
        "date": {
          "value": "2018-01-01"
        },
        "amount": {
          "value": 750
        },
        "month": {
          "value": "2017-12"
        },
        "employer": {
          "value": "Delta Marine Consultants PL"
        }
      },
      {
        "date": {
          "value": "2018-01-12"
        },
        "amount": {
          "value": 750
        },
        "month": {
          "value": "2018-01"
        },
        "employer": {
          "value": "Delta Marine Consultants PL"
        }
      },
      {
        "date": {
          "value": "2018-01-21"
        },
        "amount": {
          "value": 750
        },
        "month": {
          "value": "2018-01"
        },
        "employer": {
          "value": "Delta Marine Consultants PL"
        }
      }
    ],
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "cpfemployers": {
    "history": [
      {
        "month": {
          "value": "2016-11"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "month": {
          "value": "2016-12"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "month": {
          "value": "2016-12"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "month": {
          "value": "2016-12"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "month": {
          "value": "2017-01"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "month": {
          "value": "2017-01"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "month": {
          "value": "2017-01"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "month": {
          "value": "2017-02"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "month": {
          "value": "2017-02"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "month": {
          "value": "2017-02"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "month": {
          "value": "2017-03"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "month": {
          "value": "2017-03"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "month": {
          "value": "2017-03"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "month": {
          "value": "2017-04"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "month": {
          "value": "2017-04"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "month": {
          "value": "2017-04"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "month": {
          "value": "2017-05"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "month": {
          "value": "2017-05"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "month": {
          "value": "2017-05"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "month": {
          "value": "2017-06"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "month": {
          "value": "2017-06"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "month": {
          "value": "2017-06"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "month": {
          "value": "2017-07"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "month": {
          "value": "2017-07"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "month": {
          "value": "2017-07"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "month": {
          "value": "2017-08"
        },
        "employer": {
          "value": "Delta Marine Consultants PL"
        }
      },
      {
        "month": {
          "value": "2017-08"
        },
        "employer": {
          "value": "Delta Marine Consultants PL"
        }
      },
      {
        "month": {
          "value": "2017-08"
        },
        "employer": {
          "value": "Delta Marine Consultants PL"
        }
      },
      {
        "month": {
          "value": "2017-09"
        },
        "employer": {
          "value": "Delta Marine Consultants PL"
        }
      },
      {
        "month": {
          "value": "2017-09"
        },
        "employer": {
          "value": "Delta Marine Consultants PL"
        }
      },
      {
        "month": {
          "value": "2017-09"
        },
        "employer": {
          "value": "Delta Marine Consultants PL"
        }
      },
      {
        "month": {
          "value": "2017-10"
        },
        "employer": {
          "value": "Delta Marine Consultants PL"
        }
      },
      {
        "month": {
          "value": "2017-10"
        },
        "employer": {
          "value": "Delta Marine Consultants PL"
        }
      },
      {
        "month": {
          "value": "2017-10"
        },
        "employer": {
          "value": "Delta Marine Consultants PL"
        }
      },
      {
        "month": {
          "value": "2017-11"
        },
        "employer": {
          "value": "Delta Marine Consultants PL"
        }
      },
      {
        "month": {
          "value": "2017-11"
        },
        "employer": {
          "value": "Delta Marine Consultants PL"
        }
      },
      {
        "month": {
          "value": "2017-11"
        },
        "employer": {
          "value": "Delta Marine Consultants PL"
        }
      },
      {
        "month": {
          "value": "2017-12"
        },
        "employer": {
          "value": "Delta Marine Consultants PL"
        }
      },
      {
        "month": {
          "value": "2017-12"
        },
        "employer": {
          "value": "Delta Marine Consultants PL"
        }
      },
      {
        "month": {
          "value": "2017-12"
        },
        "employer": {
          "value": "Delta Marine Consultants PL"
        }
      },
      {
        "month": {
          "value": "2018-01"
        },
        "employer": {
          "value": "Delta Marine Consultants PL"
        }
      },
      {
        "month": {
          "value": "2018-01"
        },
        "employer": {
          "value": "Delta Marine Consultants PL"
        }
      }
    ],
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "cpfbalances": {
    "ma": {
      "value": 11470.71,
      "classification": "C",
      "source": "1",
      "lastupdated": "2019-03-26"
    },
    "oa": {
      "value": 1581.48,
      "classification": "C",
      "source": "1",
      "lastupdated": "2019-03-26"
    },
    "sa": {
      "value": 21967.09,
      "classification": "C",
      "source": "1",
      "lastupdated": "2019-03-26"
    },
    "ra": {
      "value": 0.01,
      "classification": "C",
      "source": "1",
      "lastupdated": "2019-03-26"
    }
  },
  "cpfhousingwithdrawal": {
    "withdrawaldetails": [
      {
        "address": {
          "type": "SG",
          "block": {
            "value": "548"
          },
          "building": {
            "value": ""
          },
          "floor": {
            "value": "09"
          },
          "unit": {
            "value": "128"
          },
          "street": {
            "value": "BEDOK NORTH AVENUE 1"
          },
          "postal": {
            "value": "460548"
          },
          "country": {
            "code": "SG",
            "desc": "SINGAPORE"
          }
        },
        "accruedinterestamt": {
          "value": 1581.48
        },
        "monthlyinstalmentamt": {
          "value": 1196.09
        },
        "principalwithdrawalamt": {
          "value": 2897.01
        },
        "totalamountofcpfallowedforproperty": {
          "value": 10000.01
        }
      }
    ],
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "cpfhomeprotectionscheme": {
    "coverage": {
      "value": true
    },
    "premium": {
      "value": 100.01
    },
    "shareofcover": {
      "value": 20
    },
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "cpfdependantprotectionscheme": {
    "coverage": {
      "value": true
    },
    "insurercode": {
      "value": "9GEL"
    },
    "sumassuredamount": {
      "value": 70000
    },
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "cpfinvestmentscheme": {
    "sdsnetshareholdingqty": {
      "value": 1360,
      "classification": "C",
      "source": "1",
      "lastupdated": "2019-03-26"
    },
    "account": {
      "agentbankcode": {
        "value": "OCBC"
      },
      "invbankacctno": {
        "value": "098-26644-4"
      },
      "classification": "C",
      "source": "1",
      "lastupdated": "2019-03-26"
    },
    "saqparticipationstatus": {
      "code": "X",
      "desc": "Participated",
      "classification": "C",
      "source": "1",
      "lastupdated": "2019-03-26"
    }
  },
  "cpfmedishieldlife": {
    "medishieldlifecoverage": {
      "hascovertag": {
        "value": true
      },
      "payername": {
        "value": "text"
      },
      "netpremiumpayable": {
        "value": 1000
      },
      "policyrenewaldate": {
        "value": "2019-07-02"
      }
    },
    "integratedshieldplancoverage": {
      "hascovertag": {
        "value": true
      },
      "payername": {
        "value": "text"
      },
      "insurercode": {
        "value": "text"
      }
    },
    "medishieldlifedependants": [
      {
        "dependantname": {
          "value": "text"
        },
        "netpremiumpayable": {
          "value": 1000
        },
        "policyrenewaldate": {
          "value": "2019-07-02"
        }
      }
    ],
    "integratedshieldplandependants": [
      {
        "dependantname": {
          "value": "text"
        },
        "insurercode": {
          "value": "text"
        }
      }
    ],
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "cpfrstucurrentyeartaxrelief": {
    "totaltaxreliefself": {
      "value": 1000
    },
    "remainingtaxreliefself": {
      "value": 1000
    },
    "totaltaxrelieflovedones": {
      "value": 1000
    },
    "remainingtaxrelieflovedones": {
      "value": 1000
    },
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "cpfrstuselftopupamount": {
    "selftopupusingcash": {
      "value": 1000
    },
    "selftopupusingcpf": {
      "value": 1000
    },
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "cpflife": {
    "cpflifecoverage": {
      "value": true
    },
    "cpflifeplan": {
      "value": "Standard Plan"
    },
    "cpflifemonthlypayout": {
      "value": 1000
    },
    "cpflifepaymentcommencement": {
      "value": true
    },
    "cpflifepaymentdate": {
      "value": "2019-09-02"
    },
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "cpfmonthlypayouts": {
    "monthlypayout": {
      "value": 1000
    },
    "paymentcommencement": {
      "value": true
    },
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  }
}

Authorise

get

https://test.api.myinfo.gov.sghttps://api.myinfo.gov.sg

/com/v4/authorize

This API triggers Singpass login and obtain consent for the user to retrieve user's data from Myinfo. Once the user has authenticated and consented, an authorisation code (authcode) will be returned via the callback URL defined. The authcode can then be used to retrieve an access token via the Token API.

Note: This API is public and should be implemented as a link or button on partner's online webpage. Note: For partners integrating via android mobile application, please ensure that the "setDomStorageEnable" attribute is enabled.

Query parameters

purpose_idstringRequired

purpose_id should have a corresponding pre-registered purpose(s) description as part of the setup. Purpose description refers to what the user will see in the consent page

response_typestringRequired

Response type for authorisation code flow - must be "code".

Default: code

scopestring[]Required

Space separated list of scopes requested. Possible scopes are listed in the scopes of the OAuth2 Security Schema above.

Example: name hanyupinyinname

code_challengestringRequired

Value resulting from performing Base64 encoding of a SHA256 hash of code_verifier (cryptographic random value generate on server side.) Refer to the section on Proof Key for Code Exchange (PKCE) for more information.

Example: BuXV0_h20H2KgRkhQ2cwDKDkSOcctPPozQv0JRP8D8k

code_challenge_methodstringRequired

Hashing method used in producing code_challenge. Only supports 'S256'

Example: S256

redirect_uristringRequired

Partner's callback URL for Myinfo to return with the authorisation code.

client_idstringRequired

Unique ID for partner's application.

Example: STG-180099999K-TEST01

app_launch_urlstringOptional

Url scheme to launch back user's mobile app after successful authentication using Singpass mobile.

subentity_idstringOptional

UEN of the SaaS partner's client that will be receiving the person data.

Example: 180099736H

Responses

302

Service will redirect all responses to 'redirect_uri' with additional parameters added as response results. Expected parameters include:

• code: this is the authorisation code partner will use when calling the token endpoint
• error: if there are any errors encountered, the error code will be given in this parameter.
  • '500' - Unknown or other server side errors.
  • '503' - Myinfo under maintenance. Error description will also be given in error_description parameter.
  • 'access_denied' - When user did not give consent, refer to error_description parameter for the reason.
  • 'invalid_scope' - When application requests for scope(s) that is not permitted.
• error_description:
  • if error is 'access_denied' i.e. user did not give consent, the description will be 'Resource Owner did not authorize the request'.
  • if error is 'invalid_scope' i.e. scope requested is not allowed, the description will be either 'Invalid realm scope' or 'Invalid client scope'.

Note: If user closes the browser window prematurely, there will be no callback to the 'redirect_uri'.

get

/com/v4/authorize

JavaScript

function callAuthorizeApi() {
  var authorizeUrl = authApiUrl + "?client_id=" + clientId
    + "&scope="+ scope
    + "&redirect_uri=" + redirectUrl
    + "&response_type=code"
    + "&code_challenge=" + codeChallenge
    + "&code_challenge_method=S256"
    + "&purpose_id=" + purposeId

  window.location = authorizeUrl;
}

302

Service will redirect all responses to 'redirect_uri' with additional parameters added as response results. Expected parameters include:

• code: this is the authorisation code partner will use when calling the token endpoint
• error: if there are any errors encountered, the error code will be given in this parameter.
  • '500' - Unknown or other server side errors.
  • '503' - Myinfo under maintenance. Error description will also be given in error_description parameter.
  • 'access_denied' - When user did not give consent, refer to error_description parameter for the reason.
  • 'invalid_scope' - When application requests for scope(s) that is not permitted.
• error_description:
  • if error is 'access_denied' i.e. user did not give consent, the description will be 'Resource Owner did not authorize the request'.
  • if error is 'invalid_scope' i.e. scope requested is not allowed, the description will be either 'Invalid realm scope' or 'Invalid client scope'.

Note: If user closes the browser window prematurely, there will be no callback to the 'redirect_uri'.

No content

Token

post

https://test.api.myinfo.gov.sghttps://api.myinfo.gov.sg

/com/v4/token

This API generates an access token when presented with a valid authcode obtained from the Authorise API. This token can then be used to request for the user's data that were consented.

Authorizations

ClientAssertion & PKCE

clientassertion

PKI digital signature of assertion metadata for client authentication. Signature will be verified using the public signing key listed in Relying Party's JWKS.

PKCE

OAuth security extention to prevent CSRF and authorization code injection attacks. This replaces the 'state' parameter.

Header parameters

DPoPstringRequired

DPoP Proof (JWT) containing the partner's ephemeral public signing key that can be used to prove legit possession of the access token issued.

Body

application/x-www-form-urlencoded

codestringRequired

The authcode given by the authorise API.

grant_typestringRequired

Grant type for getting token (default "authorization_code")

Default: authorization_code

client_idstringRequired

Unique ID for your application.

redirect_uristringRequired

Application's callback URL.

client_assertionstringRequired

The assertion being used to authenticate the client. Refer to the Security section on Client Assertion for more details.

client_assertion_typestringRequired

The format of the assertion, which is defined to be 'urn:ietf:params:oauth:client-assertion-type:jwt-bearer'

Default: urn:ietf:params:oauth:client-assertion-type:jwt-bearer

code_verifierstringRequired

Cryptograhic random string generated and kept secret on serverside. Used to compare with code_challenge sent in the authorize call

Responses

200

OK.

Returning a JSON object which contains the authorization access token (JWT) that will be used to retrieve the data from Myinfo.

application/json

400

Possible scenarios:

• Same authcode in the body is being re-used. We do not allow same authcode being used in multiple calls. Ensure that authcode is not repeated.
• AuthCode error - missing, invalid, expired, revoked

application/json

401

Unauthorized.

Possible scenarios:

• No client assertion provided
• Invalid client ID used. Digital service is not registered.
• Incorrect client assertion.
  • Ensure that correct key is used to sign the assertion metadata

application/json

403

Forbidden

Possible scenarios:

• Incorrect API URL used. Refer to tutorial for the correct API URL(test/production)

application/json

500

Unexpected error. Check response body for actual error.

application/json

post

/com/v4/token

NodeJS

//get access token using authcode
async function getAccessToken(authCode, privateSigningKey, codeVerifier, sessionPopKeyPair) {
try {

  let tokenUrl = process.env.MYINFO_API_TOKEN_URL;
  let redirectUrl = process.env.PARTNER_REDIRECT_URL;
  let clientId = process.env.MYINFO_APP_CLIENT_ID;

  let cacheCtl = "no-cache";
  let contentType = "application/x-www-form-urlencoded";
  let method = constant.HTTP_METHOD.POST;
  let clientAssertionType = "urn:ietf:params:oauth:client-assertion-type:jwt-bearer";
  let jktThumbprint = await generateJwkThumbprint(sessionPopKeyPair.publicKey)
  let clientAssertion = await generateClientAssertion(tokenUrl, clientId, privateSigningKey, jktThumbprint);
  // assemble params for Token API
  let strParams = `grant_type=authorization_code` +
      "&code=" + authCode +
      "&redirect_uri=" + redirectUrl +
      "&client_id=" + clientId +
      "&code_verifier=" + codeVerifier +
      "&client_assertion_type=" + clientAssertionType +
      "&client_assertion=" + clientAssertion

  let params = querystring.parse(strParams);
  let dPoP = await generateDpop(tokenUrl, null,constant.HTTP_METHOD.POST, sessionPopKeyPair);

  // assemble headers for Token API
  let strHeaders = `Content-Type=${contentType}&Cache-Control=${cacheCtl}&DPoP=${dPoP}`;
  let headers = querystring.parse(strHeaders);

  // invoke Token API
  let parsedTokenUrl = urlParser.parse(url);
  let tokenDomain = parsedTokenUrl.hostname;
  let tokenRequestPath = parsedTokenUrl.path;

  return getHttpsResponse(hostname, path, headers, method, params);
} catch (error) {
    throw error;
};

{
  "access_token": {
    "sub": "text",
    "scope": "text",
    "nbf": "text",
    "iss": "text",
    "txnid": "text",
    "client": {
      "client_id": "STG2-MYINFO-SELF-TEST",
      "client_name": "Myinfo Self Test App",
      "entity_uen": "T16GB0002G",
      "entity_name": "GovTech"
    },
    "subentity": {
      "subclient_id": "text",
      "subclient_name": "text",
      "entity_name": "text",
      "entity_uen": "text",
      "whitelist": true
    },
    "expires_in": "text",
    "iat": "text",
    "exp": "text",
    "realm": "text",
    "aud": "text",
    "jti": "text",
    "cnf": {
      "jkt": "text"
    },
    "jku": "text",
    "epk": {
      "use": "enc",
      "alg": "ECDH-ES+A256KW",
      "kty": "EC",
      "kid": "M-JXqh0gh1GGUUdzNue3IUDyUiagqjHathnscUk2nS8",
      "crv": "P-256",
      "x": "qrR8PAUO6fDouV-6mVdix5IyrVMtu0PVS0nOqWBZosA",
      "y": "6xSbySYW6ke2V727TCgSOPiH4XSDgxFCUrAAMSbl9tI"
    }
  },
  "token_type": "Bearer",
  "expires_in": 1,
  "scope": "text"
}

Person

get

https://test.api.myinfo.gov.sghttps://api.myinfo.gov.sg

/com/v4/person/{sub}

This API returns user's data from Myinfo when presented with a valid access token obtained from the Token API.

Note: Null value indicates that an attribute is unavailable.

Authorizations

OAuth2 & DPoP

OAuth2authorizationCodeRequired

The following are the available OAuth2 scopes for Myinfo APIs

Authorization URL: Token URL:

Available scopes:

• : NRIC/FIN
• : Partial NRIC/FIN
• : Principal Name
• : Alias Name
• : Hanyu Pinyin Name
• : Hanyu Pinyin Alias Name
• : Married Name
• : Sex
• : Race
• : Secondary Race
• : Dialect
• : Date of Birth
• : Residential Status
• : Nationality/Citizenship
• : Country/Place of Birth
• : Passport Number
• : Passport Expiry Date
• : Pass Type
• : Pass Status
• : Pass Expiry Date
• : Employment Sector
• : Mobile Number
• : Email Address
• : Registered Address
• : Type of HDB
• : Type of Housing
• : Academic Qualifications
• : CPF Account Balance
• : CPF Contribution History (up to 15 months)
• : Employers as stated in CPF Contribution History (up to 15 months)
• : CPF Housing Withdrawal
• : CPF Investment Scheme - Number of Discounted Shares
• : CPF Investment Scheme - Account
• : CPF Investment Scheme - Self-Awareness Questionnaire (SAQ) Participation Status
• : CPF Home Protection Scheme
• : CPF Dependant Protection Scheme
• : CPF MediShield Life
• : CPF Retirement Sum Topping-Up Scheme Current Year Tax Relief
• : CPF Retirement Savings Topping-up Scheme - Maximum amount you can top-up using cash and CPF
• : CPF Lifelong Income For the Elderly (CPF LIFE)
• : CPF Monthly Payouts (Non-LIFE)
• : Notice of Assessment (Basic, Latest Year)
• : Notice of Assessment (Basic, Last 2 Years)
• : Notice of Assessment (Detailed, Latest Year)
• : Notice of Assessment (Detailed, Last 2 Years)
• : Ownership of Private Residential Property
• : Name of Employer
• : Occupation
• : Marital Status
• : Marriage Date
• : Marriage Certificate Number
• : Country of Marriage
• : Divorce Date
• : Children Birth Records - Birth Cert Number
• : Children Birth Records - Name
• : Children Birth Records - Alias Name
• : Children Birth Records - Hanyu Pinyin Name
• : Children Birth Records - Hanyu Pinyin Alias Name
• : Children Birth Records - Married Name
• : Children Birth Records - Sex
• : Children Birth Records - Race
• : Children Birth Records - Secondary Race
• : Children Birth Records - Date of Birth
• : Children Birth Records - Time of Birth
• : Children Birth Records - Dialect
• : Children Birth Records - Life Status
• : Children Birth Records - Vaccination Requirements
• : Children Birth Records - Singapore Citizen at Birth Indicator
• : Sponsored Children Records - NRIC / FIN
• : Sponsored Children Records - Name
• : Sponsored Children Records - Alias Name
• : Sponsored Children Records - Hanyu Pinyin Name
• : Sponsored Children Records - Hanyu Pinyin Alias Name
• : Sponsored Children Records - Married Name
• : Sponsored Children Records - Sex
• : Sponsored Children Records - Race
• : Sponsored Children Records - Secondary Race
• : Sponsored Children Records - Dialect
• : Sponsored Children Records - Date of Birth
• : Sponsored Children Records - Country/Place of Birth
• : Sponsored Children Records - Life Status
• : Sponsored Children Records - Residential Status
• : Sponsored Children Records - Nationality/Citizenship
• : Sponsored Children Records - SC / PR / LTVP Grant Date
• : Sponsored Children Records - Vaccination Requirements
• : Vehicles - Vehicle Number
• : Vehicles - Vehicle Type
• : Vehicles - IU Label Number
• : Vehicles - Vehicle Make
• : Vehicles - Vehicle Model
• : Vehicles - Chassis Number
• : Vehicles - Engine Number
• : Vehicles - Motor Number
• : Vehicles - Year of Manufacture
• : Vehicles - First Registration Date
• : Vehicles - Original Registration Date
• : Vehicles - COE Category
• : Vehicles - COE Expiry Date
• : Vehicles - Road Tax Expiry Date
• : Vehicles - Quota Premium
• : Vehicles - Open Market Value
• : Vehicles - CO2 Emission Rate
• : Vehicles - Vehicle Status
• : Vehicles - Primary Colour
• : Vehicles - Secondary Colour
• : Vehicles - Attachment 1
• : Vehicles - Attachment 2
• : Vehicles - Attachment 3
• : Vehicles - Vehicle Scheme
• : Vehicles - THC Emission Rate
• : Vehicles - CO Emission Rate
• : Vehicles - NOx Emission Rate
• : Vehicles - PM Emission Rate
• : Vehicles - Engine Capacity
• : Vehicles - Power Rate
• : Vehicles - Effective Date/Time of Ownership
• : Vehicles - Propellant
• : Vehicles - Max Unladen Weight
• : Vehicles - Max Laden Weight
• : Vehicles - Minimum PARF Benefit
• : Vehicles - No. of Transfers
• : Vehicles - Vehicle Parking Certificate
• : Driving Licence - Certificate of Merit Status
• : Driving Licence - Total Demerit Points
• : Driving Licence - Suspension Start Date
• : Driving Licence - Suspension End Date
• : Driving Licence - Disqualification Start Date
• : Driving Licence - Disqualification End Date
• : Driving Licence - Revocation Start Date
• : Driving Licence - Revocation End Date
• : Driving Licence - Provisional Driving Licence Validity
• : Driving Licence - Provisional Driving Licence Expiry Date
• : Driving Licence - Provisional Driving Licence Class
• : Driving Licence - Qualified Driving Licence Validity
• : Driving Licence - Qualified Driving Licence Expiry Date
• : Driving Licence - Qualified Driving Licence Class
• : Driving Licence - Photo Card Serial Number
• : HDB Ownership - Number of Owners
• : HDB Ownership - Address
• : HDB Ownership - Type of HDB Dwelling
• : HDB Ownership - Lease Commencement Date
• : HDB Ownership - Term of Lease
• : HDB Ownership - Date of Purchase
• : HDB Ownership - Date of Transfer of Ownership
• : HDB Ownership - Loan Granted
• : HDB Ownership - Original Loan Repayment Period
• : HDB Ownership - Balance Loan Repayment Period
• : HDB Ownership - Outstanding HDB Loan Balance
• : HDB Ownership - Monthly Loan Instalment
• : HDB Ownership - Outstanding Instalment
• : HDB Ownership - Purchase Price
• : Licence Name of Taxi Driver's LTA Vocational Licence
• : Unique Vocational Licence Number for Taxi Driver's LTA Vocational Licence holder
• : Expiry date of Taxi Driver's LTA Vocational Licence
• : Status of Taxi Driver's LTA Vocational Licence
• : Licence Name of Private Hire Car driver's LTA Vocational Licence
• : Unique Vocational Licence Number for Private Hire Car driver's LTA Vocational Licence holder
• : Expiry date of Private Hire Car driver's LTA Vocational Licence
• : Status of Private Hire Car driver's LTA Vocational Licence
• : Licence Name of Bus driver's LTA Vocational Licence
• : Unique Vocational Licence Number for Bus driver's LTA Vocational Licence holder
• : Expiry date of Bus driver's LTA Vocational Licence
• : Status of Bus driver's LTA Vocational Licence
• : Licence Name of Bus Attendant's LTA Vocational Licence
• : Unique Vocational Licence Number for Bus Attendant's LTA Vocational Licence holder
• : Expiry date of Bus Attendant's LTA Vocational Licence
• : Status of Bus Attendant's LTA Vocational Licence
• : Licence Name of Omnibus driver's LTA Vocational Licence
• : Unique Vocational Licence Number for Omnibus driver's LTA Vocational Licence holder
• : Expiry date of Omnibus driver's LTA Vocational Licence
• : Status of Omnibus driver's LTA Vocational Licence

DPoP

Demonstration Proof of Possession, extension that cryptographically bind access tokens to a particular client when they are issued

Path parameters

substringRequired

Identifier of user obtained from 'sub' attribute in access token.

Example: 9E9B2260-47B8-455B-89B5-C48F4DB98322

Query parameters

scopestring[]Required

Space separated list of scopes requested. Possible scopes are listed in the scopes of the OAuth2 Security Schema above.

Example: name hanyupinyinname

subentity_idstringOptional

UEN of SaaS partner's client that will be receiving the person data.

Example: 180099736H

Header parameters

AuthorizationanyRequired

Include the access token (JWT) from /token API in this header prefixed with 'DPoP'.

DPoPanyRequired

Include the generated Demonstration of Proof of Possession token.

Responses

200

OK.

Note:

• Response Content-Type will be 'application/jose', which is a JSON object conforming to the JWE standard (https://tools.ietf.org/html/rfc7516).
• Response contents are first signed, then encrypted. In order to access the data, partner's application should do the following steps in order:
  1. Decrypt the payload with the partner's private key corresponding to the partner's encryption public key in the onboarded partner's JWKS endpoint.
  2. Validate the decrypted payload signature with Myinfo's public signing key return from Myinfo's JWKS endpoint.
• After doing the above steps, partner's application will be able to extract the payload in JSON format.

application/json

Responseall of

Person instance's details

401

Unauthorized.

Possible scenarios:

• No DPoP token provided
• DPoP token provided does not check out with Access Token issued
• The requested UIN/FIN does not match the sub in the Access Token presented

Details will be given in the error object returned.

application/json

403

Forbidden

Possible scenarios:

• Incorrect API URL used. Refer to tutorial for the correct API URL(test/production)
• Request contains scopes not allowable for the digital service.

application/json

404

Not Found.

Possible scenarios.

• Missing Myinfo profile due to user accessing his Myinfo account less than a day after Singpass account activation.

application/json

500

Unexpected error. Check response body for actual error.

application/json

get

/com/v4/person/{sub}

NodeJS

// function to prepare request for PERSON API
callPersonAPI = async function (uuid, accessToken, sessionEphemeralKeyPair) {
  let urlLink;

  urlLink = CONFIG.PERSON_URL + '/' + uuid;

  let cacheCtl = 'no-cache';
  let method = constant.HTTP_METHOD.GET;

  // assemble params for Person API
  let strParams = 'scope=' + encodeURIComponent(CONFIG.SCOPE);

  // assemble headers for Person API
  let strHeaders = 'Cache-Control=' + cacheCtl;
  let headers = querystring.parse(strHeaders);

  //generate ath to append into DPoP 
  let ath = this.securityHelper.base64URLEncode(this.securityHelper.sha256(accessToken));
  //generate DPoP 
  let dpopToken = await this.securityHelper.generateDpop(urlLink, ath, method, sessionEphemeralKeyPair);
  headers['dpop'] = dpopToken;

  headers['Authorization'] = 'DPoP ' + accessToken;

  // invoke entity person API
  let personURL = CONFIG.PERSON_URL;
  let parsedUrl = urlParser.parse(personURL);
  let domain = parsedUrl.hostname;
  let requestPath = parsedUrl.path + '/' + uuid + '?' + strParams;
  //invoking https to do GET call

  let personData = await requestHandler.getHttpsResponse(method, 'https://' + domain + requestPath, headers, null, null);

  return personData.data;
};

{
  "partialuinfin": {
    "value": "*****111D",
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "uinfin": {
    "value": "S1111111D",
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "name": {
    "value": "TAN XIAO HUI",
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "hanyupinyinname": {
    "value": "CHEN XIAO HUI",
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "aliasname": {
    "value": "TRICIA TAN XIAO HUI",
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "hanyupinyinaliasname": {
    "value": "TRICIA CHEN XIAO HUI",
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "marriedname": {
    "value": "",
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "sex": {
    "code": "F",
    "desc": "FEMALE",
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "race": {
    "code": "CN",
    "desc": "CHINESE",
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "secondaryrace": {
    "code": "EU",
    "desc": "EURASIAN",
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "dialect": {
    "code": "SG",
    "desc": "SWISS GERMAN",
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "nationality": {
    "code": "SG",
    "desc": "SINGAPORE CITIZEN",
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "dob": {
    "value": "1958-05-17",
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "birthcountry": {
    "code": "SG",
    "desc": "SINGAPORE",
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "residentialstatus": {
    "code": "C",
    "desc": "CITIZEN",
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "passportnumber": {
    "value": "E35463874W",
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "passportexpirydate": {
    "value": "2020-01-01",
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "regadd": {
    "type": "SG",
    "block": {
      "value": "548"
    },
    "building": {
      "value": ""
    },
    "floor": {
      "value": "09"
    },
    "unit": {
      "value": "128"
    },
    "street": {
      "value": "BEDOK NORTH AVENUE 1"
    },
    "postal": {
      "value": "460548"
    },
    "country": {
      "code": "SG",
      "desc": "SINGAPORE"
    },
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "housingtype": {
    "code": "123",
    "desc": "TERRACE HOUSE",
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "hdbtype": {
    "code": "112",
    "desc": "2-ROOM FLAT (HDB)",
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "hdbownership": [
    {
      "noofowners": {
        "value": 2
      },
      "address": {
        "type": "SG",
        "block": {
          "value": "548"
        },
        "building": {
          "value": ""
        },
        "floor": {
          "value": "09"
        },
        "unit": {
          "value": "128"
        },
        "street": {
          "value": "BEDOK NORTH AVENUE 1"
        },
        "postal": {
          "value": "460548"
        },
        "country": {
          "code": "SG",
          "desc": "SINGAPORE"
        }
      },
      "hdbtype": {
        "code": "112",
        "desc": "2-ROOM FLAT (HDB)"
      },
      "leasecommencementdate": {
        "value": "2008-06-13"
      },
      "termoflease": {
        "value": 99
      },
      "dateofpurchase": {
        "value": "2008-06-13"
      },
      "dateofownershiptransfer": {
        "value": "2018-06-13"
      },
      "loangranted": {
        "value": 310000.01
      },
      "originalloanrepayment": {
        "value": 25
      },
      "balanceloanrepayment": {
        "years": {
          "value": 2
        },
        "months": {
          "value": 6
        }
      },
      "outstandingloanbalance": {
        "value": 50000.01
      },
      "monthlyloaninstalment": {
        "value": 1000.01
      },
      "outstandinginstalment": {
        "value": 1000.01
      },
      "purchaseprice": {
        "value": 1000.01
      },
      "classification": "C",
      "source": "1",
      "lastupdated": "2019-03-26"
    }
  ],
  "ownerprivate": {
    "value": false,
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "email": {
    "value": "[email protected]",
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "mobileno": {
    "prefix": {
      "value": "+"
    },
    "areacode": {
      "value": "65"
    },
    "nbr": {
      "value": "66132665"
    },
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "marital": {
    "code": "2",
    "desc": "MARRIED",
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "marriagecertno": {
    "value": "123456789012345",
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "countryofmarriage": {
    "code": "SG",
    "desc": "SINGAPORE",
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "marriagedate": {
    "value": "2007-01-01",
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "divorcedate": {
    "value": "",
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "childrenbirthrecords": [
    {
      "birthcertno": {
        "value": "S5562882C"
      },
      "name": {
        "value": "Jo Tan Pei Ni"
      },
      "hanyupinyinname": {
        "value": "Cheng Pei Ni"
      },
      "aliasname": {
        "value": ""
      },
      "hanyupinyinaliasname": {
        "value": ""
      },
      "marriedname": {
        "value": ""
      },
      "sex": {
        "code": "F",
        "desc": "FEMALE"
      },
      "race": {
        "code": "CN",
        "desc": "CHINESE"
      },
      "secondaryrace": {
        "code": "",
        "desc": ""
      },
      "dialect": {
        "code": "HK",
        "desc": "HOKKIEN"
      },
      "lifestatus": {
        "code": "D",
        "desc": "DECEASED"
      },
      "dob": {
        "value": "2011-09-10"
      },
      "tob": {
        "value": "0901"
      },
      "vaccinationrequirements": [
        {
          "requirement": {
            "code": "1M3D",
            "desc": "MINIMUM VACCINATION REQUIREMENT FOR PRESCHOOL"
          },
          "fulfilled": {
            "value": true
          }
        }
      ],
      "sgcitizenatbirthind": {
        "value": "Y"
      },
      "classification": "C",
      "source": "1",
      "lastupdated": "2019-03-26"
    }
  ],
  "sponsoredchildrenrecords": [
    {
      "nric": {
        "value": "S5562882C"
      },
      "name": {
        "value": "Jo Tan Pei Ni"
      },
      "hanyupinyinname": {
        "value": "Cheng Pei Ni"
      },
      "aliasname": {
        "value": ""
      },
      "hanyupinyinaliasname": {
        "value": ""
      },
      "marriedname": {
        "value": ""
      },
      "sex": {
        "code": "F",
        "desc": "FEMALE"
      },
      "race": {
        "code": "CN",
        "desc": "CHINESE"
      },
      "secondaryrace": {
        "code": "",
        "desc": ""
      },
      "dialect": {
        "code": "HK",
        "desc": "HOKKIEN"
      },
      "dob": {
        "value": "2011-09-10"
      },
      "birthcountry": {
        "code": "SG",
        "desc": "SINGAPORE"
      },
      "lifestatus": {
        "code": "A",
        "desc": "ALIVE"
      },
      "residentialstatus": {
        "code": "C",
        "desc": "Citizen"
      },
      "nationality": {
        "code": "SG",
        "desc": "SINGAPORE CITIZEN"
      },
      "scprgrantdate": {
        "value": "2015-06-13"
      },
      "vaccinationrequirements": [
        {
          "requirement": {
            "code": "1M3D",
            "desc": "MINIMUM VACCINATION REQUIREMENT FOR PRESCHOOL"
          },
          "fulfilled": {
            "value": true
          }
        }
      ],
      "classification": "C",
      "source": "1",
      "lastupdated": "2019-03-26"
    }
  ],
  "occupation": {
    "value": "",
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "employment": {
    "value": "ALPHA",
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "passtype": {
    "code": "RPass",
    "desc": "Work Permit",
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "passstatus": {
    "value": "Live",
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "passexpirydate": {
    "value": "2022-12-31",
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "employmentsector": {
    "value": "MANUFACTURING",
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "vehicles": {
    "0": {
      "classification": "C",
      "source": "1",
      "lastupdated": "2019-03-26"
    }
  },
  "drivinglicence": {
    "comstatus": {
      "code": "Y",
      "desc": "ELIGIBLE"
    },
    "totaldemeritpoints": {
      "value": 0
    },
    "suspension": {
      "startdate": {
        "value": ""
      },
      "enddate": {
        "value": ""
      }
    },
    "disqualification": {
      "startdate": {
        "value": ""
      },
      "enddate": {
        "value": ""
      }
    },
    "revocation": {
      "startdate": {
        "value": ""
      },
      "enddate": {
        "value": ""
      }
    },
    "pdl": {
      "validity": {
        "code": "V",
        "desc": "VALID"
      },
      "expirydate": {
        "value": "2020-06-15"
      },
      "classes": [
        {
          "class": {
            "value": "2A"
          }
        },
        {
          "class": {
            "value": "3A"
          }
        }
      ]
    },
    "qdl": {
      "validity": {
        "code": "V",
        "desc": "VALID"
      },
      "expirydate": {
        "value": "2020-06-15"
      },
      "classes": [
        {
          "class": {
            "value": "2A"
          },
          "issuedate": {
            "value": "2018-06-06"
          }
        },
        {
          "class": {
            "value": "3A"
          },
          "issuedate": {
            "value": "2018-06-06"
          }
        }
      ]
    },
    "photocardserialno": {
      "value": "115616"
    },
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "academicqualifications": {
    "transcripts": [
      {
        "name": {
          "value": "SINGAPORE-CAMBRIDGE GENERAL CERTIFICATE OF EDUCATION ORDINARY LEVEL"
        },
        "yearattained": {
          "value": "2018"
        },
        "results": [
          {
            "subject": {
              "value": "English Language"
            },
            "level": {
              "value": "Ordinary"
            },
            "grade": {
              "value": "A"
            },
            "subsubject": {
              "value": "SPECIAL PAPER"
            },
            "subgrade": {
              "value": "One"
            }
          }
        ],
        "explanatorynotes": {
          "value": "text"
        }
      }
    ],
    "certificates": [
      {
        "name": {
          "value": "nus.opencert"
        },
        "content": {
          "value": "text"
        },
        "opencertificate": {
          "id": {
            "value": 100000000343840
          },
          "primary": {
            "value": true
          }
        },
        "opencertificateindicator": {
          "value": true
        }
      }
    ],
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "ltavocationallicences": {
    "tdvl": {
      "licencename": {
        "value": "TAXI DRIVER'S VOCATIONAL LICENCE (TDVL)"
      },
      "vocationallicencenumber": {
        "value": "E00000001"
      },
      "expirydate": {
        "value": "2025-03-30"
      },
      "status": {
        "code": "ACT",
        "desc": "ACTIVE"
      },
      "classification": "C",
      "source": "1",
      "lastupdated": "2019-03-26"
    },
    "pdvl": {
      "licencename": {
        "value": "PRIVATE HIRE CAR DRIVER'S VOCATIONAL LICENCE (PDVL)"
      },
      "vocationallicencenumber": {
        "value": "E00000001"
      },
      "expirydate": {
        "value": "2025-03-30"
      },
      "status": {
        "code": "ACT",
        "desc": "ACTIVE"
      },
      "classification": "C",
      "source": "1",
      "lastupdated": "2019-03-26"
    },
    "bdvl": {
      "licencename": {
        "value": "BUS DRIVER'S VOCATIONAL LICENCE (BDVL)"
      },
      "vocationallicencenumber": {
        "value": "E00000001"
      },
      "expirydate": {
        "value": "2025-03-30"
      },
      "status": {
        "code": "ACT",
        "desc": "ACTIVE"
      },
      "classification": "C",
      "source": "1",
      "lastupdated": "2019-03-26"
    },
    "bavl": {
      "licencename": {
        "value": "BUS ATTENDANT VOCATIONAL LICENCE (BAVL)"
      },
      "vocationallicencenumber": {
        "value": "E00000001"
      },
      "expirydate": {
        "value": "2025-03-30"
      },
      "status": {
        "code": "ACT",
        "desc": "ACTIVE"
      },
      "classification": "C",
      "source": "1",
      "lastupdated": "2019-03-26"
    },
    "odvl": {
      "licencename": {
        "value": "OMNIBUS DRIVER'S VOCATIONAL LICENCE"
      },
      "vocationallicencenumber": {
        "value": "E00000001"
      },
      "expirydate": {
        "value": "2025-03-30"
      },
      "status": {
        "code": "ACT",
        "desc": "ACTIVE"
      },
      "classification": "C",
      "source": "1",
      "lastupdated": "2019-03-26"
    }
  },
  "merdekagen": {
    "eligibility": {
      "value": true
    },
    "quantum": {
      "value": 100
    },
    "message": {
      "code": "2",
      "desc": "You are eligible for the Merdeka Generation Package. For further enquiries, please contact 1800-2222-888."
    },
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "pioneergen": {
    "eligibility": {
      "value": true
    },
    "quantum": {
      "value": 100
    },
    "message": {
      "code": "2",
      "desc": "You are eligible for the Pioneer Generation Package. For further enquiries, please contact 1800-2222-888."
    },
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "noa-basic": {
    "amount": {
      "value": 100000.01
    },
    "yearofassessment": {
      "value": "2018"
    },
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "noa": {
    "amount": {
      "value": 100000.01
    },
    "yearofassessment": {
      "value": "2018"
    },
    "employment": {
      "value": 100000.01
    },
    "trade": {
      "value": 0
    },
    "rent": {
      "value": 0
    },
    "interest": {
      "value": 0
    },
    "taxclearance": {
      "value": "N"
    },
    "category": {
      "value": "ORIGINAL"
    },
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "noahistory-basic": {
    "noas": [
      {
        "amount": {
          "value": 100000.01
        },
        "yearofassessment": {
          "value": "2018"
        }
      }
    ],
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "noahistory": {
    "noas": [
      {
        "amount": {
          "value": 100000.01
        },
        "yearofassessment": {
          "value": "2018"
        },
        "employment": {
          "value": 100000.01
        },
        "trade": {
          "value": 0
        },
        "rent": {
          "value": 0
        },
        "interest": {
          "value": 0
        },
        "taxclearance": {
          "value": "N"
        },
        "category": {
          "value": "ORIGINAL"
        }
      }
    ],
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "cpfcontributions": {
    "history": [
      {
        "date": {
          "value": "2016-12-01"
        },
        "amount": {
          "value": 500
        },
        "month": {
          "value": "2016-11"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "date": {
          "value": "2016-12-12"
        },
        "amount": {
          "value": 500
        },
        "month": {
          "value": "2016-12"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "date": {
          "value": "2016-12-21"
        },
        "amount": {
          "value": 500
        },
        "month": {
          "value": "2016-12"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "date": {
          "value": "2017-01-01"
        },
        "amount": {
          "value": 500
        },
        "month": {
          "value": "2016-12"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "date": {
          "value": "2017-01-12"
        },
        "amount": {
          "value": 500
        },
        "month": {
          "value": "2017-01"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "date": {
          "value": "2017-01-21"
        },
        "amount": {
          "value": 500
        },
        "month": {
          "value": "2017-01"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "date": {
          "value": "2017-02-01"
        },
        "amount": {
          "value": 500
        },
        "month": {
          "value": "2017-01"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "date": {
          "value": "2017-02-12"
        },
        "amount": {
          "value": 500
        },
        "month": {
          "value": "2017-02"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "date": {
          "value": "2017-02-21"
        },
        "amount": {
          "value": 500
        },
        "month": {
          "value": "2017-02"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "date": {
          "value": "2017-03-01"
        },
        "amount": {
          "value": 500
        },
        "month": {
          "value": "2017-02"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "date": {
          "value": "2017-03-12"
        },
        "amount": {
          "value": 500
        },
        "month": {
          "value": "2017-03"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "date": {
          "value": "2017-03-21"
        },
        "amount": {
          "value": 500
        },
        "month": {
          "value": "2017-03"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "date": {
          "value": "2017-04-01"
        },
        "amount": {
          "value": 500
        },
        "month": {
          "value": "2017-03"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "date": {
          "value": "2017-04-12"
        },
        "amount": {
          "value": 500
        },
        "month": {
          "value": "2017-04"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "date": {
          "value": "2017-04-21"
        },
        "amount": {
          "value": 500
        },
        "month": {
          "value": "2017-04"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "date": {
          "value": "2017-05-01"
        },
        "amount": {
          "value": 500
        },
        "month": {
          "value": "2017-04"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "date": {
          "value": "2017-05-12"
        },
        "amount": {
          "value": 500
        },
        "month": {
          "value": "2017-05"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "date": {
          "value": "2017-05-21"
        },
        "amount": {
          "value": 500
        },
        "month": {
          "value": "2017-05"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "date": {
          "value": "2017-06-01"
        },
        "amount": {
          "value": 500
        },
        "month": {
          "value": "2017-05"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "date": {
          "value": "2017-06-12"
        },
        "amount": {
          "value": 500
        },
        "month": {
          "value": "2017-06"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "date": {
          "value": "2017-06-21"
        },
        "amount": {
          "value": 500
        },
        "month": {
          "value": "2017-06"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "date": {
          "value": "2017-07-01"
        },
        "amount": {
          "value": 500
        },
        "month": {
          "value": "2017-06"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "date": {
          "value": "2017-07-12"
        },
        "amount": {
          "value": 500
        },
        "month": {
          "value": "2017-07"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "date": {
          "value": "2017-07-21"
        },
        "amount": {
          "value": 500
        },
        "month": {
          "value": "2017-07"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "date": {
          "value": "2017-08-01"
        },
        "amount": {
          "value": 500
        },
        "month": {
          "value": "2017-07"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "date": {
          "value": "2017-08-12"
        },
        "amount": {
          "value": 750
        },
        "month": {
          "value": "2017-08"
        },
        "employer": {
          "value": "Delta Marine Consultants PL"
        }
      },
      {
        "date": {
          "value": "2017-08-21"
        },
        "amount": {
          "value": 750
        },
        "month": {
          "value": "2017-08"
        },
        "employer": {
          "value": "Delta Marine Consultants PL"
        }
      },
      {
        "date": {
          "value": "2017-09-01"
        },
        "amount": {
          "value": 750
        },
        "month": {
          "value": "2017-08"
        },
        "employer": {
          "value": "Delta Marine Consultants PL"
        }
      },
      {
        "date": {
          "value": "2017-09-12"
        },
        "amount": {
          "value": 750
        },
        "month": {
          "value": "2017-09"
        },
        "employer": {
          "value": "Delta Marine Consultants PL"
        }
      },
      {
        "date": {
          "value": "2017-09-21"
        },
        "amount": {
          "value": 750
        },
        "month": {
          "value": "2017-09"
        },
        "employer": {
          "value": "Delta Marine Consultants PL"
        }
      },
      {
        "date": {
          "value": "2017-10-01"
        },
        "amount": {
          "value": 750
        },
        "month": {
          "value": "2017-09"
        },
        "employer": {
          "value": "Delta Marine Consultants PL"
        }
      },
      {
        "date": {
          "value": "2017-10-12"
        },
        "amount": {
          "value": 750
        },
        "month": {
          "value": "2017-10"
        },
        "employer": {
          "value": "Delta Marine Consultants PL"
        }
      },
      {
        "date": {
          "value": "2017-10-21"
        },
        "amount": {
          "value": 750
        },
        "month": {
          "value": "2017-10"
        },
        "employer": {
          "value": "Delta Marine Consultants PL"
        }
      },
      {
        "date": {
          "value": "2017-11-01"
        },
        "amount": {
          "value": 750
        },
        "month": {
          "value": "2017-10"
        },
        "employer": {
          "value": "Delta Marine Consultants PL"
        }
      },
      {
        "date": {
          "value": "2017-11-12"
        },
        "amount": {
          "value": 750
        },
        "month": {
          "value": "2017-11"
        },
        "employer": {
          "value": "Delta Marine Consultants PL"
        }
      },
      {
        "date": {
          "value": "2017-11-21"
        },
        "amount": {
          "value": 750
        },
        "month": {
          "value": "2017-11"
        },
        "employer": {
          "value": "Delta Marine Consultants PL"
        }
      },
      {
        "date": {
          "value": "2017-12-01"
        },
        "amount": {
          "value": 750
        },
        "month": {
          "value": "2017-11"
        },
        "employer": {
          "value": "Delta Marine Consultants PL"
        }
      },
      {
        "date": {
          "value": "2017-12-12"
        },
        "amount": {
          "value": 750
        },
        "month": {
          "value": "2017-12"
        },
        "employer": {
          "value": "Delta Marine Consultants PL"
        }
      },
      {
        "date": {
          "value": "2017-12-21"
        },
        "amount": {
          "value": 750
        },
        "month": {
          "value": "2017-12"
        },
        "employer": {
          "value": "Delta Marine Consultants PL"
        }
      },
      {
        "date": {
          "value": "2018-01-01"
        },
        "amount": {
          "value": 750
        },
        "month": {
          "value": "2017-12"
        },
        "employer": {
          "value": "Delta Marine Consultants PL"
        }
      },
      {
        "date": {
          "value": "2018-01-12"
        },
        "amount": {
          "value": 750
        },
        "month": {
          "value": "2018-01"
        },
        "employer": {
          "value": "Delta Marine Consultants PL"
        }
      },
      {
        "date": {
          "value": "2018-01-21"
        },
        "amount": {
          "value": 750
        },
        "month": {
          "value": "2018-01"
        },
        "employer": {
          "value": "Delta Marine Consultants PL"
        }
      }
    ],
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "cpfemployers": {
    "history": [
      {
        "month": {
          "value": "2016-11"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "month": {
          "value": "2016-12"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "month": {
          "value": "2016-12"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "month": {
          "value": "2016-12"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "month": {
          "value": "2017-01"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "month": {
          "value": "2017-01"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "month": {
          "value": "2017-01"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "month": {
          "value": "2017-02"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "month": {
          "value": "2017-02"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "month": {
          "value": "2017-02"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "month": {
          "value": "2017-03"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "month": {
          "value": "2017-03"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "month": {
          "value": "2017-03"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "month": {
          "value": "2017-04"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "month": {
          "value": "2017-04"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "month": {
          "value": "2017-04"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "month": {
          "value": "2017-05"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "month": {
          "value": "2017-05"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "month": {
          "value": "2017-05"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "month": {
          "value": "2017-06"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "month": {
          "value": "2017-06"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "month": {
          "value": "2017-06"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "month": {
          "value": "2017-07"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "month": {
          "value": "2017-07"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "month": {
          "value": "2017-07"
        },
        "employer": {
          "value": "Crystal Horse Invest Pte Ltd"
        }
      },
      {
        "month": {
          "value": "2017-08"
        },
        "employer": {
          "value": "Delta Marine Consultants PL"
        }
      },
      {
        "month": {
          "value": "2017-08"
        },
        "employer": {
          "value": "Delta Marine Consultants PL"
        }
      },
      {
        "month": {
          "value": "2017-08"
        },
        "employer": {
          "value": "Delta Marine Consultants PL"
        }
      },
      {
        "month": {
          "value": "2017-09"
        },
        "employer": {
          "value": "Delta Marine Consultants PL"
        }
      },
      {
        "month": {
          "value": "2017-09"
        },
        "employer": {
          "value": "Delta Marine Consultants PL"
        }
      },
      {
        "month": {
          "value": "2017-09"
        },
        "employer": {
          "value": "Delta Marine Consultants PL"
        }
      },
      {
        "month": {
          "value": "2017-10"
        },
        "employer": {
          "value": "Delta Marine Consultants PL"
        }
      },
      {
        "month": {
          "value": "2017-10"
        },
        "employer": {
          "value": "Delta Marine Consultants PL"
        }
      },
      {
        "month": {
          "value": "2017-10"
        },
        "employer": {
          "value": "Delta Marine Consultants PL"
        }
      },
      {
        "month": {
          "value": "2017-11"
        },
        "employer": {
          "value": "Delta Marine Consultants PL"
        }
      },
      {
        "month": {
          "value": "2017-11"
        },
        "employer": {
          "value": "Delta Marine Consultants PL"
        }
      },
      {
        "month": {
          "value": "2017-11"
        },
        "employer": {
          "value": "Delta Marine Consultants PL"
        }
      },
      {
        "month": {
          "value": "2017-12"
        },
        "employer": {
          "value": "Delta Marine Consultants PL"
        }
      },
      {
        "month": {
          "value": "2017-12"
        },
        "employer": {
          "value": "Delta Marine Consultants PL"
        }
      },
      {
        "month": {
          "value": "2017-12"
        },
        "employer": {
          "value": "Delta Marine Consultants PL"
        }
      },
      {
        "month": {
          "value": "2018-01"
        },
        "employer": {
          "value": "Delta Marine Consultants PL"
        }
      },
      {
        "month": {
          "value": "2018-01"
        },
        "employer": {
          "value": "Delta Marine Consultants PL"
        }
      }
    ],
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "cpfbalances": {
    "ma": {
      "value": 11470.71,
      "classification": "C",
      "source": "1",
      "lastupdated": "2019-03-26"
    },
    "oa": {
      "value": 1581.48,
      "classification": "C",
      "source": "1",
      "lastupdated": "2019-03-26"
    },
    "sa": {
      "value": 21967.09,
      "classification": "C",
      "source": "1",
      "lastupdated": "2019-03-26"
    },
    "ra": {
      "value": 0.01,
      "classification": "C",
      "source": "1",
      "lastupdated": "2019-03-26"
    }
  },
  "cpfhousingwithdrawal": {
    "withdrawaldetails": [
      {
        "address": {
          "type": "SG",
          "block": {
            "value": "548"
          },
          "building": {
            "value": ""
          },
          "floor": {
            "value": "09"
          },
          "unit": {
            "value": "128"
          },
          "street": {
            "value": "BEDOK NORTH AVENUE 1"
          },
          "postal": {
            "value": "460548"
          },
          "country": {
            "code": "SG",
            "desc": "SINGAPORE"
          }
        },
        "accruedinterestamt": {
          "value": 1581.48
        },
        "monthlyinstalmentamt": {
          "value": 1196.09
        },
        "principalwithdrawalamt": {
          "value": 2897.01
        },
        "totalamountofcpfallowedforproperty": {
          "value": 10000.01
        }
      }
    ],
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "cpfhomeprotectionscheme": {
    "coverage": {
      "value": true
    },
    "premium": {
      "value": 100.01
    },
    "shareofcover": {
      "value": 20
    },
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "cpfdependantprotectionscheme": {
    "coverage": {
      "value": true
    },
    "insurercode": {
      "value": "9GEL"
    },
    "sumassuredamount": {
      "value": 70000
    },
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "cpfinvestmentscheme": {
    "sdsnetshareholdingqty": {
      "value": 1360,
      "classification": "C",
      "source": "1",
      "lastupdated": "2019-03-26"
    },
    "account": {
      "agentbankcode": {
        "value": "OCBC"
      },
      "invbankacctno": {
        "value": "098-26644-4"
      },
      "classification": "C",
      "source": "1",
      "lastupdated": "2019-03-26"
    },
    "saqparticipationstatus": {
      "code": "X",
      "desc": "Participated",
      "classification": "C",
      "source": "1",
      "lastupdated": "2019-03-26"
    }
  },
  "cpfmedishieldlife": {
    "medishieldlifecoverage": {
      "hascovertag": {
        "value": true
      },
      "payername": {
        "value": "text"
      },
      "netpremiumpayable": {
        "value": 1000
      },
      "policyrenewaldate": {
        "value": "2019-07-02"
      }
    },
    "integratedshieldplancoverage": {
      "hascovertag": {
        "value": true
      },
      "payername": {
        "value": "text"
      },
      "insurercode": {
        "value": "text"
      }
    },
    "medishieldlifedependants": [
      {
        "dependantname": {
          "value": "text"
        },
        "netpremiumpayable": {
          "value": 1000
        },
        "policyrenewaldate": {
          "value": "2019-07-02"
        }
      }
    ],
    "integratedshieldplandependants": [
      {
        "dependantname": {
          "value": "text"
        },
        "insurercode": {
          "value": "text"
        }
      }
    ],
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "cpfrstucurrentyeartaxrelief": {
    "totaltaxreliefself": {
      "value": 1000
    },
    "remainingtaxreliefself": {
      "value": 1000
    },
    "totaltaxrelieflovedones": {
      "value": 1000
    },
    "remainingtaxrelieflovedones": {
      "value": 1000
    },
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "cpfrstuselftopupamount": {
    "selftopupusingcash": {
      "value": 1000
    },
    "selftopupusingcpf": {
      "value": 1000
    },
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "cpflife": {
    "cpflifecoverage": {
      "value": true
    },
    "cpflifeplan": {
      "value": "Standard Plan"
    },
    "cpflifemonthlypayout": {
      "value": 1000
    },
    "cpflifepaymentcommencement": {
      "value": true
    },
    "cpflifepaymentdate": {
      "value": "2019-09-02"
    },
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  },
  "cpfmonthlypayouts": {
    "monthlypayout": {
      "value": 1000
    },
    "paymentcommencement": {
      "value": true
    },
    "classification": "C",
    "source": "1",
    "lastupdated": "2019-03-26"
  }
}