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.

For more information about our API, please read the documentation here.

Onboarding Steps

1

Before you start (Prerequisites)

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

Prepare your application details

• Prepare your application's display name and logo for display to users on our Sign portal

Prepare the Sign with Singpass button

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

8KB

Sign with Singpass btn - 2 sizes.zip

archive

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

3

Technical Integration

Set up the following on your (staging) application:

• Webhook URL

• JWKS URL

• Redirect URL

4

Request for Staging access

Please complete steps 1 to 3 before requesting for staging access. You will need that information to fill in the onboarding form.

Submit a staging onboarding form at: https://go.gov.sg/sign-onboarding

You will receive a confirmation email when your request to onboard has been approved. You may then proceed to call the API endpoints.

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

5

Test your 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) Record your user journey (video + images) as part of production onboarding requirements

6

Request for Production Access

Once your staging implementation is complete and you are ready to go live, please submit our production onboarding form at: https://go.gov.sg/sign-onboarding

You should only submit the onboarding form when you have your User Journey ready, and your system's JWKS, webhook, and redirect page are functioning in production.