CustomerOnboarding

​

Company Onboarding Flow

​

Overview

You can integrate a new company into the system using either a One-Step or Multi-Step onboarding approach.

​

⚠️ Note:

At least one employee must be added during onboarding. This is essential to configure payroll, assign roles, and activate workflows.

​

🚀 One-Step Onboarding Process

Use the createBusiness API to streamline the entire company onboarding process into a single call.

​

Included Operations:

• Register the company
• Add an admin user
• Submit KYB (Know Your Business) information
• Set company location
• Initiate KYB verification

​

📝 Important:

Ensure accurate companyLocation and kybInformation details (as described in Steps 3 and 4 of the Multi-Step Process). ✅ Recommended if you prefer a simplified onboarding flow with fewer API calls.

​

🧩 Multi-Step Onboarding Process

Use this method for more granular control and visibility into each stage of the onboarding flow. This ensures full compliance, flexibility, and traceability.

​

🔹 Step 1: companyRegistration

Purpose: Create the company profile. Details:

• Initializes a new company
• Creates a default admin user
• Returns a unique companyId for subsequent steps

​

🔹 Step 2: updateAdminUser

Purpose: Update details of the default admin user. Details: Optional updates: first name, last name, email, phone Required fields:

• address1, city, state, zipcode, country, ssn, dateOfBirth, payrollAdmin, beneficialOwner, ownershipPercentage

Ensures correct contact information is associated with the company.

​

🔹 Step 3: addKybInformation

Purpose: Submit KYB data for regulatory compliance. Details:

• Required fields include entity type, registration number, incorporation date, etc.
• Enables KYB verification

​

Supported Entity Types:

• C Corp
• S Corp
• LLC
• Single Member LLC
• LLP
• Partnership
• Sole Proprietor
• Non-Profit

​

⚠️ Important:

Choose the entity type that matches the company’s legal registration.

​

🔹 Step 4: addCompanyLocation

Purpose: Set up the company’s primary physical location. Details:

• Location types: Main, Branch, or Corporate
• Required for regional compliance, tax jurisdiction, and audit readiness

​

🔹 Step 5: initiateKyb

Purpose: Trigger KYB verification. Details:

• Returns status: PENDING, VERIFIED, or FAILED

​

🔹 Step 6: Add Company Bank Account

Purpose: Connect a valid bank account for payroll transactions. Options: 1. Manual Entry with Microdeposit Verification

• Fields: Account Number, Routing Number, Bank Name, Account Type, etc.

2. Plaid Integration

• Securely connect bank accounts via Plaid
• Automatically fetches and verifies banking details

🔐 Only verified bank accounts are eligible for payroll disbursement.

​

🔹 Step 7: Add Pay Schedule

Purpose: Define payment frequency and pay period configuration.

• For more information about Payroll check out our Payroll Guide

Details:

• Frequencies: Weekly, Bi-Weekly, Semi-Monthly, Monthly
• Set payBeginDate, payEndDate, and payDay

🔁 For Semi-Monthly/Monthly frequencies, use the getPayBeginDates API or reference the Payroll Calendar. ✅ Once these steps are completed, the company is considered onboarded and can access all platform features based on verification status.