How to Onboard our API
Last updated
Was this helpful?
Last updated
Was this helpful?
RPs looking to integrate directly with our API should do so in two stages:
After successful testing,
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:
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 .
Once you have received access to the endpoints, we recommend performing these tasks:
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: