Overview
This API allows taxpayer’s ERP system to retrieve the information for a specific Taxpayer based on the Base64 formatted string obtained from scanning the respective QR code.
Signature
This is REST based API that searches with Base64 encoded qrCodeText.
Signature: GET
/api/v1.0/taxpayers/qrcodeinfo/{qrCodeText}
Rate Limit
To optimize the use of our APIs, a rate limit of 60 Requests Per Minute (RPM) / Client ID is recommended.
Steps
The following are the steps that any system would need to take in order to retrieve the taxpayer’s information.
-
Scan the QR code to obtain the Base64 encoded string.
Example: NGUxYmM5MDctMjViNy00NWIxLTk2MjAtMmQ2NzFhNmY5Y2Fl -
Decode the Base64 value to obtain the qrCodeText.
Example: 4e1bc907-25b7-45b1-9620-2d671a6f9cae
Inputs
This API accepts standard e-Invoice API header parameters for authenticated call except for the one defined below:
Input parameter | Type | Description | Value example | Requirement |
---|---|---|---|---|
qrCodeText | String | Decoded Base64 string | 4e1bc907-25b7-45b1-9620-2d671a6f9cae | Mandatory |
Output
Successful Response
This API returns HTTP status code 200
.
The system would return one and only one Taxpayer’s information that is matching with the input parameter.
Parameter | Type | Description | Value Example |
---|---|---|---|
tin | String | Taxpayer’s TIN | C25480996000 |
name | String | Name of the entity | KXXX_XXXXPS BHD |
idType | String | Type of identification | BRN |
idNumber | String | Identification number | 201801011018 |
sst | String | SST number | 121 |
String | Email addresses | abc@xyz.com;def@xyz.com | |
contactNumber | String | Contact number | 09762838662 |
ttx | String | TTX number | 2121111 |
businessActivityDescriptionBM | String | Business activity description in BM | Perkhidmatan sokongan kesetiausahaan |
businessActivityDescriptionEN | String | Business activity description in EN | Secretarial support services |
msic | String | MSIC code | 82193 |
addressLine0 | String | Address line 0 | 17 JALAN JALAN CARI MAKAN |
addressLine1 | String | Address line 1 | No.1 |
addressLine2 | String | Address line 2 | line 31 |
postalZone | String | Postal zone | 06000 |
city | String | City | IPOH |
state | String | State | PERAK |
country | String | Country | TCA |
generatedTimestamp | String | Timestamp of QR code generated by taxpayer | 2025-01-02T14:52:50 |
Error Response
Error situations are reported back by this API through the standard error response.
Additional specialised error messages can be returned as a result of validation of state of the document and caller:
HTTP status code | Error code | Description |
---|---|---|
404 | NotFound | QR Code Not Found |