How to Onboard our API

This information is for onboarding onto Sign V3. Do note that we are no longer supporting new requests to onboard onto Sign V1.

Onboarding for Sign V3 is open. Please follow the steps below to onboard via the Singpass Developer Portal.

Onboarding Steps

1

Before you start (Prerequisites)

Get Access to Singpass Developer Portal (SDP)

• Sign with Singpass integrations are managed via SDP
• 👉 How to get access to developer.singpass.gov.sg

Download Singpass Staging App (guide here)

• You need a Singpass Staging App to test that your application is successfully redirecting users to the Sign portal, and that they can sign with their Singpass app.

Gather information about your use case

• Description of use case and estimated transaction volume
• Sample of document(s) to be signed

2

Design & UX Setup

Download the Sign with Singpass button

• The Sign button is available to download in 2 sizes here.

Sign with Singpass btn - 2 sizes.zip

archive · 8KB

Open

• If you want to customise the Sign button e.g. change the button font to your brand font, please consult the section Implementing the Sign with Singpass button in our UX Guidelineson how to implement the button in your application

Prepare your application details

You can define the App Name and Logo that will be displayed to users on our Sign portal. Logos must meet the following requirements:

• PNG format
• Square (1:1 ratio) dimension
• Min size: 256px by 256px
• Max size: 512px by 512px in size.

Note: Entity Name cannot be changed, it is based on the UEN associated with your Singpass Developer Portal account.

Prepare your user journey

As part of your app creation in the production environment, you are required to submit a User Journey that illustrates how your digital service will use the Sign with Singpass API.

Singpass sign user journey template [Updated May 2026].pptx

archive · 2MB

Open

3

Technical Integration

Set up the following resources in your own staging environment:

• Webhook URL
• JWKS URL
• Redirect URL

4

Request for Staging access

1. Log onto Singpass Developer Portal
2. Toggle to the Staging Environment
3. Click "New App" and select "Sign with Singpass"
4. Enter in the details you have prepared in Steps 1-3

If you encounter any issues, please submit a request at partnersupport.singpass.gov.sg.

5

Test your staging integration

Once you have received access to the endpoints, we recommend performing these tasks:

• Check that you can initiate a signing request
• Complete a signing request (with your Staging Singpass app) and check that your application's webhook is successfully called
• Retrieve the signed document from the webhook call
• Check that you can call the get signing result endpoint
• (Upon smooth integration) Take screenshots of your end-to-end flow to complete the user journey document

6

Request for Production Access

Once your staging implementation is complete and you are ready to go live:

1. Log onto Singpass Developer Portal
2. Ensure you have done the following:

   1. Agreed to the Singpass Services Agreement (instructions here)
   2. Updated your billing contact details (instructions here)
3. Toggle to the Production Environment
4. Click "New App" and select "Sign with Singpass"
5. Enter in the details you have prepared for your production application
6. Once your production app has been approved, you can start testing and using your integration.

⏳ Note: Production App approval may take up to 2 weeks. Please plan your rollout timeline accordingly.