CPFHub API for Singapore Payroll & HR Integration

Overview

CPFHub provides a set of APIs designed to streamline interactions with the Central Provident Fund (CPF) Board in Singapore. It serves as an intermediary layer, allowing developers to embed CPF-related functionalities directly into their software applications. This includes automated submission of CPF contributions, retrieval of individual CPF statements, and access to employer-specific CPF data. The platform is engineered for businesses operating in Singapore that require integration of CPF compliance and data management into their operational workflows.

The API is primarily suited for organizations developing or utilizing payroll systems, human resource management (HRM) platforms, and financial planning tools. For payroll providers, CPFHub can automate the calculation and submission of monthly CPF contributions, reducing manual effort and potential for error. HR platforms can leverage the API to manage employee CPF information, including accessing statements for administrative purposes or employee inquiries. Financial planning applications can integrate CPF data to offer more personalized and accurate retirement and investment planning advice to users, factoring in their CPF balances and contribution history.

CPFHub aims to address the complexity often associated with government regulatory compliance by providing a standardized, programmatic interface. The platform offers a documentation portal that includes API references and guides to assist developers in integration. A Developer Sandbox is available, providing a free environment for testing and development with limited requests before committing to a paid plan. This sandbox facilitates rapid prototyping and ensures that integrations can be thoroughly validated against simulated CPF data without affecting live production systems. The platform's compliance with PDPA (Singapore) and ISO 27001 standards is intended to address data security and privacy requirements for handling sensitive financial information.

For organizations requiring a high degree of automation in their financial or HR operations within Singapore, CPFHub offers a mechanism to integrate these processes directly into their existing software architecture, potentially reducing administrative overhead and improving data accuracy. The API's utility extends beyond basic contributions, encompassing retrieval capabilities that can support more advanced data analytics and reporting for employers.

Key features

• CPF Contribution API: Allows for the programmatic submission of monthly CPF contributions for employees, integrating directly with payroll systems to automate the compliance process.
• CPF Statement Retrieval API: Enables authorized applications to retrieve individual and employer CPF statements, facilitating financial reporting and employee data management.
• Employer Dashboard: A web-based interface that complements the API, providing employers with an overview of their CPF submissions and employee data.
• Developer Sandbox: A free, limited-request environment for developers to test and integrate the API without impacting production data or incurring costs.
• Comprehensive Documentation: Provides detailed API references, integration guides, and code examples for various programming languages to assist developers during implementation.
• SDKs for Multiple Languages: Supports integration with Node.js, Python, and Java applications through dedicated Software Development Kits, simplifying API calls.

Pricing

CPFHub offers a tiered pricing structure that scales with usage, primarily based on transaction volume. A free Developer Sandbox is available for testing purposes.

Pricing data as of 2026-05-28. For detailed pricing information and current transaction limits, refer to the official CPFHub pricing page.

Common integrations

• Payroll Systems: Integrates with various payroll software to automate the calculation and submission of CPF contributions, as detailed in the payroll integration guide.
• HR Management Platforms: Connects with HRIS (Human Resource Information Systems) to manage employee CPF data, retrieve statements, and ensure compliance.
• Financial Planning Tools: Allows financial applications to access CPF statements and contribution histories for comprehensive financial analysis and retirement planning.
• Enterprise Resource Planning (ERP) Systems: Can be integrated into broader ERP solutions to centralize financial and human capital management processes.

Alternatives

• Workforce Singapore API Gateway: Provides APIs for accessing workforce-related data and services in Singapore, focusing on employment and training.
• IRAS API Developer Portal: Offers APIs for tax-related services from Singapore's Inland Revenue Authority, including tax submissions and data retrieval.
• Open Government Products: A broader initiative by the Singapore government, providing various digital services and platforms that may include data relevant to public sector data management.
• General API Gateway solutions: While not direct government service alternatives, platforms like Kong Gateway or AWS API Gateway can manage and secure API access to various internal and external services, including potentially integrating with government APIs.

Getting started

To begin integrating with CPFHub, developers can use the provided SDKs. Below is an example using the Node.js SDK to retrieve a CPF contribution statement. First, ensure you have the Node.js SDK installed via npm:

npm install cpfhub-sdk

Then, you can use the following JavaScript code to authenticate and make an API call:

const CPFHub = require('cpfhub-sdk');

const cpfhub = new CPFHub({
  apiKey: 'YOUR_API_KEY_HERE', // Replace with your actual API key
  apiSecret: 'YOUR_API_SECRET_HERE', // Replace with your actual API secret
  sandbox: true // Set to false for production environment
});

async function getContributionStatement(nric) {
  try {
    const statement = await cpfhub.cpf.getContributionStatement(nric, {
      year: 2024,
      month: 1 // January
    });
    console.log('CPF Contribution Statement for', nric, ':', statement);
  } catch (error) {
    console.error('Error retrieving CPF statement:', error.message);
  }
}

// Replace 'S1234567A' with a valid NRIC for testing in the sandbox
getContributionStatement('S1234567A');

This example demonstrates how to initialize the CPFHub client with your API credentials and then call the getContributionStatement method. Remember to replace placeholder credentials with your actual API key and secret obtained from your CPFHub account. The sandbox: true flag directs requests to the testing environment. For more detailed examples and advanced usage, refer to the official CPFHub documentation.