Subscribe to Check GST Register API (IRSP)
For the Check GST Register API, we have 2 environments dedicated to testing the API in Sandbox and consuming it for Production:
- Sandbox Environment (Testing) – https://apisandbox.iras.gov.sg/iras/devportal/sb/
- Production Environment (Production) - https://apiservices.iras.gov.sg/iras/devportal/
To get started, simply follow these 3 steps:
-
Step 1: Create Account in Sandbox
Please refer to the User Guide to help you with your registration process, which can be found at this link: https://go.gov.sg/iras-apiuserguide. We strongly encourage you to follow the user guide carefully for a smooth onboarding process.
-
Step 2: Register App
You must register your App to get the Client ID and Client Secret that are required to consume the API.
Ensure that the name of your registered App reflects the actual name of your software.
-
Step 3: Subscribe –
In addition to your API subscription, please proceed to provide
your use case submission via
https://go.gov.sg/iras-api-checkgstregister
At the IRAS API Marketplace, subscribe to the following API Product*:
*API Products contain API plans and APIs that you would make API calls to.
-
Step 4: Test the API
You may proceed to test the API in the Sandbox environment by referring to the API Specifications and using the test data provided in Section 4.4.
Once you are satisfied with the use of the API, go to the Production environment and repeat Steps 1 – 3. Do inform Digital_Partnerships@iras.gov.sg when you are ready to onboard to Production after making the subscription to the API product.
Please take note of our Maintenance Hours (Singapore Time) for both environments:
Sandbox (Daily Maintenance Hours) | Sandbox (Singpass / Corppass Weekly Maintenance Hours) | Production (Weekly Maintenance Hours) |
---|---|---|
Everyday 1:00 PM – 3:00 PM Everyday 8:00 PM – 10:00 PM |
Every Wednesday 3:00 PM – 11:59 PM |
Every Wednesday 2:00 AM – 6:00 AM Every Sunday 2:00 AM – 8:30 AM |
Frequently Asked Questions
-
Why do I need to sign up twice?
For security reasons, the two sites are not linked, thus, we need all developers to sign up for both environments. You would get a different and unique set of client/ secret ID set for each environment. You would need to use the correct set for each environment for the API call to work.
-
What happens if the developer who registered for the account/
application leaves the organisation?
We recommend using a generic email address (which is managed and read) for registration, so the account may be handed over accordingly without the need for re-registering and updating your application client/ secret ID. Nonetheless, you also have the option to use your individual email address if that is your preference.
-
I have registered, but my API calls are not working.
Please check that you are using the correct set of client/ secret ID for the environment you are integrating with as the credentials are unique for each environment.
Questions:
Please email us at invoicenow@billbay.co or bb.support@billbay.co