Check GST Register(Sandbox)

Check GST Register(Sandbox) 1.0.5

The Check GST Register API enables you to check whether businesses are GST-registered based on their GST registration number, UEN or NRIC.

production
development
https://apisandbox.iras.gov.sg/iras/sb

Custom Gateway API Endpoint

Paths

/SearchGSTRegistered

post /SearchGSTRegistered
Client ID
X-IBM-Client-Id
(apiKey located in header)
Client Secret
X-IBM-Client-Secret
(apiKey located in header)
body
Optional in body
object
Request
Content-Type
Optional in header
string
application/json
Accept
Optional in header
string
application/json
200
Response
Example Request
Example Response
POST https://apisandbox.iras.gov.sg/iras/sb/GSTListing/SearchGSTRegistered

Definitions 

{
    "properties": {
        "clientID": {
            "type": "string",
            "description": "Secret Client ID"
        },
        "regID": {
            "type": "string",
            "description": "Registration ID"
        }
    }
}
              
{
    "properties": {
        "returnCode": {
            "type": "integer",
            "description": "Return Code"
        },
        "data": {
            "type": "object",
            "properties": {
                "name": {
                    "type": "string",
                    "description": "Name of Organization"
                },
                "gstRegistrationNumber": {
                    "type": "string",
                    "description": "GST Registration Number"
                },
                "registrationId": {
                    "type": "string",
                    "description": "Registration ID"
                },
                "RegisteredFrom": {
                    "type": "string",
                    "format": "date",
                    "description": "Registered From"
                },
                "RegisteredTo": {
                    "type": "string",
                    "format": "date",
                    "description": "Registered To"
                },
                "Status": {
                    "type": "string",
                    "description": "Status"
                }
            }
        },
        "info": {
            "type": "object",
            "properties": {
                "message": {
                    "type": "string",
                    "description": "Generic error message"
                },
                "messageCode": {
                    "type": "integer",
                    "description": "Generic error message code"
                },
                "fieldInfoList": {
                    "type": "array",
                    "items": {
                        "type": "object",
                        "properties": {
                            "field": {
                                "type": "string",
                                "description": "Field having the error"
                            },
                            "message": {
                                "type": "string",
                                "description": "Type of error faced"
                            }
                        }
                    }
                }
            }
        }
    }
}