Payees and onboarding

This section shows you how to add the contractors and vendors you pay, invite them to Wingspan, organize them, and get them ready to be paid. It covers the payer's side (creating Payees, engagements, and requirements) and the payee's side (claiming the invitation, verifying identity, sharing tax information, and choosing where payouts go). If you used the V1 API, Payees were called collaborators and engagements were split across collaborator groups and eligibility requirements.

Read the pages in this order if you're new to V3:

1. Payees: what a Payee is, why it doesn't need a linked Account to be paid, and how its status works.
2. Invite a payee: create a Payee, send the invitation, and confirm it went out.
3. Payee account linking: how an invited person accepts, how link requests work, and how a trusted platform links Accounts directly.
4. Engagements: Engagement templates, the PayeeEngagement that assigns a Payee to one, engagement types, and the engagement lifecycle.
5. Worksites: the physical locations your employees work at, and how to assign them to Employee engagements.
6. Requirements and eligibility: define the documents, signatures, and checks a Payee must complete, and read whether an engagement can be paid.
7. Groups: put Payees into named cohorts.
8. Identity verification: run and read KYC and KYB verification for an Account or Person.
9. Tax information: collect a tax identity as a ComplianceEntity, how a W-9 is produced from it, and how a payee shares tax information with a payer.
10. Payout methods: bank accounts, debit cards, and payout settings, from both the payee's side and the payer-managed side.

Related sections:

• Recipe: create a payee and Recipe: onboard a staffing workforce walk through complete flows.
• Batches and bulk operations covers importing many Payees at once.
• Send payments covers paying a Payee once they're ready.