myinfo
Service icon

MyInfo

Stable version 1.0.0 (Compatible with OutSystems 11)
Uploaded
 on 26 March 2021
 by 
0.0
 (0 ratings)
myinfo

MyInfo

Documentation
1.0.0

MyInfo eSpace Site Properties Configuration:

- AuthLevel is used to change for different environment Development, Testing and Production

  L1 = means for myinfo development, this level of authentication does not need any private key or public key for encryption.

  L2 = this is for myinfo testing environment, It requires private key or public key for encryption. 

  L3 = this is for production environment.

- BaseURL_Actual is to store the base url of MyInfo production environment api.

  The default value should be https://api.myinfo.gov.sg

- BaseURL_SandBox is to store the base url of MyInfo development environment api.

  The default value should be https://sandbox.api.myinfo.gov.sg

- BaseURL_Testing is to store the base url of MyInfo testing environment api.

  The default value should be https://test.api.myinfo.gov.sg

- URL_AccessToken is the default api url for accesstoken.

  The default value should be /com/v3/token

- URL_Authorise is the default redirect url for authorization.

  The default value should be /com/v3/authorise

- URL_Person is the default api url for retrieving person details.

  The default value should be /com/v3/person


Service Actions Usage:

- GenerateAuthorizationURL

  Input:

  MyInfo_Auth_Request_Struct

  - Redirect_Uri: this is the information of callback url. For testing using sample from myinfo, please use "http://localhost:3001/callback"

  - ClientId: this will be the client id information from myinfo.

  - Purpose: state the purpose of requesting the data. This will be shown to the Entity when requesting for their consent.

  - State: identifier to reconcile query and response. This will be sent back to you via the callback URL. Use a unique system generated number for each and every call.

  MyInfo_Auth_Scope_Struct

  - Uinfin: set to true if retrieving unifin information.

  - Name: set to true if retrieving name information.

  - Sex: set to true if retrieving sex information.

  - Race: set to true if retrieving race information.

  - Nationality: set to true if retrieving nationality information.

  - Dob: set to true if retrieving dob information.

  - Email: set to true if retrieving email information.

  - MobileNo: set to true if retrieving mobile no information.

  - RegAdd: set to true if retrieving registered address information.

  - Marital: set to true if retrieving marital status information.

  - EduLevel: set to true if retrieving education level information.

  - ResidentialStatus: set to true if retrieving residential status information.

  - PassType: set to true if retrieving pass type information.

  To add on more, you can refer to the link below to add on more scope:

  https://public.cloud.myinfo.gov.sg/myinfobiz/myinfo-biz-specs-v2.0.0.html#section/Authentication

  

- GETPersonDetails

  - PersonId: this personId value can be retrieve from the response of PostAccessToken (POSTAccessToken.TokenPayloadRec.Subject).

  - Token: this token value can be retrieve from the response of PostAccessToken (POSTAccessToken.AccessToken).

  - ClientId: this will be the client id information from myinfo.

  - Attributes: this attribute value can be retrieve from the response of PostAccessToken (POSTAccessToken.Attribute).

  - PrivateKeyContent: this is the private key text content

  - PublicKeyContent: this is the public key text content

  

- POSTAccessToken

  - code: This is the code information from the callback url parameter.

  - Redirect_Uri: this is the information of callback url. For testing using sample from myinfo, please use "http://localhost:3001/callback"

  - ClientId: this will be the client id information from myinfo.

  - ClientSecret: this will be the client secret information from myinfo.

  - PrivateKeyContent: this is the private key text content

  - PublicKeyContent: this is the public key text content