For AI agents: visit https://docs.wingspan.app/v3.0/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.

Jump to Content

Home Guides Recipes API Reference

API Reference

Home Guides Recipes API Reference

Platform

Operations
- Poll an async operationget
Events
- List platform eventsget
- Get an eventget
Webhooks
InboundWebhooks
- Receive an inbound vendor webhookpost
WebhookEventTypes
- List the webhook event-type catalogget
Batches
DataExports
AccountingConnections
AccountingReferenceData
FeatureFlags
Notifications
NotificationSubscriptions
AuditLogs
- List audit log entriesget
- Get an audit log entryget
ApiRequestLogs
- List API request logsget
- Get an API request log entryget
Reports
CustomFields
Customization
- Get Organization brandingget
- Update Organization brandingpatch
Tags

Identity & Access

Persons
Accounts
Organizations
ComplianceEntities
Stakeholders
Sessions
Mfa
SSO
- Initiate enterprise SSO loginpost
- Handle SSO callbackpost
OAuth
ApiKeys
ServiceAccounts
Roles
Authorizations

Onboarding & Verification

IdentityVerifications
IdentityVerificationMonitors
Monitors
IdentityVerificationAlerts
PayeeEligibilityRequirements
EligibilityRequirements
EligibilityRequirementGroups
Requirements
RequirementDefinitions
RequirementDefinitionGroups
Acknowledgements
ReferenceData
Onboarding

Compliance & Tax

Forms
FormSchemas
- List form schemasget
- Get a form schema by typeget
TaxFilings
VaultFiles
DocumentTemplates
SignatureRequests
SharedFileRequestConfigurations
SharedFileRequests
BackgroundCheckConfigurations
BackgroundChecks
BackgroundCheckPackages
- List background-check packagesget
- Get a background-check packageget
BiometricIdentityVerificationRequests
BiometricIdentityVerifications
EmploymentEligibilityVerifications
InsuranceMonitorConfigurations
InsuranceCoverages
- List insurance coveragesget
- Get an insurance coverageget
InsuranceMonitors
InsuranceImports

Payees & Engagements

Payees
PayeeEngagements
PayerEngagements
Payers
LinkRequests
Engagements
Groups
RateCards
RateCalculations
WorkDefinitions
WorkItems
WorkLoggingConfigs
WorkLogs
Worksites

Payroll

PayrollSchedules
Payrolls
PayrollRuns
PayPeriods
PayStatements
Deductions
W2EmployeeTaxProfile
W2EmployerTaxProfile
W2PayrollProfile
W2Advance
EmployerPayrollProfile
- List EmployerPayrollProfileget
- Get EmployerPayrollProfileget
W2TaxSubmission
- List W2TaxSubmissionget
- Get W2TaxSubmissionget

Payments

InvoicingConfigs
Mandates
Payables
Invoices
PayerInvoiceView
- View an invoice using its dedicated payer-view tokenget
InvoicePaymentIntents
LedgerTransactions
- List ledger transactionsget
- Get a ledger transactionget
RecurringInvoices
RecurringPayables
RecurringDeductions
RecurringCredits
Credits
Payouts
FundsMovements
- List funds movementsget
- Get a funds movementget
Currency
- Get an indicative exchange ratepost
- List supported currenciesget
MandateRequests
MandateSigningSessions
PayerCardSetups
PayerCardSessions

Billing & Subscriptions

Subscriptions
SubscriptionGrants
Purchases
Benefits

Banking & Spend

Cards
PaymentCards
ExternalBankAccounts
InternalAccounts
Institutions
- Look up institution by routing numberget
Transactions
TransactionCategories
- List transaction categoriesget
Transfers
Cashback
Insights
- Get income insightsget
- Get expense insightsget
TaxWithholdings
TaxEstimates
- Generate a tax estimatepost
ProfitAndLoss
- Get profit-and-loss reportget

Search

PayeeRows
- Search payee rowsget
PayerRows
- Search payer rowsget
InvoiceRows
- Search invoice rowsget
PayableRows
- Search payable rowsget
TaxFormSubmissionRows
- Search tax form submission rowsget

Powered by

EligibilityRequirements

Definitions of onboarding requirements and their rules.

Updated 2 months ago

EligibilityRequirementGroups

Did this page help you?

Updated 2 months ago

EligibilityRequirementGroups

Did this page help you?