Sign with Singpass
Singpass Developer DocsAsk a Question
  • START HERE
    • Overview of Sign
    • How do our Digital Signatures work?
    • Frequently Asked Questions
  • FOR USERS
    • How to sign
    • Verifying Sign with Singpass Signatures
      • Loading Singpass Root Signing Certificate
  • FOR RELYING PARTIES
    • Use Cases
    • Getting Started
      • How to Onboard our API
      • Digital Signing Partners
        • Docusign
        • Tungsten Automation
        • OneSpan
        • Tessaract Technologies Pte Ltd
        • Netrust Pte Ltd
        • Modus Consulting
        • Redoc.co by Real Estate Doc Pte Ltd.
        • CrimsonLogic
        • Zoho Sign
        • Securemetric Technology Pte. Ltd.
        • Rently Pte. Ltd.
    • API Documentation
      • Document Signing V3
        • Initiate Sign Request
        • Redirect From Sign with Singpass
        • Accept Success Signing Webhook
        • Get Signing Result
        • JWKS Specification
        • Sign Portal
      • Document Signing V1
      • Transaction Signing
        • Embedding Singpass JS
        • Init Transaction Signing
        • Exchange Transaction Signature
    • UX Guidelines
      • User Journey Illustration
    • Support
Powered by GitBook
On this page
  • Onboard onto Sign Staging
  • Integration Checklist
  • Request for Production Access

Was this helpful?

  1. FOR RELYING PARTIES
  2. Getting Started

How to Onboard our API

PreviousGetting StartedNextDigital Signing Partners

Last updated 5 days ago

Was this helpful?

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 .

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

  1. After successful testing,

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 )

    • 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:

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, .

4

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

Please submit our staging onboarding form at:

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 .

Integration Checklist

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

Request for Production Access

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

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
read the documentation here
Step 2 of How to Sign
Webhook URL
JWKS URL
Redirect URL
please follow this guide
https://go.gov.sg/sign-onboarding
partnersupport.singpass.gov.sg
initiate a signing request
webhook call
get signing result endpoint
Onboard for staging API access
request for production access