Registration

Firstly, you will need to register your client on the sgID Developer Portal. This will provide you with the OAuth 2.0 credentials necessary to authenticate your client with sgID, as well as a private key to decrypt user data. Click the link below to visit the developer portal and begin the registration process.

LogosgID Developer Portaldeveloper.id.gov.sg

To register your client, you need to:

  1. Login to the sgID Developer Portal with your Singpass mobile app

  2. Register a new client

  3. Download your new client credentials

Step 1: Login to the sgID Developer Portal with Singpass

Click on 'Get Started' to login to the developer portal with Singpass

Before you can register your client, you will have to login to the sgID Developer Portal using your Singpass mobile app.

To be eligible for Singpass, you must be at least 15 years old and one of the following (i) Singapore Citizen (ii) Permanent Resident (iii) Foreign Identification Number (FIN) Holder If you fulfil these requirements, you can register for Singpass here.

Step 2: Register a new client

Click on 'Register new client'

When registering a client, you will be prompted to fill in the following details.

Field Name
Description

Name

Your client display name. This will be displayed to the end user when they are logging in to your app with the Singpass mobile app.

Description

A brief description of the purpose of your client application. This will be displayed to the end user when they are logging in to your app with the Singpass mobile app.

Scopes

The maximum list of scopes that your app will be authorized to access. Please refer to the Data Catalog for the full list of scopes is offered by sgID. Note: That only the scopes OpenId and NAME are available for general use. If you require more scopes, please follow the instructions here.

Callback URLs

The callback URLs that sgID will be allowed to redirect to after the end user authenticates with the Singpass mobile app. This should be the endpoint of your own application.

Please note that if you're not a public sector employee, you will only have access to two data fields: OpenID and NAME. If you require additional user data fields, please fill out this request form. Any additional data fields that are requested must adhere to our privacy and data protection policies. We will then review your request and get back to you as soon as possible.

Step 3: Download your new client credentials

Click on 'Download credentials'

After completing registration, your client credentials will be generated. Download these credentials and store them in a safe place. The fields in the credentials are as follows.

Key
Value Description

id

This is your client ID and it is a unique string that identifies your client.

secret

This is your client secret and it is a 32-character string used for exchanging the authorization code for a token.

scopes

The maximum list of scopes that your app is authorized to access which was defined during client registration.

publicKey

The RSA-2048 Public Key used by sgID to encrypt data to be sent to your application

privateKey

The RSA-2048 Private Key that will be used by your application to decrypt received data

PreviousGetting StartedNextIntegrating with sgID

Last updated