Instantly access employee directory

Citadel API enables HR admins to easily connect their payroll accounts and Instant access to the employee directory.

  • All integrations are readily available via a single API
  • No additional maintenance required
  • Structured high quality data in a consistent format

Instantly access employee directory

With Citadel, users can easily connect their payroll account to share information with your app, verify their employment and income, switch direct deposit and more.

  • All integrations are readily available via a single API
  • No additional maintenance required
  • Structured high quality data in a consistent format

Don’t sweat integrations —we got you covered

Go live in a week

Easy to build integrations with low costs and reduced times to go-to-market

Reduce maintenance cost

No additional cost

Consistent data formats

Standardize payroll data formats regardless of the provider

Business development time

Normalize payroll data access across all providers

Simplified access to company employee directory

Simplified access to company employee directory

User selects their payroll provider

Citadel supports 35 most commonly used payroll providers, offering 85% coverage of the US workforce.

Users enter credentials

Citadel handles security questions and 2FA right in the app, connecting to their data in under 15 seconds.

Citadel connects the account

Citadel takes the final steps to access, organize, and deliver the data to you either via API or to your Citadel dashboard.

Developing with Citadel is a breeze

We agonize over the right abstractions so you can implement Citadel in an afternoon with a few lines of code.

Developing with Citadel API is a breeze

We agonize over the right abstractions so your teams don’t need to stitch together disparate systems or spend months integrating payments functionality.

Documentation

Our documentation, like our API, is built by developers, for developers.

View docs →

API keys

Sign up with the Citadel API Dashboard and get instant access to API keys.

Get API keys →

<html>
<head>
    <!-- Step 1 - add the Bridge library to your app with a script tag -->
    <script src="https://cdn.citadelid.com/bridge.js"></script>
</head>
<body>
<script>
  // Step 2 - Call your back end to retrieve a bridge_token from citadel
  const bridgeToken = <%= Value returned by API call to acquire bridge_token %>
	// Step 3 - Initialize Bridge
  const bridge = CitadelBridge.init({
        bridgeToken: bridgeToken.bridge_token,
        onLoad:function(){
          // Optional, called when Bridge loads
          console.log('Bridge loaded')
        },
        onSuccess:function(public_token, metadata){
          console.log('success handler')
          // Send the public_token to your server to exchange for an access_token
          // and retrieve payroll data.
          // The metadata object contains info about the Link.
          console.log("token: ",public_token)
          console.log("metadata: ", metadata)
        },
        onEvent: function(event_type, payload) {
          // all events fire this function. event_type indicates what the event is,
          // payload has additional information depending on the event.
          console.log('event: ', event_type)
          console.log('payload: ', payload)
        },
        onClose:function(){
          // Optional, called when Bridge is closed by the user.
          console.log('Bridge closed')
        }
    })
</script>
<!-- Normal page content -->
<!-- Step 4 - Create a button or action that calls bridge.open() to Bridge -->
<button type="button" id="button" onclick="bridge.open()">
  Connect
</button>
</body>
</html>

Compliance to InfoSec best practices

Strict security standards

Citadel API is SOC 2 Type 2 compliant. We’re currently undergoing Fannie Mae's D1C certification.

Robust
monitoring

We leverage Vanta, leading SOC2 continuous monitoring software to stay compliant and secure.

End-to-end
encryption

Data transmitted is kept safe using SSL standards. We use 256-bit AES encryption at rest and TLS 1.2+ in transit.

Pay only for successful connections

View pricing