Users

Get login url to redirect to myinfo

GET http://localhost:3001/users/me/external/myinfo-redirect-login

Get login url to redirect to myinfo. This url contains attributes about person data requested to myinfo.

200: OK

{
    "message": "OK",
    "data": {
        "url": "https://test.api.myinfo.gov.sg/com/v3/authorise?client_id=STG2-MYINFO-SELF-TEST&attributes=name,dob,birthcountry,nationality,uinfin,sex,regadd&state=eb03c000-00a3-4708-ab30-926306bfc4a8&redirect_uri=http://localhost:3001/callback&purpose=python-myinfo-connector",
        "state": "eb03c000-00a3-4708-ab30-926306bfc4a8"
    }
}

url: url to redirect to myinfo.

state: Identifier that represents the user's session/transaction with the client for reconciling query and response. The same value will be sent back via the callback URL. Use a unique system generated number for each user/transaction.

Get person data from myinfo

GET http://localhost:3001/users/me/external/myinfo

Get person data from myinfo. The API is final step of myinfo-connector-python

Query Parameters

Name	Type	Description
code	String	The authcode given by myinfo's authorise API

200: OK Succeed to get person data from myinfo

{
    "message": "OK",
    "sodata": {
        "regadd": {
            "country": {
                "code": "SG",
                "desc": "SINGAPORE"
            },
            "unit": {
                "value": "10"
            },
            "street": {
                "value": "ANCHORVALE DRIVE"
            },
            "lastupdated": "2022-07-14",
            "block": {
                "value": "319"
            },
            "source": "1",
            "postal": {
                "value": "542319"
            },
            "classification": "C",
            "floor": {
                "value": "38"
            },
            "type": "SG",
            "building": {
                "value": ""
            }
        },
        "dob": "1988-10-06",
        "sex": "M",
        "name": "ANDY LAU",
        "birthcountry": "SG",
        "nationality": "SG",
        "uinfin": "S6005048A"
    }
}

regadd: Registered Address of Person (including FIN holders)

dob: Date of Birth of Person.

sex: Sex of Person.

name: Full Name of the Person.

birthcountry: Country of Birth of Person. Refer to country in code table provided HERE for description of each code.

nationality: Nationality of Person. Refer to the Code reference tables in the Support section for list of possible values.

unifin: Singapore issued identification number of the Person.

500: Internal Server Error Failed to get person data from myinfo