Tutorial 1: Myinfo Person sample Data

This tutorial will call a basic API to get sample Person data in JSON response. You can then use this JSON object to pre-fill your online form in your application.

1. Request

Open another browser window and type in the following URL:

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

This will call our sandbox API using HTTPS GET.

S9812381D is the UINFIN (NRIC or FIN) parameter which refers to the ID of the person you wish to get the data of. For this sample API, the following UINFIN are supported:

  • S9812381D

  • S9812382B

  • S9812385G

  • S9812387C

  • S9912363Z

  • S9912366D

  • S9912369I

  • S9912370B

  • S9912372I

  • S9912374E

  • S6005053H

  • S6005055D

  • S9812379B

  • F1612347K

  • G1612348Q

  • G1612349N

  • G1612350T

  • G1612352N

  • G1612353L

This API will take in the actual UINFIN as the sub for easier reference, however in the actual implementation UUID of the user will be used instead.

Please refer to our API specifications for this tutorial.


2. Response

You should see a JSON object which looks like this after you access the Person Sample API.

Sample JSON for Person data

{
  "uinfin": {
    "lastupdated": "2019-03-26",
    "source": "1",
    "classification": "C",
    "value": "S9812381D"
  },
  "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"
  },
  ...
}

Try using the JSON object in your own application to prefill your forms!


Summary

You've successfully called a basic Person API and gotten a sample JSON response from Myinfo.

Last updated

Was this helpful?