Implementation

To get Citadel API quickly implemented in your app, test it and make it production-ready, we recommend following the step-by-step guide below:

  1. Get your API keys from Dashboard
  2. Go through Quickstart with product parameter set to employment.
  3. Review API endpoints and make test requests using Postman
  4. Implement Citadel Bridge and exchange tokens.
  5. Implement API to collect verified data.
  6. Test your implementation, refer to Testing.
  7. Processing of documents such as PDF files from payroll providers can take time if account has a lot of data. Make sure you account for data processing times.
  8. Use Callbacks to track events inside Citadel BridgeCitadel Bridge - 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.. Callbacks will allow you to have funnel analytics.
  9. Check all boxes in Launch checklist and you're ready to go live!

Did this page help you?