# Developer Docs

## sgID v1

- [Introduction](https://docs.id.gov.sg/1/introduction.md)
- [Background](https://docs.id.gov.sg/1/onboarding-guide/background.md)
- [Registration](https://docs.id.gov.sg/1/onboarding-guide/registration.md)
- [Integrating Using the SDK](https://docs.id.gov.sg/1/onboarding-guide/integrating-using-the-sdk.md)
- [Custom Integration](https://docs.id.gov.sg/1/onboarding-guide/custom-integration.md)
- [Potential Gotchas](https://docs.id.gov.sg/1/onboarding-guide/potential-gotchas.md): Some common issues your might face during integration
- [Testing](https://docs.id.gov.sg/1/onboarding-guide/testing.md): How to test your integration
- [White Paper](https://docs.id.gov.sg/1/white-paper.md)
- [Data Catalog](https://docs.id.gov.sg/1/data-catalog.md)
- [API Documentation](https://docs.id.gov.sg/1/api-documentation.md)

## sgID v2

- [Overview](https://docs.id.gov.sg/introduction/overview.md)
- [Getting Started](https://docs.id.gov.sg/introduction/getting-started.md)
- [Register Your Application](https://docs.id.gov.sg/introduction/getting-started/register-your-application.md)
- [Integrating With sgID](https://docs.id.gov.sg/introduction/getting-started/integrating-with-sgid.md)
- [TypeScript / JavaScript](https://docs.id.gov.sg/integrations-with-sgid/typescript-javascript.md): Integrating with TypeScript and JavaScript Node.js applications
- [Framework Guides](https://docs.id.gov.sg/integrations-with-sgid/typescript-javascript/framework-guides.md)
- [Express (with Single-Page App frontend)](https://docs.id.gov.sg/integrations-with-sgid/typescript-javascript/framework-guides/express-with-single-page-app-frontend.md): Integrating an Express server with sgID
- [Next.js (client-side rendering)](https://docs.id.gov.sg/integrations-with-sgid/typescript-javascript/framework-guides/next.js-client-side-rendering.md)
- [Next.js (server-side rendering)](https://docs.id.gov.sg/integrations-with-sgid/typescript-javascript/framework-guides/next.js-server-side-rendering.md)
- [API Reference](https://docs.id.gov.sg/integrations-with-sgid/typescript-javascript/api-reference.md)
- [Python](https://docs.id.gov.sg/integrations-with-sgid/python.md): Integrating with sgID in a Python application
- [Framework Guides](https://docs.id.gov.sg/integrations-with-sgid/python/framework-guides.md)
- [Flask (with Single-Page App frontend)](https://docs.id.gov.sg/integrations-with-sgid/python/framework-guides/flask-with-single-page-app-frontend.md): Integrating a Flask server with sgID
- [API Reference](https://docs.id.gov.sg/integrations-with-sgid/python/api-reference.md)
- [Custom Integration](https://docs.id.gov.sg/integrations-with-sgid/custom-integration.md)
- [API Documentation](https://docs.id.gov.sg/integrations-with-sgid/api-documentation.md): A list of API endpoints supported by sgID.
- [Troubleshooting](https://docs.id.gov.sg/integrations-with-sgid/troubleshooting.md): Some common issues your might face during integration
- [Protocols](https://docs.id.gov.sg/learn-the-basics/protocols.md)
- [OAuth 2.0 and OpenID Connect](https://docs.id.gov.sg/learn-the-basics/protocols/oauth-2.0-and-openid-connect.md)
- [sgID](https://docs.id.gov.sg/learn-the-basics/protocols/sgid.md)
- [White Paper](https://docs.id.gov.sg/learn-the-basics/protocols/sgid/white-paper.md): The White Paper describes the design goals of the sgID protocol, and goes into detail on the protocol specifics and how it meets these design goals
- [Integration Patterns](https://docs.id.gov.sg/learn-the-basics/integration-patterns.md)
- [Web Server and SSR Frontend](https://docs.id.gov.sg/learn-the-basics/integration-patterns/web-server-and-ssr-frontend.md)
- [Backend for Single-Page App (SPA) Frontend (BFF)](https://docs.id.gov.sg/learn-the-basics/integration-patterns/backend-for-single-page-app-spa-frontend-bff.md)
- [User Migrations](https://docs.id.gov.sg/important-updates/user-migrations.md): This page documents all the breaking changes made to sgID, and contains step-by-step migration guides for existing users.
- [TypeScript SDK v2.0 Major Release](https://docs.id.gov.sg/important-updates/user-migrations/typescript-sdk-v2.0-major-release.md): This document documents the major changes introduced in v2.0.0 sgID TypeScript SDK, and serves as a step-by-step guide for existing v1.x.x sgID TypeScript SDK users to upgrade their version to v2.x.x.
- [Data Catalog](https://docs.id.gov.sg/data-catalog.md): What data fields / scopes are provided by sgID?
- [FAQ (Developers)](https://docs.id.gov.sg/faq-developers.md): Frequently asked questions
- [FAQ (Users)](https://docs.id.gov.sg/faq-users.md): Frequently asked questions
- [Contact](https://docs.id.gov.sg/contact.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on a page URL with the `ask` query parameter:
```
GET https://docs.id.gov.sg/introduction/overview.md?ask=<question>
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.