For AI agents: the docs index is at https://docs.wingspan.app/llms.txt. Append .md to any documentation page URL to get its markdown version.
Jump to Content
WingspanWingspan
HomeGuidesRecipesAPI Reference
Log InWingspan
API Reference
Log In
HomeGuidesRecipesAPI Reference

Platform

  • Operations
    • Poll an async operationget
  • Events
    • List platform eventsget
    • Get an eventget
  • Webhooks
    • Create a webhook subscriptionpost
    • List webhook subscriptionsget
    • Get a webhook subscriptionget
    • Update a webhook subscriptionpatch
    • Delete a webhook subscriptiondel
    • Resume delivery (status -> Active)post
    • Pause delivery (status -> Disabled)post
    • Rotate the signing secret (returned once)post
    • List delivery diagnosticsget
    • Get a single delivery diagnosticget
  • InboundWebhooks
    • Receive an inbound vendor webhookpost
  • WebhookEventTypes
    • List the webhook event-type catalogget
  • Batches
    • Create a batchpost
    • List batchesget
    • Get a batchget
    • Update a batchpatch
    • Delete a batchdel
    • List items in a batchget
    • Get a batch itemget
    • Add a batch itempost
    • Process a batchpost
    • Get a batch summaryget
    • Delete a batch itemdel
  • DataExports
    • Create a scheduled data exportpost
    • List data exportsget
    • Get a data exportget
    • Update a data exportpatch
    • Pause a data exportpost
    • Resume a paused data exportpost
    • Disable a data export (terminal)post
    • List runs for a data exportget
    • Get a data export runget
    • Retry a failed or partially-completed data export runpost
  • AccountingConnections
    • List accounting connectionsget
    • Create an accounting connectionpost
    • Get an accounting connectionget
    • Update an accounting connectionpatch
    • Delete an accounting connectiondel
    • Begin partner OAuthpost
    • Complete partner OAuth (token exchange)post
    • Disconnect the partner linkpost
    • Trigger a full book-push syncpost
    • Force an OAuth token refresh (system/operator)post
    • List sync runsget
    • Get a sync runget
    • List sync activities (audit)get
    • Get a sync activityget
    • Update a sync activitypatch
    • Re-sync a single audit row (async)post
  • AccountingReferenceData
    • List external ledger accounts (chart of accounts)get
    • List accounting customersget
    • List accounting vendorsget
    • List accounting itemsget
    • List accounting classesget
    • Re-pull normalized reference datapost
  • FeatureFlags
    • List enabled feature flags for a Personget
    • Check a single feature flag for a Personget
    • Evaluate feature flags for an anonymous subjectpost
    • List enabled feature flags for an Accountget
    • Check a single feature flag for an Accountget
  • Notifications
    • List a Person's notifications (inbox)get
    • Get a single notificationget
    • Mark a notification viewedpost
    • Dismiss a notificationpost
    • Bulk-mark notifications viewedpost
    • Bulk-dismiss notificationspost
    • Get a Person's notification channel settingsget
    • Update a Person's notification channel settingspatch
    • List notification templates (registry discovery)get
  • NotificationSubscriptions
    • List notification subscriptionsget
    • Create a notification subscription (routing rule)post
    • Get a notification subscriptionget
    • Delete a notification subscriptiondel
  • AuditLogs
    • List audit log entriesget
    • Get an audit log entryget
  • ApiRequestLogs
    • List API request logsget
    • Get an API request log entryget
  • Reports
    • Generate a reportpost
    • List reportsget
    • Get a reportget
    • Fetch a completed report fileget
    • List Worker Report rowsget
    • Get a download link for the report fileget
    • List Payables Report rowsget
    • List Worker Payables Summary rowsget
  • CustomFields
    • Create a custom field definitionpost
    • List custom field definitionsget
    • Get a custom field definitionget
    • Update a custom field definitionpatch
    • Delete a custom field definitiondel
  • Customization
    • Get Organization brandingget
    • Update Organization brandingpatch
  • Tags
    • Create a personal pay link tagpost
    • List tagsget
    • Get a tagget
    • Update a tagpatch
    • Delete a tagdel

Identity & Access

  • Persons
    • List Personsget
    • Request a Person registration or reset linkpost
    • Get a Personget
    • Update a Personpatch
    • Invite a Person to sign inpost
    • Trigger or complete email verification on a Personpost
    • Trigger or complete phone verification on a Personpost
    • Trigger or complete password reset on a Personpost
    • List Accounts this Person is a Stakeholder ofget
    • List paystubs received by a personget
    • List benefit enrollments held by a personget
    • List identity verifications for a person (read-only mirror)get
    • Submit person setup via a one-time invite tokenpost
    • List forms received by a personget
    • Redeem a Person invite tokenpost
    • Submit person setup using the current Person sessionpost
    • Start a sign-in email changepost
    • Confirm a sign-in email changepost
    • Accept a teammate invitationpost
    • List pending teammate invitations for a Personget
  • Accounts
    • Create an Accountpost
    • List Accountsget
    • Get an Accountget
    • Update an Accountpatch
    • Deactivate an Accountdel
    • Associate an Account to a parentpost
    • Move an Account to a new parentpost
    • List child Accountsget
    • Get ancestor chain for an Accountget
    • Search accountspost
    • Get account settingsget
    • Update account settingspatch
    • Get account eligibilityget
    • Get the full descendant hierarchyget
    • Change the Account's regulated entity type (async)post
    • Create an account-scoped sessionpost
    • List forms received by an accountget
    • List paystubs for an accountget
    • Transfer the Account Principalpost
    • List connected OAuth applications for one Accountget
    • Revoke an Account-bound OAuth grantdel
    • Disconnect one OAuth client from one Accountpost
    • Get an Account's parent linkget
    • Update an Account's parent linkpatch
    • List an Account's product entitlementsget
  • Organizations
    • Create an Organization (admin / Embed-partner)post
    • List Organizations accessible to the callerget
    • Get an Organizationget
    • Update an Organization's SSO configpatch
  • ComplianceEntities
    • List a subject's ComplianceEntity historyget
    • Create a subject's first ComplianceEntitypost
    • Get one ComplianceEntity recordget
    • Update a ComplianceEntitypatch
    • Verify a ComplianceEntitypost
    • Advance a ComplianceEntity to a successor identitypost
  • Stakeholders
    • List Stakeholders on an Accountget
    • Create a Stakeholder on an Accountpost
    • Get a Stakeholderget
    • Update a Stakeholderpatch
    • Revoke a Stakeholderdel
    • Invite a Stakeholderpost
  • Sessions
    • Create a sessionpost
    • Sign outdel
    • Request a one-time passcodepost
    • Verify a one-time passcode and create a sessionpatch
    • Refresh a session (rotates the refresh token)post
    • Update session account scopepatch
    • Create a Person session with Google Identitypost
  • Mfa
    • Create a step-up MFA challengepost
    • Get an MFA challengeget
    • Answer an MFA challengepost
    • Enroll an MFA factorpost
    • Get an MFA factorget
    • Delete an MFA factordel
    • Confirm an MFA factor's enrollmentpost
    • List MFA factors enrolled for a Person (read-only mirror)get
    • List MFA challenges bound to a session (read-only mirror)get
    • Answer an MFA challenge from an emailed linkpost
    • Confirm email-factor enrollment from an emailed linkpost
    • List MFA factors for the calling Personget
  • SSO
    • Initiate enterprise SSO loginpost
    • Handle SSO callbackpost
  • OAuth
    • Start an OAuth authorization interactionget
    • Exchange an authorization grantpost
    • Revoke a token as its issuing clientpost
    • Start an OAuth authorization interaction using form serializationpost
    • Read a session-bound OAuth interactionpost
    • Approve or deny an OAuth interactionpost
    • Complete a prompt=none interactionpost
    • List the direct Person's connected applicationsget
    • Disconnect one connected applicationdel
    • Dynamically register an OAuth clientpost
    • List clients owned by the direct Personget
    • Mint a short-lived single-use registration tokenpost
    • Read an owned OAuth clientget
    • Update versioned OAuth client policypatch
    • Revoke an owned OAuth clientdel
    • Rotate a confidential client secretpost
    • Recover and rotate a registration access token from the owner sessionpost
    • Read an RFC 7592 registrationget
    • Replace and narrow an RFC 7592 registrationput
    • Revoke an RFC 7592 registrationdel
    • JSON Web Key Set for validating issued tokensget
  • ApiKeys
    • Create an API keypost
    • List API keysget
    • Get an API keyget
    • Update an API keypatch
    • Revoke an API keydel
    • Rotate an API key secretpost
    • Rotate the presenting API keypost
  • ServiceAccounts
    • Create a ServiceAccountpost
    • List ServiceAccountsget
    • Get a ServiceAccountget
    • Update a ServiceAccountpatch
    • Activate a ServiceAccountpost
    • Disable a ServiceAccount (cascades to keys)post
    • Inactivate a ServiceAccount (recoverable)post
    • Reactivate an Inactive ServiceAccountpost
  • Roles
    • Create a custom Rolepost
    • List Rolesget
    • Get a Roleget
    • Update a custom Rolepatch
    • Delete a custom Roledel
  • Authorizations
    • Grant scoped Account access to a principalpost
    • List authorizationsget
    • Get an authorizationget
    • Update an authorizationpatch
    • Revoke an authorizationdel
    • List available scopesget
    • List scope groupsget

Onboarding & Verification

  • IdentityVerifications
    • Create an identity verificationpost
    • List identity verificationsget
    • Get an identity verificationget
    • Cancel an identity verificationpost
    • Resume an UpdateRequired identity verificationpost
    • List checks for an identity verificationget
    • Get a single identity verification checkget
  • IdentityVerificationMonitors
    • Create an identity verification monitorpost
    • List identity verification monitorsget
    • Get an identity verification monitorget
    • Pause a monitorpost
    • Resume a paused monitorpost
    • Cancel a monitorpost
  • Monitors
    • Create a monitorpost
    • List monitorsget
    • Get a monitorget
    • Renew a monitorpost
    • Pause a monitorpost
    • Resume a monitorpost
    • Cancel a monitorpost
  • IdentityVerificationAlerts
    • List alerts under a monitorget
    • List identity verification alertsget
    • Get an identity verification alertget
    • Confirm an alertpost
    • Clear an alertpost
  • PayeeEligibilityRequirements
  • EligibilityRequirements
  • EligibilityRequirementGroups
  • Requirements
    • List requirementsget
    • Get a requirementget
    • Update a requirementpatch
    • Approve a payee eligibility requirementpost
    • Reject a payee eligibility requirementpost
    • Extend a requirement's expirationpost
    • Revert a payer overridepost
    • Reset a requirementpost
    • Renew a requirementpost
    • Fulfill a payee eligibility requirementpost
    • Apply a data source to a requirementpost
  • RequirementDefinitions
    • Create a requirement definitionpost
    • List requirement definitionsget
    • Get a requirement definitionget
    • Update a requirement definitionpatch
    • Delete a requirement definitiondel
    • Activate a requirement definitionpost
    • Deactivate a requirement definitionpost
  • RequirementDefinitionGroups
    • Create an eligibility requirement grouppost
    • List eligibility requirement groupsget
    • Get an eligibility requirement groupget
    • Update an eligibility requirement grouppatch
    • Delete an eligibility requirement groupdel
    • Add a requirement to a grouppost
    • List a group's requirementsget
    • Remove a requirement from a groupdel
  • Acknowledgements
    • Accept an acknowledgementpost
    • Get acknowledgement statusget
    • Decline or revoke an acknowledgementpost
  • ReferenceData
    • List occupationsget
    • List locationsget
    • List MCC codesget
  • Onboarding
    • Get onboarding statusget
    • Trigger verificationpost
    • List missing fieldsget

Compliance & Tax

  • Forms
    • Create a formpost
    • List formsget
    • Get a formget
    • Update a formpatch
    • Delete a formdel
    • Issue a formpost
    • Void a formpost
    • Verify recipient identity for form accesspost
    • Deliver a formpost
    • Fetch the form PDFget
    • Create an auditable shareable link for the formpost
    • Get this form's schema and valuesget
    • Submit a formpost
    • Get a managed form's provenanceget
    • Flag a correction on a managed formpost
    • List a form's correction requestsget
    • Approve a correction requestpost
    • Reject a correction requestpost
    • Withdraw a correction requestpost
    • Get a correction requestget
    • Re-validate a form instance with candidate valuespost
    • Submit a form instancepost
    • listFormSubmissionsget
    • getFormSubmissionget
    • Fetch a submission's PDFget
    • Get a download link for the form PDFget
    • Get a download link for a submission's PDFget
  • FormSchemas
    • List form schemasget
    • Get a form schema by typeget
  • TaxFilings
    • Create a tax filingpost
    • List tax filingsget
    • Get a tax filingget
    • Update a tax filingpatch
    • Submit the filing's formspost
    • Correct a form on a manual filingpost
    • Close a tax filingpost
    • List the forms produced by a filingget
    • Generate tax filings in bulk for a payerpost
    • Submit eligible tax filings in bulk for a payerpost
    • List filing eligibility exceptions for a payerget
    • Apply a data-driven adjustment to a filingpost
    • Recalculate a filing from authoritative datapost
    • Update the recipient on a filing's formspost
    • File a filing anyway, overriding its exclusionpost
    • Switch a filing to manual managementpost
    • List a filing's adjustmentsget
    • Get a filing adjustmentget
    • Read tax filing historyget
  • VaultFiles
    • Create a vault filepost
    • List vault filesget
    • Get a vault fileget
    • Update a vault filepatch
    • Delete a vault filedel
    • Fetch the vault file contentget
    • Get a vault file summaryget
    • Create a vault file upload reservationpost
    • Get a download link for the vault file contentget
  • DocumentTemplates
    • Create a document templatepost
    • List document templatesget
    • Get a document templateget
    • Update a document templatepatch
    • Delete a document templatedel
    • Generate a document vault file from a templatepost
  • SignatureRequests
    • Create a signature requestpost
    • List signature requestsget
    • Get a signature requestget
    • Get signing URLsget
    • Cancel a signature requestpost
    • Send a signing reminderpost
    • Update a signature requestpatch
    • Start signing a signature requestpost
    • Create a signature request for a vault filepost
  • SharedFileRequestConfigurations
    • Create a shared file request configurationpost
    • List shared file request configurationsget
    • Get a shared file request configurationget
    • Update a shared file request configurationpatch
  • SharedFileRequests
    • List shared file requestsget
    • Create a shared file requestpost
    • Get a shared file requestget
    • Attach an uploaded filepost
    • Submit a shared file requestpost
    • Update a shared file requestpatch
  • BackgroundCheckConfigurations
    • Create a background check configurationpost
    • Get a background check configurationget
    • Update a background check configurationpatch
  • BackgroundChecks
    • List background checksget
    • Order a background checkpost
    • Get a background checkget
    • Cancel a background checkpost
  • BackgroundCheckPackages
    • List background-check packagesget
    • Get a background-check packageget
  • BiometricIdentityVerificationRequests
    • List biometric identity verification requestsget
    • Create a biometric identity verification requestpost
    • Get a biometric identity verification requestget
    • Update a biometric identity verification requestpatch
  • BiometricIdentityVerifications
    • List biometric identity verificationsget
    • Get a biometric identity verificationget
    • Start a biometric identity verificationpost
  • EmploymentEligibilityVerifications
    • List employment eligibility verificationsget
    • Create an employment eligibility verificationpost
    • Get an employment eligibility verificationget
    • Update an employment eligibility verificationpatch
    • Submit Section 1post
    • Verify and sign Section 2post
    • Decline an employment eligibility verificationpost
    • Request a correction to Section 1post
    • List available E-Verify closure reasonsget
    • Download an E-Verify employee noticeget
    • Read the E-Verify document photoget
    • Record the notified employee mismatch decisionpost
    • Record the employer photo comparisonpost
    • Submit both sides of a document using employer vault file IDspost
    • Confirm the displayed signed I-9 versionpost
    • Close the case with the employer selected reasonpost
    • Retry an attempt or replace a resolved predecessorpost
  • InsuranceMonitorConfigurations
    • Create an insurance monitor configurationpost
    • Get an insurance monitor configurationget
    • Update an insurance monitor configurationpatch
  • InsuranceCoverages
    • List insurance coveragesget
    • Get an insurance coverageget
  • InsuranceMonitors
    • Create an insurance monitorpost
    • Get an insurance monitorget
    • Link a coverage to an insurance monitorpatch
    • Download the certificate behind a monitor's coverageget
    • Get a download link for the certificate behind a monitor's coverageget
  • InsuranceImports
    • Create an insurance importpost
    • Get an insurance importget
    • Update an insurance importpatch
    • Submit an insurance importpost

Payees & Engagements

  • Payees
    • Create a payeepost
    • List payeesget
    • Get a payeeget
    • Update a payeepatch
    • Deactivate a payeedel
    • Invite many payees in one requestpost
    • Send or resend invitation to a payeepost
    • List activity events for a payeeget
    • Search payeespost
    • Get a payee's custom fieldsget
    • Update a payee's custom fieldspatch
    • Activate a deactivated payeepost
    • Preview a payee email changepost
    • Change a payee emailpost
    • Get sensitive ACH/wire instructions for a Payeeget
    • Get a payee default payment methodget
    • Set a payee default payment methodpatch
    • Clear a payee default payment methoddel
    • Change a payee's worker classificationpost
    • Get relationship deduction balanceget
    • List a payee’s representatives and ownersget
    • Create a payee representative or ownerpost
    • Update a payee representative or ownerpatch
    • Revoke a payee representative or ownerdel
  • PayeeEngagements
    • Create a payee engagementpost
    • List engagements for a payeeget
    • Get a payee engagementget
    • Update a payee engagementpatch
    • Remove a payee engagementdel
    • Activate a payee engagementpost
    • Suspend a payee engagementpost
    • Terminate a payee engagementpost
    • Get tax elections (W-4 / state) for an employee engagementget
    • Update tax elections for an employee engagementpatch
    • Fulfill a requirement for a payee engagementpost
    • Waive a requirement for a payee engagementpost
    • Get the rate card for a payee engagementget
    • Bind a rate card override for a payee engagementpatch
    • Search payee engagements across all payeespost
    • List payee engagements for the acting payerget
    • Get a payee engagement as the payer or payeeget
    • Update a payee engagement as the payerpatch
  • PayerEngagements
    • List payer engagementsget
    • Get a payer engagementget
    • Update a payer engagementpatch
    • Create an upstream payer engagementpost
    • Reopen your side of an engagementpost
    • Archive your side of an engagementpost
  • Payers
    • Create a payerpost
    • List payersget
    • Get a payerget
    • Update a payerpatch
    • Deactivate a payerdel
    • Get payer settingsget
    • Payer relationship settings writes are forbiddenpatch
    • Search payerspost
    • List a payer's payment methodsget
    • Send or resend invitation to a payerpost
    • Share tax information with this payerpost
    • Revoke the tax-information share with this payerpost
    • Restore a deactivated payerpost
    • Get sensitive ACH/wire instructions for a Payerget
    • Get the effective Account's payer settingsget
    • Update the effective Account's payer settingspatch
    • Get relationship credit balanceget
    • Get a jurisdiction's payroll tax setup formget
    • Re-validate a jurisdiction's payroll tax setup formpost
    • Submit a jurisdiction's payroll tax setuppost
  • LinkRequests
    • Start a payee link requestpost
    • List a payee's link requestsget
    • Start a payer link requestpost
    • List a payer's link requestsget
    • Create a link requestpost
    • List link requestsget
    • Associate a payee with an Account (trusted platform)post
    • Get the invitee-bound link requestget
    • Get a link requestget
    • Retarget a link requestpatch
    • Cancel a link requestdel
    • Accept a link requestpost
    • Reject a link requestpost
    • List link requests addressed to the authenticated Personget
  • Engagements
    • Create an engagement templatepost
    • List engagement templatesget
    • Get an engagement templateget
    • Update an engagement templatepatch
    • Delete an engagement templatedel
    • Add a work definition to an engagement templatepost
    • Remove a work definition from an engagement templatedel
    • Add a requirement to an engagement templatepost
    • Remove a requirement from an engagement templatedel
    • Archive an engagement templatepost
    • Restore an archived engagement templatepost
  • Groups
    • Create a grouppost
    • List groupsget
    • Get a groupget
    • Update a grouppatch
    • Delete a groupdel
    • Add a member to a grouppost
    • Remove a member from a groupdel
    • Bulk-add members to a grouppost
  • RateCards
    • Create a rate cardpost
    • List rate cardsget
    • Get a rate cardget
    • Update a rate cardpatch
    • Delete a rate carddel
  • RateCalculations
    • Create a rate calculationpost
    • List rate calculationsget
    • Get a rate calculationget
    • Update a rate calculationpatch
    • Delete a rate calculationdel
  • WorkDefinitions
    • Create a work definitionpost
    • List work definitionsget
    • Get a work definitionget
    • Update a work definitionpatch
    • Delete a work definitiondel
  • WorkItems
    • Create a work itempost
    • List work itemsget
    • Get a work itemget
    • Update a work itempatch
    • Delete a work itemdel
    • Verify a work itempost
    • Unverify a work itempost
  • WorkLoggingConfigs
    • Get the work-logging configget
    • Update the work-logging configpatch
    • Get a payer's work-logging config as a payeeget
  • WorkLogs
    • Create a work logpost
    • List work logsget
    • Get a work logget
    • Update a work logpatch
    • Delete a work logdel
    • Submit a work log for approvalpost
    • Approve a work logpost
    • Reject a work logpost
    • Request the payee to edit a submitted work logpost
    • Set your comment on a work logpost
  • Worksites
    • Create a worksitepost
    • List worksitesget
    • Get a worksiteget
    • Update a worksitepatch
    • Delete a worksitedel

Payroll

  • PayrollSchedules
    • List the Account's payroll schedulesget
    • Get one of the Account's payroll schedulesget
    • Update one of the Account's payroll schedulespatch
    • Preview the Account's pay periods across a windowpost
    • Initialize the Account's Employee payroll schedulepost
  • Payrolls
  • PayrollRuns
    • Create an off-cycle payroll runpost
    • List payroll runsget
    • Get a payroll runget
    • Update a payroll runpatch
    • Delete a payroll rundel
    • Finalize a payroll runpost
    • Cancel a payroll runpost
    • Create and finalize a contractor payroll runpost
  • PayPeriods
    • List pay periodsget
    • Get a pay periodget
    • Update a pay periodpatch
  • PayStatements
    • List pay statementsget
    • Get a pay statementget
    • Update a pay statementpatch
    • Cancel a pay statementpost
    • Preview a pay statement (gross-to-net)post
    • Fetch the pay statement PDFget
    • Get a download link for the pay statement PDFget
  • Deductions
    • Create a deductionpost
    • List deductionsget
    • Get a deductionget
    • Update a deductionpatch
    • Delete a deductiondel
    • Complete an adjustment remainderpost
    • Get adjustment PDFget
  • W2EmployeeTaxProfile
  • W2EmployerTaxProfile
  • W2PayrollProfile
  • W2Advance
  • EarnedWageAccesses
    • Create an Earned Wage Access advancepost
    • List Earned Wage Access advancesget
    • Get an Earned Wage Access advanceget
  • EmployerPayrollProfile
  • W2TaxSubmission
    • List W2TaxSubmissionget
    • Get W2TaxSubmissionget

Payments

  • InvoicingConfigs
    • Get the invoicing configget
    • Update the invoicing configpatch
    • Get a payer's invoicing config as a payeeget
  • Mandates
    • Create an ACH debit mandatepost
    • List ACH debit mandatesget
    • Get an ACH debit mandateget
    • Revoke an ACH debit mandatepost
  • Payables
    • Create a payablepost
    • List payablesget
    • Get a payableget
    • Update a payablepatch
    • Delete a payabledel
    • Finalize a payable and make it visible to the payeepost
    • Payee accepts a payablepost
    • Payee rejects a payablepost
    • Set or reset the payer approval statuspatch
    • Pay a payablepost
    • Record an off-platform payment for a payablepost
    • Cancel a payablepost
    • Refund a payable (full or partial)post
    • Payee disputes the payable after acceptancepost
    • Email a payable to the payeepost
    • Send a reminder for a payablepost
    • Fetch the payable PDFget
    • List attachments for a payableget
    • Search payablespost
    • Attach a MemberFile or VaultFile (by reference) to a payablepost
    • Detach a document from a payabledel
    • Create a short-lived shareable link for the payablepost
    • Get a download link for the payable PDFget
    • Edit an off-platform payment entrypatch
    • Remove an off-platform payment entrydel
  • Invoices
    • Create an invoicepost
    • List invoicesget
    • Get an invoiceget
    • Update an invoicepatch
    • Delete an invoicedel
    • Email invoice to payerpost
    • Send payment reminder for an invoicepost
    • Pay an invoicepost
    • Record an off-platform payment for an invoicepost
    • Refund an invoice (full or partial)post
    • Void an invoice after it has been sentpost
    • Payee disputes the invoicepost
    • Fetch the invoice PDFget
    • List attachments for an invoiceget
    • Search invoicespost
    • Attach a MemberFile or VaultFile (by reference) to an invoicepost
    • Detach a document from an invoicedel
    • Create a short-lived shareable link for the invoicepost
    • Create a revocable anonymous-payment linkpost
    • List active anonymous-payment linksget
    • Revoke an anonymous-payment linkdel
    • Payee accepts an invoicepost
    • Fetch the invoice receipt PDFget
    • Get a download link for the invoice PDFget
    • Get a download link for the invoice receipt PDFget
    • Payee requests an instant payout of a paid invoicepost
    • Edit an off-platform payment entrypatch
    • Remove an off-platform payment entrydel
    • Get the effective Account's payee settingsget
    • Update the effective Account's payee settingspatch
  • PayerInvoiceView
    • View an invoice using its dedicated payer-view tokenget
    • Get a download link for the invoice PDF using the payer-view tokenget
    • Get a download link for the receipt PDF using the payer-view tokenget
    • Get wire / manual ACH instructions using the payer-view tokenget
    • List the payee's invoice attachments using the payer-view tokenget
  • InvoicePaymentIntents
    • Create a one-time Invoice payment intentpost
    • Get a one-time Invoice payment intentget
    • Complete request-scoped payment-method capturepost
    • Confirm the exact card or ACH authorizationpost
  • LedgerTransactions
    • List ledger transactionsget
    • Get a ledger transactionget
  • RecurringInvoices
    • Create a recurring invoicepost
    • List recurring invoicesget
    • Get a recurring invoiceget
    • Update a recurring invoicepatch
    • Delete a recurring invoicedel
    • Pause a recurring invoicepost
    • Resume a recurring invoicepost
    • Cancel a recurring invoicepost
    • Generate the next invoice nowpost
    • Preview upcoming occurrencesget
  • RecurringPayables
    • Create a recurring payablepost
    • List recurring payablesget
    • Get a recurring payableget
    • Update a recurring payablepatch
    • Delete a recurring payabledel
    • Pause a recurring payablepost
    • Resume a recurring payablepost
    • Cancel a recurring payablepost
    • Generate the next payable nowpost
    • Preview upcoming occurrencesget
  • RecurringDeductions
    • Create a recurring deductionpost
    • List recurring deductionsget
    • Get a recurring deductionget
    • Update a recurring deductionpatch
    • Delete a recurring deductiondel
    • Pause a recurring deductionpost
    • Resume a recurring deductionpost
    • Cancel a recurring deductionpost
  • RecurringCredits
    • Create a recurring creditpost
    • List recurring creditsget
    • Get a recurring creditget
    • Update a recurring creditpatch
    • Delete a recurring creditdel
    • Pause a recurring creditpost
    • Resume a recurring creditpost
    • Cancel a recurring creditpost
  • Credits
    • Create a creditpost
    • List creditsget
    • Get a creditget
    • Update a creditpatch
    • Delete a creditdel
    • Close the credit remainderpost
    • Get adjustment PDFget
    • Target a credit at an invoicepost
    • Remove a credit from an invoicepost
  • Payouts
    • List payout settlement aggregatesget
    • Get a payout settlement aggregateget
    • List payout settingsget
    • Get payout settingsget
    • Update payout settingspatch
    • Create or replace payout routing for a Payee relationshippost
    • Update payout annotationspatch
    • List one payout item collectionget
  • FundsMovements
    • List funds movementsget
    • Get a funds movementget
  • Currency
    • Get an indicative exchange ratepost
    • List supported currenciesget
  • MandateRequests
    • Ask an unlinked payer to authorize ACH debitspost
    • Read an owned mandate request and recover its pending signing linkget
    • Send the authorization email againpost
    • Cancel a pending mandate requestpost
    • List ACH authorization requests for one client assignmentget
  • MandateSigningSessions
    • Read the payer mandate signing page using its bearer tokenget
    • Confirm the two microdeposit amountspost
    • Accept the rendered ACH debit authorizationpost
    • Read the accepted consent and recover its revocation linkget
    • Read consent using its separate revocation capabilityget
    • Revoke this accepted consent without an account loginpost
    • Download the evidence file of the accepted consentget
    • Get a download link for the evidence file of the accepted consentget
  • PayerCardSetups
    • Create an engagement-bound hosted card authorizationpost
    • List card authorizations for one owned client assignmentget
    • Read the payee-owned card authorization setupget
    • Send or resend a pending authorization to its recorded primary contactpost
  • PayerCardSessions
    • Read masked card disclosures and recover the acceptance receiptget
    • Create or refresh hosted card capture for this exact setuppost
    • Accept the displayed terms and verify this stored cardpost
    • Read the exact accepted card consentget
    • Revoke card consent without an account loginpost
    • Download the evidence file of the accepted card authorizationget
    • Get a download link for the evidence file of the accepted card authorizationget

Billing & Subscriptions

  • Subscriptions
    • List available subscription plansget
    • Get a subscription planget
    • Subscribe to a planpost
    • List subscriptionsget
    • Get a subscriptionget
    • Update a subscriptionpatch
    • Cancel a subscriptionpost
    • Get subscription payment historyget
    • List plans available to the selected Accountget
    • Get a personalized planget
    • Withdraw a pending cancellationpost
  • SubscriptionGrants
    • Create a subscription grantpost
    • List subscription grantsget
    • Get a subscription grantget
    • Update a subscription grantpatch
    • Revoke a subscription grantdel
  • Purchases
    • List available products and SKUsget
    • Get catalog item detailget
    • Purchase a Planpost
    • List purchasesget
    • Get an account-owned Purchaseget
    • Cancel a purchasepost
    • Renew a purchasepost
  • Benefits
    • List available benefit plansget
    • Get a benefit planget
    • Enroll in a benefit planpost
    • List benefit enrollmentsget
    • Get a benefit enrollmentget
    • Update a benefit enrollmentpatch
    • Cancel a benefit enrollmentpost
    • Withdraw a pending cancellationpost

Banking & Spend

  • Cards
    • Create a cardpost
    • List cardsget
    • Retrieve a cardget
    • Update a cardpatch
    • Activate a cardpost
    • Suspend a cardpost
    • Cancel a cardpost
    • Set or change card PINpost
    • Get card spending limitsget
    • Update card spending limitspatch
    • Get card embed URLget
    • Tokenize card for digital walletpost
  • PaymentCards
    • Create a payment cardpost
    • List payment cardsget
    • Get a payment cardget
    • Replace payment card metadatapatch
    • Remove a payment carddel
    • Create the hosted card-capture linkpost
    • Verify and activate a linked payment cardpost
  • ExternalBankAccounts
    • Generate bank connection link tokenpost
    • Create external bank accountpost
    • List external bank accountsget
    • Retrieve external bank accountget
    • Update external bank accountpatch
    • Delete external bank accountdel
    • Verify external bank account via micro-depositspost
    • Retrieve external bank account balanceget
    • List transactions for an external bank accountget
    • Get missing fields for bank account setupget
    • Reconnect external bank account via Plaidpost
    • List currencies for a bank account countryget
    • Get required bank fields for a country and currencyget
  • InternalAccounts
    • List internal accountsget
    • Create internal accountpost
    • Retrieve internal accountget
    • Retrieve internal account balanceget
    • List transactions for an internal accountget
    • Create transfer for an internal accountpost
    • List statements for an internal accountget
    • Retrieve a specific statementget
    • Fetch statement PDFget
    • Get a download link for the statement PDFget
  • Institutions
    • Look up institution by routing numberget
  • Transactions
    • List transactionsget
    • Create a manual transactionpost
    • Retrieve a transactionget
    • Update a transactionpatch
    • Delete a transactiondel
    • Sync transactions from connected accountspost
  • TransactionCategories
    • List transaction categoriesget
  • Transfers
    • Create a financial account transferpost
    • List transfersget
    • Retrieve a transferget
    • Cancel a transferpost
  • Cashback
    • Get cashback balanceget
    • Get cashback eligibilityget
    • Redeem cashback rewardspost
    • List cashback promotionsget
    • Redeem a completed cashback promotionpost
  • Insights
    • Get income insightsget
    • Get expense insightsget
  • TaxWithholdings
    • Get tax withholding settingsget
    • Update tax withholding settingspatch
    • Get tax withholding balanceget
    • List tax withholding transactionsget
    • Withdraw from tax withholding accountpost
    • Deposit into tax withholding accountpost
    • Schedule an IRS tax paymentpost
    • Cancel an IRS tax paymentpost
  • 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

Wingspan Banking API

  • Banking Accounts
    • List Internal Account Statementsget
    • Retrieve Internal Account Statementget
    • List Internal Accountsget
    • Create Internal Accountpost
    • Retrieve Internal Accountget
    • Retrieve Internal Account Balanceget
  • Banking Transactions
    • Create Internal Account Transferpost
    • List transactions for a specific internal accountget
  • Payment Cards
    • List Payment Cardsget
    • Create Payment Cardpost
    • Retrieve Payment Cardget
    • Activate Payment Cardpost
    • Set Card PINpost
    • Get Card Embed URLget
    • Get Card Limitsget
    • Set Card Limitspost
    • Cancel Payment Cardpost
    • Suspend Payment Cardpost
  • Insurance Coverage
    • List insurance policies and Master Policy enrollmentsget
    • Get insurance policy detailsget
  • Insurance Import
    • Create insurance importpost
    • Get insurance importget
    • Update insurance importpatch
    • Submit insurance importpost
  • Insurance Coverage Monitor Settings
    • Create insurance coverage monitor settingspost
    • Get insurance coverage monitor settingsget
  • Insurance Coverage Monitor
    • Get insurance coverage monitorget
    • Set coverage on insurance coverage monitorpatch
    • Download insurance coverage fileget
  • Verifications
    • Get verification levels for a customerget
    • Perform a verification for a specific levelpost
    • Lists missing fields or documents for a specific verification levelget
  • Payables
    • List payables for the authenticated userget
    • Create a bulk action for a payable result setpost
    • List bulk action batches for the authenticated userget
  • Plan Enrollment
    • List plan enrollmentsget
    • Enroll in a planpost
    • Get a plan enrollmentget
    • Cancel a plan enrollmentpost
    • Withdraw a plan enrollment cancellationpost
    • List health plan enrollmentsget
    • Enroll in health planspost
    • List health plan catalogget
  • Resource-Event-History
    • List resource eventsget
  • Revenue
    • Get all custom prices for the authenticated customerget
    • Get specific price for the authenticated customer and SKUget
  • User
    • Get current user profileget
  • Organizations
    • Provision a partner SSO platform accountpost
  • Customer Entity
    • Get current customer entityget
    • Creates a new customer entitypost
    • Update customer datapatch
    • Request a material or immaterial change to the customer entitypost
  • Acknowledgements
    • Acknowledge an agreement or policypost
    • Get acknowledgement detailsget
  • Payouts
    • Get list of payoutsget
    • Get details of a particular payoutget
    • Get currency exchange ratepost

Wingspan Users API

  • User and Member Management
    • Health Check for User Serviceget
    • Register a new user with pending statuspost
    • Register a new userpost
    • Modify user account details using user IDpatch
    • Fetch user profile details using user IDget
    • Register a New Member with Specific IDpost
    • Retrieve Subscription Details by IDget
    • Modify Subscription Details for Memberpatch
    • Retrieve Advocate Information for the Specified Memberget
    • Initiate User Password Reset Processpost
    • Retrieve payment history for membershipget
    • Retrieve Client Details by IDget
    • Register a New Client with Specific IDpost
    • Modify Existing Client Details by IDpatch
    • Retrieve User by Tag IDget
    • Retrieve User by Email Addressget
    • Retrieve Public User Profile by IDget
    • Retrieve User's Occupation Detailsget
    • Retrieve User's Locationget
  • Session and Authentication
    • Initiate a new session with pending statuspost
    • Initiate a New User Sessionpost
    • Initiate OTP/2FA Verification Processpost
    • Confirm OTP/2FA Verificationpatch
    • Request to Sign-In on Behalf of Another Userpost
    • Create a New API Sessionpost
    • Retrieve All API Sessions Created by the Current Userget
    • Modify a Specific API Sessionpatch
    • Fetch Details of a Specific API Sessionget
    • Terminate a Specific API Sessiondel
    • Retrieve session details using token IDget
    • Terminate a user session using token IDdel
    • Retrieve Subscription Grants for a Granted Subscriberget
    • Authenticate using Googlepost
    • Initiate verification for an existing email addresspost
    • Initiate Email Verification Process for Userpost
    • Confirm Email Verification Statuspatch
    • Start Phone Verification Process for Userpost
    • Validate Phone Verification Statuspatch
    • Create a Single Sign-On (SSO) Sessionpost
    • Authenticate User Requestpost
    • OAuth Authorization Endpointget
    • Process OAuth Authorizationpost
    • OAuth Token Exchangepost
    • Revoke OAuth Tokenpost
    • OAuth Token Introspectionpost
    • OAuth Server Metadataget
    • JSON Web Key Setget
  • Account and Banking Operations
    • Generate Plaid Link Token for Account Integrationpost
    • Retrieve All Linked Bank Accountsget
    • Add New Bank Accountpost
    • Fetch Specific Bank Account Detailsget
    • Unlink Bank Accountdel
    • Modify Bank Account Detailspatch
    • Verify an account for paymentspost
    • Get missing user fields for accountget
    • Retrieve Account Numbers for Guestspost
    • Fetch Necessary Account Detailspost
    • Fetch Available Payout Currencies for a Specific Countrypost
  • Authorization and Permissions
    • Request User Authorizationpost
    • Retrieve All User Authorizationsget
    • Retrieve all authorized scopesget
    • Obtain all authorized scope-groupsget
    • Retrieve authorized scope-groups specific to a userget
    • Obtain authorized scopes specific to a userget
    • Retrieve Authorization Details by IDget
    • Modify Existing Authorization Detailspatch
    • Revoke and Remove Authorization Recorddel
    • Retrieve Accounts Authorized by Userget
    • Retrieve Authentication Token for Flatfilepost
  • Subscription Management
    • Retrieve Specific Nextgen Subscription Planget
    • Browse Available Nextgen Subscription Plansget
    • Initiate a New Nextgen Subscription for a Memberpost
    • Fetch All Nextgen Subscriptions for Memberget
    • Retrieve Details of a Specific Nextgen Subscriptionget
    • Modify an Existing Nextgen Subscription for Memberpatch
    • Revoke a Nextgen Subscription for Memberdel
  • Activity and Usage Tracking
    • Retrieve All Activities of a Memberget
    • Log New Activity for Memberpost
    • Retrieve Specific Activity Details for a Memberget
    • Modify Specific Activity Details for a Memberpatch
    • Remove Specific Activity Record for a Memberdel
  • Organization Account Management
    • Register New User within Organizationpost
    • Retrieve All Organization User Accountsget
    • Retrieve Organization User Profileget
    • Modify Organization User Profilepatch
    • Initiate Session for Organization Userget
    • Link a Child User to a Parent Organization Accountpost
    • Modify the Association of Child User to Parent Organizationpatch
  • Deprecated
    • DEPRECATEDgetSubscriptionget
    • DEPRECATEDupdateSubscriptionpatch
    • DEPRECATEDdeleteSubscriptiondel
    • DEPRECATEDlist membership plansget
    • DEPRECATEDget membership planget
    • DEPRECATED Get Payment Methodget
    • DEPRECATED create Payment Methodpost
    • DEPRECATED Update Payment Methodpatch
  • Subscription and Grants Management
    • New Subscription Grantpost
    • Fetch All Subscription Grantsget
    • Modify subscription grant detailspatch
    • Retrieve subscription grant details by IDget
    • Terminate a specific subscription grant by IDdel
    • Register a New Subscription for Memberpost
    • Modify Subscription Details for Memberpatch
    • Retrieve Subscription Details by IDget
    • Remove Subscription for Memberdel
  • Invitation
    • Fetch a invitation details for provided invitation tokenget
    • Resend all user invitationspost
  • Customization
    • Fetch a customization details for a userget
    • Update customization details for a userpatch
    • Fetch a customization details for a userget
  • Identity Verification
    • Get identity verification request detailsget
    • Start identity verification processpost

Wingspan Bookkeeping API

  • Tax and Financial Reporting
    • Retrieve Estimated Tax Details for a Memberpost
    • Obtain Profit and Loss Report for a Memberget
    • Retrieve a Specific Bookkeeping Reportget
  • Transaction Management
    • Fetch Transaction Subcategories Based on Wingspan Categoryget
    • Retrieve All Member Transactionsget
    • Record a New Transactionpost
    • Retrieve Specific Transaction Detailsget
    • Remove a Specific Transactiondel
    • Modify a Specific Transactionpatch
    • Fetch Income Insights for Catch-Up Transactionsget
    • Fetch Expense Insights for Catch-Up Transactionsget
    • Retrieve All Withholding Transactionsget
    • Obtain Current Tax Withholding Balanceget
  • Service Management
    • Check Bookkeeping Service Statusget
    • Modify Bookkeeping Service Enablement Statuspatch
    • Deactivate Bookkeeping Service for Memberdel
  • Banking and Account Management
    • Retrieve Business Banking Account Informationget
    • Obtain Current Balance of Business Banking Accountget
    • Retrieve Details of a Specific Pending Banking Transactionget
    • Modify a Specific Pending Banking Transactionpatch
    • Fetch All Pending Banking Transactionsget
    • Create a New Pending Banking Transactionpost
  • Withholding Transactions
    • Retrieve Specific Withholding Transaction Detailsget
    • Retrieve Details of a Specific Pending Withholding Transactionget
    • Modify Details of a Pending Withholding Transactionpatch
    • Retrieve All Pending Withholding Transactionsget
    • Start a New Withholding Transactionpost
    • Retrieve Pending Cashback Amountget
  • Cashback Rewards Management
    • Retrieve Approved Cashback Amountget
    • Redeem Available Cashbackpost
    • Check User's Eligibility for Cashback Rewardsget
Powered by 

EmployerPayrollProfile

Payer-level W-2 payroll profile.

Updated 18 days ago


Get an Earned Wage Access advance
W2TaxSubmission
Did this page help you?

Updated 18 days ago


Get an Earned Wage Access advance
W2TaxSubmission
Did this page help you?