Build Options: Console, Components, vs API
Explore different onboarding methods using Console, Components, or API for efficient setup.
Help Center Articles to reference:
Detailed Breakdown
Console | Component | API |
Purpose:
Manual configuration of company and employee setup via the UI.
Steps:
• Use API or Console to create company and employee records.
• Configure tax setup, payment info, withholdings, deductions, and upload YTD payroll via spreadsheet.
• Submit for Check review.
Ideal for:
Partner-led implementation teams managing each setup step manually in a centralized UI. | Purpose:
Employer-facing, link-based UI components that collect setup information (e.g., payment info, company details, tax auth).
Steps:
1. Generate one-time links for signatories to complete sections.
1. Filing Authorization
2. Terms of Service
3. Payment Info
4. Tax Setup
5. Previous Provider Access (PPAC) for Embedded Setups
2. All links expire in 24 hours and are employer-visible only.
Ideal for:
Sharing specific steps with employers or using in embedded payroll experiences. | Purpose:
End-to-end programmatic control of company, tax, and employee setup.
Steps:
• Use a sequence of API calls: /companies, /workplaces, /employees, /employee_tax_parameters, etc.
• Upload YTD via /external_payrolls.
• Submit via /start_implementation.
• Generate and send signature components via API.
Ideal for:
Partners with engineering resources looking to automate the entire setup process within their platform. |
When to Use What?
- Console: You want direct control over setup without engineering involvement.
- ✅ Pros: No-code solution, Great for early stage or low volume, Useful for training and exceptions
- ❌ Cons: Manual effort, Doesn’t scale well, Less customizable
- API: You want complete automation and have the technical resources to build a full workflow.
- ✅ Pros: Full control over UX, Automation-friendly, Seamless product integration
- ❌ Cons: Requires engineering resources, Higher upfront investment
- Components: You want employers to self-complete certain tasks (e.g., bank info, filing auth).
Did this answer your question?
😞
😐
🤩