How to Onboard our API

This information is for onboarding onto Sign V3. We are no longer supporting new requests to onboard onto Sign V1.

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

RPs looking to integrate directly with our API should do so in two stages:

1. Onboard for staging API access

2. After successful testing, request for production access

Onboard onto Sign Staging

1

Prepare information about your use case:

• Description of use case and estimated transaction volume

• Sample of document(s) to be signed

2

Configure your application:

Front-end:

• Consult our UX guidelines on how the "Sign with Singpass" button should be presented on your application: UX Guidelines

• Although it is not required for staging, we recommend preparing the User Journey Illustration ahead of time, as you will be required to submit this when requesting for production access

• Prepare the display name and logo for your application that will be displayed on the Sign portal (see Step 2 of How to Sign)

  • Preferred logo format: SVG

  • Alternative logo format: PNG with max width and height of about 100 pixels each

Back-end: Set up the following on your (staging) application:

• Webhook URL

• JWKS URL

• Redirect URL

3

Download Staging Singpass App

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

If you do not yet have a Singpass staging app, please follow this guide.

4

After completing the above, you are ready to request to onboard onto Sign Staging

Please submit our staging onboarding form at: https://go.gov.sg/sign-onboarding

5

Once you receive the confirmation email, you may begin your integration & testing.

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

We have put together a simple Integration Checklist to assist with your testing.

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

Integration Checklist

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

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 your system's JWKS, webhook, and redirect page are functioning in production.