Developer Docs
sgID v2
sgID v2
  • Introduction
    • Overview
    • Getting Started
      • Register Your Application
      • Integrating With sgID
  • Integrations with sgID
    • TypeScript / JavaScript
      • Framework Guides
        • Express (with Single-Page App frontend)
        • Next.js (client-side rendering)
        • Next.js (server-side rendering)
      • API Reference
    • Python
      • Framework Guides
        • Flask (with Single-Page App frontend)
      • API Reference
    • Custom Integration
    • API Documentation
    • Troubleshooting
  • Learn the basics
    • Protocols
      • OAuth 2.0 and OpenID Connect
      • sgID
        • White Paper
    • Integration Patterns
      • Web Server and SSR Frontend
      • Backend for Single-Page App (SPA) Frontend (BFF)
  • Important Updates
    • User Migrations
      • TypeScript SDK v2.0 Major Release
  • Data Catalog
  • FAQ (Developers)
  • FAQ (Users)
  • Contact
Powered by GitBook
On this page
  • What is sgID?
  • Can my product integrate with sgID?
  • What data is available via sgID?
  • How much does it cost to integrate with sgID?
  • Next steps
Export as PDF
  1. Introduction

Overview

NextGetting Started

Last updated 1 year ago

What is sgID?

sgID is a Singapore government identity provider that allows Singapore residents to authenticate with applications and share government-verified data about themselves via the Singpass mobile app.

Some examples of products that have integrated with sgID are Singapore's National Health Appointment System and FormSG.

sgID comes shipped with your Singpass mobile app. That means anyone with the Singpass mobile app can log in with sgID! Check out our demo app to experience the login flow for yourself!

Can my product integrate with sgID?

sgID is publicly available for integration. Use your Singpass mobile app to log into our developer portal to generate credentials for your app!

What data is available via sgID?

By default, apps that have integrated with sgID can request for the user's full name.

The full list of data fields that sgID supports are available at our data catalog page. If your app requires access to more data fields, you can file a service request to sgID via this form.

Note that Singapore government public officers will have access to the full data catalog after they verify their email in our developer portal.

How much does it cost to integrate with sgID?

sgID is completely free to use! There are no integration or usage costs associated with sgID.

Next steps

If you're ready to try out sgID, get started here.

If you've already registered your client, start integrating with sgID.

Other shortcuts:

  • Frequently asked questions

  • Learn more about sgID

  • Contact us if you have any other questions!

Example FormSG login flow with sgID
A GIF that shows an example flow of a user logging into FormSG with sgID