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 Steps
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
Design & UX Setup
Prepare your application details
Prepare your application's and 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.
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
Technical Integration
Set up the following on your (staging) application:
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.
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.
Last updated
Was this helpful?