Singpass
Singapore's eID https://www.singpass.gov.sg/main/
Verify
Client ID in x-client-id header.
Client Secret in x-client-secret header.
Redirect URI after user authorization.
Browser: HTTPS URL to your website.
iOS: HTTPS Universal link
Android: Package name (com.filleasy.app)
https://www.yourwebsite.com/callbackQR code type
Start timestamp in milliseconds (must be >= current time)
End timestamp in milliseconds (must be > start time)
Duration in milliseconds (positive integer)
Format of the response (url, qr, or both)
bothPossible values: Success
JWT token for polling
Singpass verification URL
QR code data URL
Bad Request - Invalid input parameters
POST /sgid/request/qr HTTP/1.1
Host: sandbox.staging-api.fill-easy.com
x-client-id: YOUR_API_KEY
x-client-secret: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 74
{
"redirect": "https://google.com",
"type": "dynamic",
"responseFormat": "both"
}{
"token": "text",
"url": "text",
"qrUrl": "text"
}MyInfo enables relying party to retrieve personal details.
Client ID in x-client-id header.
Client Secret in x-client-secret header.
attributes to be requested from user
Redirect URI after user authorization.
Browser: HTTPS URL to your website.
iOS: HTTPS Universal link
Android: Package name (com.filleasy.app)
https://www.yourwebsite.com/callbackSuccess
Error
POST /sgid/request/auth HTTP/1.1
Host: sandbox.staging-api.fill-easy.com
x-client-id: YOUR_API_KEY
x-client-secret: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 66
{
"attributes": [
"openid",
"uinfin"
],
"redirect": "https://google.com"
}{
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzZXJ2aWNlIjoiTXlpbmZvIiwiaWRlbnRpZmllciI6InpYbWpubTRsMXVMYmVjbF83MkFJd003ZDVLUDMydXhjLWdjMDZkcWstYmsiLCJsYXN0TW9kaWZpZWRUaW1lIjoxNzUzODQ1ODg5MTI1LCJpYXQiOjE3NTM4NDU4ODl9.XA06zmB0rigt0cjqb4hmYmZuU4DiV85eEch7VuLRixU",
"url": "https://staging.fill-easy.com/canary/sgid/redirect?client_id=tizjwARibgcXmjdcP6Q6nWG5lSQoLow0&scope=uinfin%20name%20mobileno%20email%20dob%20residentialstatus%20nationality%20occupation%20regadd%20sex%20openid&code_challenge=zXmjnm4l1uLbecl_72AIwM7d5KP32uxc-gc06dqk-bk&redirect_uri=https://staging.fill-easy.com/canary/sgid/callback/person"
}enables business-to-business use case for retrieval of corporate data and applicant's personal data.
Client ID in x-client-id header.
Client Secret in x-client-secret header.
attributes to be requested from user
Redirect URI after user authorization.
Browser: HTTPS URL to your website.
iOS: HTTPS Universal link
Android: Package name (com.filleasy.app)
https://www.yourwebsite.com/callbackSuccess
POST /sgid/request/auth-biz HTTP/1.1
Host: sandbox.staging-api.fill-easy.com
x-client-id: YOUR_API_KEY
x-client-secret: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 104
{
"attributes": [
"name",
"basic-profile",
"financials",
"uinfin",
"capitals"
],
"redirect": "https://google.com"
}Success
{
"url": "text",
"token": "text"
}This is the URL that /sgid/request/auth returns. It stores a cookie on the user's browser and redirects to Singpass authorization site.
Space-separated scopes forwarded to /auth.
Callback URL forwarded to /auth. Passed through without re-encoding.
Redirect to Singpass authorization
No content
GET /sgid/redirect?client_id=text&code_challenge=text&scope=text&redirect_uri=text HTTP/1.1
Host: sandbox.staging-api.fill-easy.com
Accept: */*
Redirect to Singpass authorization
No content
This is the callback URL that Singpass redirects to after user authorizes the data request.
RFC 9207 issuer identifier (FAPI 2.0). Validated against the configured Singpass issuer.
Redirect to client application
No content
GET /sgid/callback/person HTTP/1.1
Host: sandbox.staging-api.fill-easy.com
Accept: */*
Redirect to client application
No content
This is the callback URL that Singpass redirects to after user authorizes the data request.
Redirect to client application
No content
GET /sgid/callback/person-biz HTTP/1.1
Host: sandbox.staging-api.fill-easy.com
Accept: */*
Redirect to client application
No content
This is the callback URL that Singpass redirects to after user authorizes the data request.
Redirect to client application
No content
GET /sgid/callback/verify HTTP/1.1
Host: sandbox.staging-api.fill-easy.com
Accept: */*
Redirect to client application
No content
That endpoint is used to obtain the requested data.
Client ID in x-client-id header.
Client Secret in x-client-secret header.
The token received on the first request.
2dmR0VVufvic0vrVIluVBVi1EXtkCwIZ331as0EmOK - Data successfully retrieved
Status message
URL that should be shown to the user (usually as a QR code)
Used to poll requested data
Pending - Data not yet available
Bad Request - Invalid request body. Ensure that your request body complies with the requirements.
No credentials - Unauthorized. Ensure that you use the correct authorization process.
POST /sgid/callback/client HTTP/1.1
Host: sandbox.staging-api.fill-easy.com
x-client-id: YOUR_API_KEY
x-client-secret: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 52
{
"token": "2dmR0VVufvic0vrVIluVBVi1EXtkCwIZ331as0Em"
}{
"message": "Success",
"token": "eyJlbmMiOiJBMTI4Q0JDLUhTMjU2IiwiYWxnIjoiRUNESC1FUytBMjU2S1ciLCJraWQiOiJhd2htd2lpSFZtWHlDbVQ0STNTbHNGMFlaR3hQaTdZNlpZN2k3MWFKT29VIiwiZXBrIjp7Imt0eSI6IkVDIiwiY3J2IjoiUC0yNTYiLCJ4IjoiUG1hdnNVbm1PWm5VZ1hPbVp0NFFaZlhzV29aYzNCSWZwc1k2cEZvdlNVayIsInkiOiJSOWJsWHgyRWRhc0ZRZS1jdmNIZjRLRlVtNHdENnU1dWtLT0ZCQWNxbFBjIn19.GUSFK_egIc_vQFFmNU-D8MeRHvTusZimikIgQ1Ya1aTXBgQuL_2yag.vI1LENahMwXvoMWixrENnQ.vyrQ0uRek_3fcKiAEtbW1sXnGKtmOPBfs7As1SbSpiP6PhrzsKjcrAc-EvVYTjnm_FAQkVQLTgPnue9iF91D8BHKeDdTJGBrBSRJnhmwPDqnAyr-8cMCNCLz1nc_BbY4sbCUd5nookypqYAIF_PjZwKF1hmSZK2xObQhevBVC-A--cAFmRMcOx82wYgSFbMOQbJrlEcc_V0VOGvMm5bgXsjwcmCbPVNSi9Y06vo3lMcwVHuvphV8nPx78V1nOx96VLFyVihLAVE3lfBNBFA97lEU75ICox67yQPrmN8KXnfB1QiWZL2pTM3VvNBgDSa0ik68IBCTaNtFL4XYxxW8-K3SIuUdrHjmNjJ75Bkw_N1WFHZpfTHnuRuqlMGyxe7Mcmozrm6q87lKBqZzEdtRhY8GLbs4SdWaLk0l4qbOSKmll-DoD1wqOGcFRg2Q-t5RbKUOUg3BI0-8WP5i-NKjPQ.9LGHH6HcuS9UAZ_Npk70fw"
}Last updated