Data processing

Processing of documents such as PDF files from payroll providers can take time if account has a lot of data.

Endpoints to retrieve employment verification, income verification and payroll admin will return data that's instantly available after login but to get all data the best practice is to subscribe to Webhooks or poll API endpoints periodically so you can track the status of each Task and pull all available data.

Median times

Below you can see median times for availability of data by stage.

  • login ~5-15 sec
  • base parse ~ 30-60 sec
  • full parse ~ 1-5 min

Each task has a hard limit of 20 minutes to complete.

Task statuses

Task changes status over time and can fall into one of the error states at each point of the execution:

  1. login: we're authenticating on behalf of the user with a payroll provider. Usually it takes less than 10 seconds to complete.
  2. mfa: payroll provider requested additional multi-factor authentication from the user and it can take any time between 10 to 30 seconds depending on how fast the user provides the information.
  3. base_parse: we collect all basic information about identity, employment and list of paystubs with pay dates. Average time to complete is around 30 seconds.
  4. full_parse: we download paystubs, parse income and W2s. Average time to complete is under 45 seconds, but can take as much as 5 minutes. Data is processed in the background when the BridgeBridge - The client-side component that your users will interact with in order to link their payroll accounts to Citadel and allow you to access their accounts via the Citadel API. is closed after successful authentication.

Did this page help you?