File format/ specifications for YA 2025 submission
AIS Application Programming Interface (API) Service Specifications
- The server/ software/ application must be able to meet the pre-requisites to:
- Support the following protocols: HTTP/2, TLS 1.2/1.3, and
- Trigger HTTP/GET and HTTP/POST requests.
- Support the following protocols: HTTP/2, TLS 1.2/1.3, and
- The server/ software/ application must have a Callback URL to redirect users to the payroll software after Corppass login and consent. The Callback URL must use Fully Qualified Domain Name (FDQN), and meet all of the following requirements:
- Must be able to accept parameters,
- Must not contain IP address, port number, Hash (#) or Wildcard (*) characters, and
- Must not be the same URL for Sandbox and Production environments
- Must be able to accept parameters,
Supporting AIS-API on API Marketplace | Supporting AIS-API on APEX |
---|---|
API Services Interface Specifications for CorpPass Authentication (PDF, 580KB) | CorpPass Authentication - OAuth on APEX |
APl Service Interface Specifications for "Submission of Employment Income Records (Corppass)" (PDF, 374KB) | API Service Interface Specifications for “Submission of Employment Income Records (APEX)” (PDF, 363KB) |
AIS (Corppass) API Onboarding Guide (PDF, 1.1MB) | APEX AIS API Onboarding Guide |
API Sandbox Portal | APEX |
API Production Portal | FAQ on AIS-API Migration to APEX and Upcoming Activities (PDF, 264KB) |
Additional file format specifications
Your payroll system must be able to support at least one of the formats (TXT and/or XML). If your payroll system supports the XML format only, you may refer to the “specifications of TXT files for all forms” document as a reference for the business rules that apply to the corresponding fields of the XML format.
Supporting Text file format (.txt) | Supporting Extensible Markup Language file format (.xml) |
---|---|
Specifications of TXT files for all forms (ZIP, 1.08MB) | XML schema for all forms (ZIP, 18KB) |
Sample TXT for all forms (ZIP, 2KB) | Sample XML for all forms (ZIP, 7KB) |
Additional specifications for both TXT and XML file formats (PDF, 376KB) | Additional specifications for both TXT and XML file formats (PDF, 376KB) |
List of recommended controls (PDF, 140KB) | List of recommended controls (PDF, 140KB) |
Country/Region, Citizenship and Bank code (PDF, 134KB) | Country/Region, Citizenship and Bank code (PDF, 134KB) |
[NEW!] Technical specifications for AIS-API 2.0
IRAS will be making enhancements to the AIS-API (‘AIS-API 2.0') to streamline the AIS submission process. With effect from 3Q 2025, AIS submissions must be made via AIS-API 2.0. Payroll software vendors or AIS employers who are using an in-house payroll software and would like to support/ submit employment records through API can refer to the technical specifications “Submission of Employment Income Records 2.0 (AIS-API 2.0)” to prepare your software.The AIS-API 2.0 will be available for subscription and testing on APEX from 2Q2025. Developers are encouraged to commence onboarding to APEX now to familiarise with the platform.
There are major changes introduced in AIS-API 2.0. Existing payroll software vendors and AIS employers can refer to a summary of the key changes below:
1. Submission format
2. Submission size
3. Amendment Submission
This allows your payroll software to generate amendment records with revised data to overwrite previous submissions of the affected record(s).
4. Back years records
5. IR8A and Appendices
6. IR8A
All amount fields will only accept value in Number (9).
- If decimals exist for income fields, to round down the amount to the nearest dollar.
- If decimals exist for deduction fields, to round up the amount to the nearest dollar.
The following data items will not be required:
- Citizenship
- Formatted Address (Block/ House No., Street name, Level No., Unit No., Postal Code)
- Cessation Provision Indicator
- Compensation for loss of office Indicator
- Gratuity/ Notice Pay/ Ex-gratia payment/ Others indicator
- Period of Gross Commission payment
- Commission Payment Type
- Breakdown for Allowances items: Transport, Entertainment and Others
- Approval obtained from IRAS for loss of office compensation
- Approval date on compensation for loss of office
- Pension (combine ‘Pension’ with ‘Retirement benefits’)
7. Appendix IR8S
Form IR8S will not be required.
Please note that interest on refund of employee’s CPF contribution remains taxable. Any refund claim amount must be submitted under the item ‘Allowances’ in the IR8A form.
8. Appendix 8A
All amount fields will only accept values in Decimal (7,2) . If the total Benefits-in-kind amount contains decimals, drop the decimals when populating into the corresponding field in IR8A.
9. Appendix 8B
The maximum number of Employee Equity-Based Remuneration Scheme (EEBR) records allowed per employee will be increased to 30, up from 15.
Number of shares, Exercise price and OMV per share at exercise date will only accept values in Decimal (9,5).
All the Gross Amount of Gains fields will only accept values in Decimal (9,2).
If the Total Gains and Profits amount from Share Options for S10(1)(b) and S10(1)(g) contain decimals, drop the decimals when populating the amount into the corresponding field in IR8A.
The following data items will not be required:
- Open Market Value Per Share as at the Date of Grant of ESOP/ESOW Plan
- Gross amount qualifying for income tax exemption for stock option plans under ERIS
- Gross amount not qualifying for tax exemption
- Date of Incorporation for ERIS (for start-up only)
The calculation of the gross amount of gains from ESOP/ESOW Plan will also be adjusted correspondingly.
For enquiries on the Technical File Format/ Specifications, email us at [email protected].
FAQs
Will there be changes to the technical file format when IRAS makes changes to the Form IR8A and/ or appendices?
Tax changes and new government initiatives may result in changes to the technical file format/ specifications. We will publish the changes on our website by Aug every year and inform all AIS payroll software vendors via email.
Are there any requirements for API integration?
Yes, our API endpoints have to be triggered from a Server-to-Server connection. Your server/ software/ application must be able to:
- Support the following protocols: HTTP/2, TLS 1.2/1.3, and
- Trigger HTTP/GET and HTTP/POST requests.
A Callback URL is also required to redirect users to the payroll software after Corppass login and consent. The Callback URL must use Fully Qualified Domain Name (FDQN), and meet all of the following requirements:
- Must be able to accept parameters,
- Must not contain IP address, port number, Hash (#) or Wildcard (*) characters, and
- Must not be the same URL for sandbox and production environments.
There are differences between the hardcopy forms and the requirements stated in the file format. Which template should I follow to customise the printouts from my software?
Vendors should mimic the fields in the official copy of the income tax forms (https://go.gov.sg/iras-formir8a) to customise the printouts. The payroll software should be able to capture these fields’ input based on the file format specifications, and generate the printout accordingly.
For clients who are in the Auto-Inclusion Scheme (AIS), the following statement must be displayed at the top header of the form(s):
“This statement can only be issued by an employer in the Auto-Inclusion Scheme (AIS) and is for your retention. The information in this statement will be automatically included in your income tax return, so you need not declare them in your tax form. You can check if your employer is in the AIS at IRAS website, https://go.gov.sg/iras-ais-search.”
Why doesn't IRAS allow "overwriting" of previous submission when submitting amendment files?
There are instances where the same company has more than one payroll system administrated by different departments or HR personnel as the nature of income is different. For such cases, the amount given in two different files should be added and not overwritten.
To avoid confusion to the filing of employment income details, changes to the amounts must be given as the difference.
Must my payroll software be developed based on IRAS file format specifications?
Employers participating in the Auto-Inclusion Scheme can submit via 2 modes:
a) e-Submission of Employment Income
b) Provident and Tax (PAT) system
IRAS’ file format specifications are for employers submitting via a). If you plan to support employers submitting via b), you must use the file specifications provided by CrimsonLogic. For enquiries pertaining to Provident and Tax system, please contact CrimsonLogic at 6887 7888 or email to [email protected].
Must the files be encrypted as a security feature?
No. IRAS’ applications use the Secure Socket Layers (SSL) technology, which is the industry standard protocol for secure, web-based communications and transactions. SSL creates a secure communication channel between the server and the consumer’s browser. SSL provides message privacy by encrypting all information exchanged between the web server and the consumer’s browser.