# Symmetry Docs

> Developer documentation and API references for Symmetry's payroll tax engine, payroll forms, I-9 verification, payroll point, minimum wage finder, and paycheck calculators.

## Docs

- [What is the Symmetry Tax Engine?](https://docs.symmetry.com/ste/overview/what-is-the-ste.md): Precise federal, state, and local payroll tax calculations for the U.S. and Canada.
- [Ways to use the STE](https://docs.symmetry.com/ste/overview/ways-to-use.md): The five interfaces available for accessing the Symmetry Tax Engine.
- [Hosted API vs. on-premise SDK](https://docs.symmetry.com/ste/overview/hosted-vs-on-premise.md): Choosing between the STE Hosted API and the locally installed on-premise SDK.
- [Tax coverage](https://docs.symmetry.com/ste/overview/coverage.md): The jurisdictions and tax types the Symmetry Tax Engine covers across the U.S. and Canada.
- [Platform and language support](https://docs.symmetry.com/ste/overview/platform-and-language-support.md): Supported operating systems, architectures, languages, and sizing guidance for the On-Premise STE.
- [Licensing](https://docs.symmetry.com/ste/overview/licensing.md): How STE licensing and authentication work across the hosted API, on-premise SDK, and AI interfaces.
- [Hosted API quickstart](https://docs.symmetry.com/ste/quickstarts/hosted-api-quickstart.md): Calculate withholding for one employee with a single JSON request to the hosted STE web service.
- [Java SDK quickstart](https://docs.symmetry.com/ste/quickstarts/java-sdk-quickstart.md): Embed the STE native library and calculate withholding for one employee with the Java SDK.
- [.NET SDK quickstart](https://docs.symmetry.com/ste/quickstarts/dotnet-sdk-quickstart.md): Embed the STE native library and calculate withholding for one employee with the .NET SDK.
- [C SDK quickstart](https://docs.symmetry.com/ste/quickstarts/c-sdk-quickstart.md): Link the native STE library and calculate withholding for one employee with the C API.
- [Canadian payroll quickstart](https://docs.symmetry.com/ste/quickstarts/canadian-payroll-quickstart.md): Run a Canadian payroll calculation in the Symmetry Tax Engine — authenticate, send one request, and read the withholding.
- [How the STE works](https://docs.symmetry.com/ste/core-concepts/how-it-works.md): The STE calculation model from address to withholding, end to end.
- [Wage types](https://docs.symmetry.com/ste/core-concepts/wage-types.md): The categories of wages the STE recognizes and why they matter.
- [Time periods (CTD, MTD, QTD, YTD)](https://docs.symmetry.com/ste/core-concepts/time-periods.md): The input-vs-output convention for period-to-date amounts, and why it matters.
- [Configure, then calculate](https://docs.symmetry.com/ste/core-concepts/configure-then-calculate.md): The two-phase workflow behind every STE calculation: gather the inputs that describe a paycheck, then run the engine against them.
- [STE Hosted API overview](https://docs.symmetry.com/ste/api-reference/overview.md): Base URLs, authentication, and the tools — live Swagger and a Postman collection — for working with the STE Hosted API.
- [schemaFile operation](https://docs.symmetry.com/ste/api-reference/account-information-and-schema/schemafile-operation.md)
- [schemaFileV1 operation](https://docs.symmetry.com/ste/api-reference/account-information-and-schema/schemafilev1-operation.md)
- [Retrieve API schema](https://docs.symmetry.com/ste/api-reference/account-information-and-schema/retrieve-api-schema.md): Retrieve the schema required by the STE Hosted API.
- [Retrieve account information](https://docs.symmetry.com/ste/api-reference/account-information-and-schema/retrieve-account-information.md): Returns account information and transaction count between two dates (passed as parameters in a GET request).
- [Retrieve account information](https://docs.symmetry.com/ste/api-reference/account-information-and-schema/retrieve-account-information-1.md): Returns account information and transaction count between two dates (passed as a POST request).
- [Retrieve miscellaneous parameter definitions for benefit types](https://docs.symmetry.com/ste/api-reference/benefits/retrieve-miscellaneous-parameter-definitions-for-benefit-types.md): Given one or more benefit types and a pay date, returns the date-effective miscellaneous parameter definitions for each type — including name, data type, default value, validation pattern, pick-list values, and help text. This is the benefit analog of /v1/jurisdictionData and is purely informational…
- [Retrieve benefit information](https://docs.symmetry.com/ste/api-reference/benefits/retrieve-benefit-information.md): Retrieve information regarding benefit limits. This is purely informational and is not required to run before computing payroll calculations.
- [Check taxability of benefit contributions](https://docs.symmetry.com/ste/api-reference/benefits/check-taxability-of-benefit-contributions.md): Retrieve the taxability status of different benefit contributions by employees and employers. This is purely informational and is not required to run before computing payroll calculations.
- [Translate an address to a location code](https://docs.symmetry.com/ste/api-reference/location-code/translate-an-address-to-a-location-code.md): Determine a location code based on a submitted home or work address. Location codes are used by the Symmetry Tax Engine to identify which state, county, and jurisdiction boundaries contain a given address.
- [Retrieve unique parameters for specific taxes](https://docs.symmetry.com/ste/api-reference/location-tax-information/retrieve-unique-parameters-for-specific-taxes.md): Retrieve list of unique miscellanous parameters needed to compute specified taxes. Please note that this information is also returned by the `/taxIdList` and `/setTaxList` endpoints.
- [Retrieve taxes for a location](https://docs.symmetry.com/ste/api-reference/location-tax-information/retrieve-taxes-for-a-location.md): Retrieve potentially applicable taxes for a location
- [Retrieve potentially applicable taxes for a location](https://docs.symmetry.com/ste/api-reference/location-tax-information/retrieve-potentially-applicable-taxes-for-a-location.md): Retrieve potentially applicable taxes using the legacy location code
- [List installed STE database versions](https://docs.symmetry.com/ste/api-reference/steversions/list-installed-ste-database-versions.md): Returns the STE database versions available in STE_HOME. Any value in the returned list may be supplied as the version query parameter or version header on /v1/payCalc to calculate against that specific database version.
- [Compute gross-to-net tax withholding](https://docs.symmetry.com/ste/api-reference/payroll-calculations/compute-gross-to-net-tax-withholding.md): Compute payroll taxes based on an employee's gross wages, benefit contributions, and imputed income.
- [Calculate a gross-up payment](https://docs.symmetry.com/ste/api-reference/payroll-calculations/calculate-a-gross-up-payment.md): Compute the gross wages required for desired net pay amount.
- [Retrieve unique tax IDs](https://docs.symmetry.com/ste/api-reference/tax-information/retrieve-unique-tax-ids.md): Retrieve a list of taxes using a search string (along with their respective rates, wage bases, credit limits, and more).
- [Get OpenAPI Specification](https://docs.symmetry.com/ste/api-reference/documentation/get-openapi-specification.md): Returns the OpenAPI 3.0 specification for this API in YAML format.
- [STL API overview](https://docs.symmetry.com/ste/api-reference/stl-overview.md): Base URL, authentication, and endpoints for the Symmetry Tax Logic (STL) API — the service that turns a payroll calculation into a plain-language explanation.
- [Health check (root)](https://docs.symmetry.com/ste/api-reference/health/health-check-root.md): Returns service status and metadata for ALB and infrastructure health checks
- [Health check](https://docs.symmetry.com/ste/api-reference/health/health-check.md): Returns service status and metadata
- [Get API version information](https://docs.symmetry.com/ste/api-reference/symmetry-tax-logic/get-api-version-information.md): Returns current version including major, minor, and revision numbers
- [Generate AI-powered tax calculation explanations](https://docs.symmetry.com/ste/api-reference/symmetry-tax-logic/generate-ai-powered-tax-calculation-explanations.md): Accepts 1-10 tax IDs with a PayCalc context or STE session and returns employee-friendly explanations
- [Compare two paychecks and explain the differences](https://docs.symmetry.com/ste/api-reference/symmetry-tax-logic/compare-two-paychecks-and-explain-the-differences.md): Accepts two PayCalc contexts. Runs both through STE, computes a structured diff, and returns a single AI-generated narrative explaining only the meaningful differences.
- [STE developer AI CoPilot](https://docs.symmetry.com/ste/ai-interfaces/developer-ai-copilot.md): Speed up STE integration with the Developer AI CoPilot. Covers its three AI modes, what the package includes, intended use, and how to download and use it.
- [AI interfaces overview](https://docs.symmetry.com/ste/ai-interfaces/overview.md): The STE MCP and Symmetry Tax Logic — conversational calculation and AI log analysis layered on the engine.
- [Symmetry Tax Logic Chat](https://docs.symmetry.com/ste/ai-interfaces/tax-logic-chat.md): An AI-powered agent that explains, step by step, how the Symmetry Tax Engine calculated a specific tax from your log file or JSON payload.
- [STE MCP overview](https://docs.symmetry.com/ste/ai-interfaces/mcp-overview.md): Access STE's payroll tax calculation engine through plain English, inside the AI tools you already use — no code, no developer ticket, no payload to assemble.
- [STE MCP installation](https://docs.symmetry.com/ste/ai-interfaces/mcp-installation.md): Install and connect the Symmetry Tax Engine Model Context Protocol (MCP) server in Cursor, Claude Code, Gemini CLI, or Claude Desktop.
- [STE MCP troubleshooting](https://docs.symmetry.com/ste/ai-interfaces/mcp-troubleshooting.md): Fix a server you cannot reach, a redirect_mismatch after sign-in, tools that never appear, expired tokens, and blocked requests — or reset the connection and start over.
- [Symmetry Tax Logic API](https://docs.symmetry.com/ste/ai-interfaces/tax-logic-api.md): A single API endpoint that explains payroll tax calculations in plain language for employees and payroll managers — implementable in a day.
- [Quick start](https://docs.symmetry.com/ste/ai-interfaces/tax-logic-api/quick-start.md): The fastest way to get started with the Symmetry Tax Logic (STL) API — test with Postman, run a sample client, or dive into the full tutorial.
- [Payroll context](https://docs.symmetry.com/ste/ai-interfaces/tax-logic-api/payroll-context.md): Assemble the payroll context STL API needs to trace and explain a paycheck, passing the same inputs used at calculation time via the STE JSON API or on-premise SDK.
- [Introduction to Symmetry Guides](https://docs.symmetry.com/guides/overview/introduction.md): Orient to Symmetry Guides: log in, use Ask AI on Search, filter Taxes for rates and records, and open Filing Tax Program tabs for agency guidance.
- [Quickstart: Look up a tax rate and filing instructions](https://docs.symmetry.com/guides/getting-started/quickstart.md): Get productive in Guides fast: log in, Ask AI on Search, filter Taxes for rates, then open Filing Tax Program tabs for step-by-step instructions.
- [Webhooks Overview: Register Callback URLs in Guides](https://docs.symmetry.com/guides/webhooks/overview.md): Set up Guides webhooks by registering up to five Callback URLs under Settings > Manage webhooks. Covers Send test and troubleshooting from the Activity tab.
- [Migrating from Tax Notification Service to Symmetry Guides](https://docs.symmetry.com/guides/migrating/from-tax-notification-service.md): Plan your TNS-to-Guides migration: feature comparison, transition timeline, Client Support Center access, and Taxes/Filing field mapping.
- [What is Symmetry Payroll Forms?](https://docs.symmetry.com/spf/overview/what-is-spf.md): Automated federal, state, and local employee withholding forms for the U.S. and Canada: determined, completed, and returned as signed PDFs and structured tax data.
- [Implementation types](https://docs.symmetry.com/spf/overview/implementation-types.md): Choosing between the SPF API, the Symmetry-hosted forms UI, and On-Premise: what each one asks of you and what it gives you in return.
- [Form coverage](https://docs.symmetry.com/spf/overview/coverage.md): The withholding forms Symmetry Payroll Forms supports across the United States and Canada.
- [Platform and browser support](https://docs.symmetry.com/spf/overview/platform-and-browser-support.md): Server requirements for SPF On-Premise, and the browsers and mobile operating systems supported by the SPF employee interface.
- [Licensing](https://docs.symmetry.com/spf/overview/licensing.md): How SPF licensing works across the API, Hosted, and On-Premise: the credentials you're issued and what each one unlocks.
- [Authentication in SPF](https://docs.symmetry.com/spf/getting-started/authentication.md): Authenticate SPF Hosted, On-Premise, and API clients for secure requests. Covers basic auth, OAuth 2.0 postbacks, JWT access tokens, and API key headers.
- [Quickstart: Launch your first hosted form](https://docs.symmetry.com/spf/getting-started/hosted-quickstart.md): Go live with SPF Hosted using Download Center, Admin Panel, and Settings Builder. Covers form modes, Registration JSON, and optional CSS customization.
- [Symmetry Payroll Forms hosted network diagram](https://docs.symmetry.com/spf/getting-started/hosted-network-diagram.md): Map SPF Hosted network components for architecture and security planning. Covers key Hosted elements, traffic paths, and client integration touchpoints.
- [Quickstart: Complete a form with the SPF API](https://docs.symmetry.com/spf/getting-started/api-quickstart.md): Make your first SPF API call end to end. Covers JWT authentication, form determination, `/flowQuestionSet`, `/formQuestionSet`, and `/fillPdf`.
- [Quickstart: Deploy SPF on-premise](https://docs.symmetry.com/spf/getting-started/on-premise-quickstart.md): Install and verify SPF On-Premise in your servlet container. Covers `SPF_HOME` setup, `settings.json`, SSL and cookies, logging, and first deployment checks.
- [Core concepts overview](https://docs.symmetry.com/spf/core-concepts/overview.md): The ideas behind Symmetry Payroll Forms that apply to every integration: what a form is, how SPF picks forms, how questions are served, and what you get back.
- [The form model](https://docs.symmetry.com/spf/core-concepts/form-model.md): What a form is in Symmetry Payroll Forms: form IDs and their naming conventions, form types, form variants, and how to browse everything SPF supports.
- [Form determination](https://docs.symmetry.com/spf/core-concepts/form-determination.md): How Symmetry Payroll Forms turns an employee's home and work addresses into the set of federal, state, and local withholding forms they need to complete.
- [Form modes (Choose, Guided, Single form)](https://docs.symmetry.com/spf/core-concepts/form-modes.md): Pick SPF Hosted and On-Premise form modes: Choose, Guided, or Single Form. Covers when each mode fits and how employee form selection and validation work.
- [PDFs and tax parameters](https://docs.symmetry.com/spf/core-concepts/form-output.md): The two things a completed SPF form produces (a signed PDF for your records and structured tax parameters for your payroll system) and what you're responsible for afterward.
- [Penalty of perjury (POP) statements in SPF](https://docs.symmetry.com/spf/core-concepts/penalty-of-perjury-statements.md): Understand Penalty of Perjury (POP) statements required on SPF withholding forms. Covers why POP is needed, compliance, examples, and supported forms.
- [Languages and locales](https://docs.symmetry.com/spf/core-concepts/languages-and-locales.md): How SPF handles English, Spanish, and French: the difference between translating the interview and serving an officially translated form, and when each applies.
- [Interstate employees in SPF](https://docs.symmetry.com/spf/configuration/interstate-employees.md): Tune multi-state form recommendations with the interstateEmployee property. Covers when forms become required or optional for Hosted and on-premise clients.
- [Form completion example in the SPF API](https://docs.symmetry.com/spf/api/form-completion-example.md): Walk through the forms, formQuestionSet, and fillPdf endpoints used to complete withholding forms in a Choose Mode implementation.
- [Location data and address verification in the SPF API](https://docs.symmetry.com/spf/api/location-data-and-address-verification.md): Interpret the locationData, addressResultMessages, and addressErrorMessages objects returned by the SPF API. Covers Pennsylvania PSD codes and Ohio school district fields.
- [Residency in the SPF API](https://docs.symmetry.com/spf/api/residency.md): Determine resident and non-resident withholding flows for home and work locations using the SPF API's guided-flows endpoint.
- [Lock-in letters in the SPF API](https://docs.symmetry.com/spf/api/lock-in-letters.md): Use the lockInLetters element to restrict which state and federal withholding forms an employee can change.
- [Settings builder](https://docs.symmetry.com/spf/hosted-and-on-premise/settings-builder.md): Prototype SPF Registration JSON and UI customizations with Settings Builder for Hosted and On-Premise. Covers access steps and generating test configs.
- [Helper pages](https://docs.symmetry.com/spf/hosted-and-on-premise/helper-pages.md): Launch SPF Hosted and On-Premise Helper Pages so employees enter data for form suggestion. Covers blank URLs, prepopulated Registration, and access paths.
- [API: Timezones](https://docs.symmetry.com/spf/references/timezones.md): Timezone IDs accepted by the Timezone header passed to the /fillPdf and /forms endpoints.
- [API: SPF to STE tax parameter mapping (U.S.)](https://docs.symmetry.com/spf/references/ste-tax-parameter-mapping-api.md): Map U.S. SPF API taxParameters to STE via the /spf/steMapping endpoint. Covers response fields, applying mappings in STE, common use cases, plus FAQs.
- [SPF API overview](https://docs.symmetry.com/spf/api-reference/overview.md): Base URLs, authentication, and the tools (live Swagger and Postman collections) for working with the Symmetry Payroll Forms API.
- [Postman collection and environment for SPF API](https://docs.symmetry.com/spf/api-reference/postman-collection.md): Download the SPF Postman collection and environment directly from the API, set your credentials, and send sample requests to every Payroll Forms endpoint.
- [Canada Postman collection for SPF API](https://docs.symmetry.com/spf/api-reference/postman-collection-canadian.md): Sample Canadian requests for the SPF API Postman collection, and how they differ from the U.S. collection.
- [Return applicable forms for given home and work addresses](https://docs.symmetry.com/spf/api-reference/forms/return-applicable-forms-for-given-home-and-work-addresses.md): Retrieve all applicable forms and address normalization and geocoding data for specified home and work address.
- [Return applicable forms for given home and work addresses](https://docs.symmetry.com/spf/api-reference/forms/return-applicable-forms-for-given-home-and-work-addresses-1.md): Retrieve all applicable forms and address normalization and geocoding data for specified home and work address.
- [Return applicable guided flows for given home and work addresses](https://docs.symmetry.com/spf/api-reference/forms/return-applicable-guided-flows-for-given-home-and-work-addresses.md): Returns applicable flows for the specified home and work address, used to filter the list of all applicable forms down to a list of required forms.
- [Return all form ids](https://docs.symmetry.com/spf/api-reference/forms/return-all-form-ids.md): Return all form ids currently supported by SPF.
- [Returns a list of all available form ids and their versions](https://docs.symmetry.com/spf/api-reference/forms/returns-a-list-of-all-available-form-ids-and-their-versions.md): The getAllFormsCatalog endpoint is used to return a list of all form IDs and their Versions currently supported by the Symmetry Payroll Forms API.
- [Retrieve question set for a flow by id](https://docs.symmetry.com/spf/api-reference/questions/retrieve-question-set-for-a-flow-by-id.md): Return a question set for a given flow, used to filter potentially applicable forms down to a list of required forms.
- [Retrieve question set for a form by id](https://docs.symmetry.com/spf/api-reference/questions/retrieve-question-set-for-a-form-by-id.md): Return a question set for a given form. Each question set may contain one or more questions, validation regular expression, and navigation aids. For more information, see form question set.
- [Retrieve completed form PDF and tax parameters](https://docs.symmetry.com/spf/api-reference/pdf-and-tax-parameters/retrieve-completed-form-pdf-and-tax-parameters.md): Return a completed form PDF and relevant tax parameters based on submitted employee data.
- [Return form data (for example, required fields and tax parameter schema)](https://docs.symmetry.com/spf/api-reference/pdf-and-tax-parameters/return-form-data-for-example-required-fields-and-tax-parameter-schema.md): Return form data for specified form (fields, validations, schema).
- [Return blank and unflattened PDF by id](https://docs.symmetry.com/spf/api-reference/pdf-and-tax-parameters/return-blank-and-unflattened-pdf-by-id.md): Return blank and unflattened PDF for requested form id.
- [Return Open API configuration](https://docs.symmetry.com/spf/api-reference/documentation/return-open-api-configuration.md): Return full API configuration.
- [Return SPF-to-STE tax parameter mappings](https://docs.symmetry.com/spf/api-reference/ste-mapping/return-spf-to-ste-tax-parameter-mappings.md): Returns the mapping from SPF tax parameters to their STE equivalents, resolved for the given effective date. Each parameter entry reflects the most recent mapping version with an effectiveDate on or before the requested date. If no effectiveDate is supplied, today's date is used.
- [Get postmancollection](https://docs.symmetry.com/spf/api-reference/postman/get-postmancollection.md)
- [Get postmanenvironment](https://docs.symmetry.com/spf/api-reference/postman/get-postmanenvironment.md)
- [Symmetry I-9 overview](https://docs.symmetry.com/i9/overview/introduction.md): Symmetry I-9 is an embeddable, API-driven solution for completing and managing Form I-9 employment eligibility verification inside your own platform.
- [Form I-9 overview](https://docs.symmetry.com/i9/overview/form-i-9.md): Form I-9 is the federal Employment Eligibility Verification form employers must complete to verify the identity and work authorization of every U.S. hire.
- [I-9 integration workflow](https://docs.symmetry.com/i9/getting-started/integration-workflow.md): End-to-end path to integrate Symmetry I-9: configure employers, add employees and administrators, set up E-Verify, and launch the embedded experiences.
- [Configure employers](https://docs.symmetry.com/i9/getting-started/configure-employers.md): Set up an employer, the business entity your platform supports, as the first step in Symmetry I-9. Covers the register employer endpoint, request, and response.
- [Configure employees & administrators](https://docs.symmetry.com/i9/getting-started/configure-employees-and-administrators.md): Once you've established the employer, you are ready to register the employee (new hire) and employer administrators to the employer, which can happen at any time.
- [Configure E-Verify](https://docs.symmetry.com/i9/e-verify/configure.md): Configure E-Verify for an employer after registering it and its administrator. Covers the request and response elements and the two-step implementation process.
- [Start employee's I-9](https://docs.symmetry.com/i9/getting-started/start-employee-i-9.md): Generate a new hire's embedded Form I-9 experience after configuring the employer, employee, and administrators. Covers the request, response, and response elements.
- [Action on I-9](https://docs.symmetry.com/i9/getting-started/action-on-i-9.md): Generate the embedded administrator experience so HR can track I-9 progress and take action on Forms I-9. Covers the request, response, and response elements.
- [Receive completed I-9 data](https://docs.symmetry.com/i9/getting-started/retrieve-completed-data.md): Retrieve completed Form I-9 data once Sections 1 and 2 are done. Covers the request, response fields, verification documents, audit logs, and postback delivery.
- [Core concepts overview](https://docs.symmetry.com/i9/core-concepts/overview.md): The mechanics that apply to every Symmetry I-9 API call: authentication, webhooks and postback, pagination, and timezones. Read these once before building any workflow.
- [Authentication](https://docs.symmetry.com/i9/core-concepts/authentication.md): Authenticate Symmetry I-9 with a system-level API key and one-time access URIs for embedded sessions. Covers request headers, the API domain, and API versioning.
- [Resource model & identifiers](https://docs.symmetry.com/i9/core-concepts/resource-model.md): How Symmetry I-9 resources nest from account to employer to employee to submission, and the identifier format each one uses—including why submission IDs are integers.
- [Statuses & lifecycle](https://docs.symmetry.com/i9/core-concepts/statuses-and-lifecycle.md): An I-9's progress is three independent statuses. Covers employeeSectionOneStatus, i9CountersignStatus, and everifyCaseStatus, and how to track each.
- [Webhooks](https://docs.symmetry.com/i9/core-concepts/webhooks.md): Receive real-time Symmetry I-9 notifications via webhooks. Covers every event key and its payload, callback authentication, and failure notifications.
- [Pagination](https://docs.symmetry.com/i9/core-concepts/pagination.md): Page through Symmetry I-9 list endpoints with the ?page query parameter. Covers which GET endpoints support it, the Pagination-* response headers, and the Link header.
- [Timezones](https://docs.symmetry.com/i9/core-concepts/timezones.md): Set an employer's timezone from the ten supported values and interpret I-9 dates correctly. Covers the supported list, calendar dates vs. timestamps, and why date boundaries affect compliance.
- [Embed the I-9 experience in an iframe](https://docs.symmetry.com/i9/embedded-experiences/iframe-embed.md): Configure the iframe attributes and feature policy permissions needed to embed the employee and administrator I-9 experiences.
- [Embedded employer experience](https://docs.symmetry.com/i9/embedded-experiences/employer-experience.md): The embedded administrator experience for managing I-9s. Covers configuring E-Verify, actioning I-9 submissions, and reviewing the employee dashboard.
- [Custom theming for embedded experiences](https://docs.symmetry.com/i9/custom-theming/app-theming.md): Apply your branding to embedded Symmetry I-9 experiences. Covers the account and employer theme inheritance model, how it works, and the supported styling elements.
- [Account-level theming](https://docs.symmetry.com/i9/custom-theming/account-level-theming.md): Manage an account-level theme that cascades to every employer. Covers the endpoint, supported methods, configuration structure, and apply, update, and delete examples.
- [Employer-level theming](https://docs.symmetry.com/i9/custom-theming/employer-level-theming.md): Manage a theme for a specific employer that overrides your account default. Covers supported methods, configuration structure, and CRUD examples.
- [Remote I-9 overview (authorized representatives)](https://docs.symmetry.com/i9/remote-i-9/authorized-representatives.md): Verify identity and work authorization remotely using Authorized Representatives. Covers enabling remote I-9, representative requirements, and designating one.
- [Alternative procedure](https://docs.symmetry.com/i9/remote-i-9/alternative-procedure.md): The Alternative Procedure lets E-Verify-enrolled employers verify documents remotely. Covers eligibility requirements and how the process works in Symmetry I-9.
- [Remote reverification (Supplement B)](https://docs.symmetry.com/i9/remote-i-9/reverification-supplement-b.md): Enable remote document verification for Supplement B reverification inside the embedded I-9 experience. Covers prerequisites, the endpoint, and the workflow.
- [Document verification overview](https://docs.symmetry.com/i9/document-verification/overview.md): Document Verification screens Form I-9 supporting documents with OCR. Covers verified document types, the employee experience, and managing verification results.
- [E-Verify case statuses](https://docs.symmetry.com/i9/e-verify/case-statuses.md): Reference for every E-Verify case status Symmetry returns: what each status means and the action needed to move a case toward resolution.
- [Resolve an E-Verify TNC](https://docs.symmetry.com/i9/e-verify/tentative-nonconfirmations-tncs.md): Build the TNC workflow end to end. Covers the pending_referral webhook, retrieving FAN and RDC documents from the case detail API, employee and administrator embedded sessions, and status transitions.
- [Manage E-Verify cases (API)](https://docs.symmetry.com/i9/e-verify/manage-cases-api.md): Retrieve and manage automatically created E-Verify cases through the API. Covers the case list and detail endpoints, query parameters, and response fields.
- [Compliance & audit readiness overview](https://docs.symmetry.com/i9/compliance-and-audit-readiness/overview.md): How Symmetry I-9 keeps you audit-ready: who owns completed I-9 data, the M-274 retention rules, and the audit trail available for ICE and DHS inspections.
- [Retention](https://docs.symmetry.com/i9/compliance-and-audit-readiness/retention.md): How Symmetry delivers completed Form I-9 data to your postback URL and the M-274 retention rules: keep each form 3 years after hire or 1 year after termination.
- [Audit trail](https://docs.symmetry.com/i9/compliance-and-audit-readiness/audit-events.md): What the Symmetry I-9 audit trail captures for Forms I-9 and E-Verify cases, and where administrators view it in the employer embedded mode.
- [Audit log reference](https://docs.symmetry.com/i9/compliance-and-audit-readiness/audit-logs.md): Retrieve the auditLogs array from an I-9 submission and look up any eventName. Covers the request, the fields on each entry, and the complete audit event catalog.
- [ICE audits & Symmetry I-9](https://docs.symmetry.com/i9/compliance-and-audit-readiness/ice-audits.md): Respond to an ICE Notice of Inspection using Symmetry I-9: review the notice, locate and export Forms I-9, pull E-Verify case data, and use audit trails.
- [I-9 API overview](https://docs.symmetry.com/i9/api-reference/overview.md): Base URLs, authentication, and the tools (live Swagger and a Postman collection) for working with the Symmetry I-9 API.
- [Postman collection and environment for I-9 API](https://docs.symmetry.com/i9/api-reference/postman-collection.md): Download the Symmetry I-9 Postman collection and environment directly from the API, set your credentials, and send sample requests to every I-9 endpoint.
- [Return Open API configuration](https://docs.symmetry.com/i9/api-reference/documentation/return-open-api-configuration.md): Return full API configuration.
- [Postman Collection](https://docs.symmetry.com/i9/api-reference/postman/postman-collection.md): Postman Collection
- [Postman Environment Variables](https://docs.symmetry.com/i9/api-reference/postman/postman-environment-variables.md): Postman Environment Variables
- [Apply custom app theme configuration](https://docs.symmetry.com/i9/api-reference/account-custom-app-theming/apply-custom-app-theme-configuration.md): Applies a new custom app theme configuration to all employers under the account. This will cascade the theme update to all employers' subdomains in WorkBright.
- [Delete custom app theme configuration](https://docs.symmetry.com/i9/api-reference/account-custom-app-theming/delete-custom-app-theme-configuration.md): Deletes the custom app theme configuration for all employers under the account. This will cascade the deletion to all employers' subdomains and restore default styling.
- [Update custom app theme configuration](https://docs.symmetry.com/i9/api-reference/account-custom-app-theming/update-custom-app-theme-configuration.md): Updates the existing custom app theme configuration for all employers under the account. Only the provided fields will be updated; other fields will remain unchanged. This will cascade the update to all employers' subdomains. Returns a status report showing which domains succeeded or failed.
- [Returns a list of all employers for account](https://docs.symmetry.com/i9/api-reference/employer/returns-a-list-of-all-employers-for-account.md): Returns a list of all employers
- [Registers an Employer](https://docs.symmetry.com/i9/api-reference/employer/registers-an-employer.md): Registers an Employer associated with an Account
- [Return employer data (for example, Admin details, employee details, and product tier)](https://docs.symmetry.com/i9/api-reference/employer/return-employer-data-for-example-admin-details-employee-details-and-product-tier.md): Return employer data for specified employer.
- [Request deletion of an Employer](https://docs.symmetry.com/i9/api-reference/employer/request-deletion-of-an-employer.md): Requests deletion of an Employer and all associated data (employees, submissions, admins).
- [Updates an Employer](https://docs.symmetry.com/i9/api-reference/employer/updates-an-employer.md): Updates an Employer associated with an Account
- [Retrieve current E-Verify settings for an employer](https://docs.symmetry.com/i9/api-reference/employer/retrieve-current-e-verify-settings-for-an-employer.md): Retrieves the current E-Verify account configuration for an employer
- [Configure E-Verify Settings](https://docs.symmetry.com/i9/api-reference/employer/configure-e-verify-settings.md): Configure E-Verify settings for an employer
- [Update E-Verify settings for an employer](https://docs.symmetry.com/i9/api-reference/employer/update-e-verify-settings-for-an-employer.md): Updates existing E-Verify settings for an employer
- [Return admins for a given employer](https://docs.symmetry.com/i9/api-reference/admin/return-admins-for-a-given-employer.md): Return admins for a given employer.
- [Registers an Admin with an Employer](https://docs.symmetry.com/i9/api-reference/admin/registers-an-admin-with-an-employer.md): Registers an Admin associated with an Employer
- [Return admin data](https://docs.symmetry.com/i9/api-reference/admin/return-admin-data.md): Return admin data for the specified admin ID
- [Deletes a registered Admin](https://docs.symmetry.com/i9/api-reference/admin/deletes-a-registered-admin.md): Deletes an Admin associated with an Employer
- [Updates a registered Admin](https://docs.symmetry.com/i9/api-reference/admin/updates-a-registered-admin.md): Updates an Admin associated with an Employer
- [Generate a direct link to an individual employee's submission page](https://docs.symmetry.com/i9/api-reference/admin/generate-a-direct-link-to-an-individual-employees-submission-page.md): Generate a direct link to an individual employee's submission page
- [Generate a direct link to the E-Verify case index page](https://docs.symmetry.com/i9/api-reference/admin/generate-a-direct-link-to-the-e-verify-case-index-page.md): Generate a direct link to the E-Verify case index page
- [Generate a deep link to a specific E-Verify case in the embedded UI](https://docs.symmetry.com/i9/api-reference/admin/generate-a-deep-link-to-a-specific-e-verify-case-in-the-embedded-ui.md): Generate a deep link to a specific E-Verify case in the embedded UI
- [Generate Link to Access E-Verify Settings](https://docs.symmetry.com/i9/api-reference/admin/generate-link-to-access-e-verify-settings.md): Generate link to access e-verify settings
- [Generate a direct link to the administrator index page filtered by I-9s requiring Section 2 verification](https://docs.symmetry.com/i9/api-reference/admin/generate-a-direct-link-to-the-administrator-index-page-filtered-by-i-9s-requiring-section-2-verification.md): Generate a direct link to the administrator index page filtered by I-9s requiring Section 2 verification
- [Generate a token for an admin to access the I9 system](https://docs.symmetry.com/i9/api-reference/admin/generate-a-token-for-an-admin-to-access-the-i9-system.md): Generate a token for admin access
- [Get custom app theme configuration for employer](https://docs.symmetry.com/i9/api-reference/employer-custom-app-theming/get-custom-app-theme-configuration-for-employer.md): Retrieves the current custom app theme configuration for the specified employer. Returns the theme configuration stored in WorkBright, or null if no theme is configured.
- [Apply custom app theme configuration for employer](https://docs.symmetry.com/i9/api-reference/employer-custom-app-theming/apply-custom-app-theme-configuration-for-employer.md): Applies a new custom app theme configuration to the specified employer. This will create or replace the existing theme configuration in WorkBright.
- [Delete custom app theme configuration for employer](https://docs.symmetry.com/i9/api-reference/employer-custom-app-theming/delete-custom-app-theme-configuration-for-employer.md): Deletes the custom app theme configuration for the specified employer. This will remove the theme from WorkBright and restore default styling.
- [Update custom app theme configuration for employer](https://docs.symmetry.com/i9/api-reference/employer-custom-app-theming/update-custom-app-theme-configuration-for-employer.md): Updates the existing custom app theme configuration for the specified employer. Only the provided fields will be updated; other fields will remain unchanged.
- [Return employees for a given employer](https://docs.symmetry.com/i9/api-reference/employee/return-employees-for-a-given-employer.md): Return employees for a given employer.
- [Register a new employee with an employer](https://docs.symmetry.com/i9/api-reference/employee/register-a-new-employee-with-an-employer.md): Register a new employee with an employer
- [Return employee data](https://docs.symmetry.com/i9/api-reference/employee/return-employee-data.md): Return employee data for the specified employee ID
- [Deletes a registered Employee](https://docs.symmetry.com/i9/api-reference/employee/deletes-a-registered-employee.md): Deletes an Employee associated with an Employer
- [Update an existing employee with an employer](https://docs.symmetry.com/i9/api-reference/employee/update-an-existing-employee-with-an-employer.md): Update an existing employee with an employer
- [Generate a token for an employee to access the I9 form](https://docs.symmetry.com/i9/api-reference/employee/generate-a-token-for-an-employee-to-access-the-i9-form.md): Generate a token for employee access
- [Promote an employee to administrator role](https://docs.symmetry.com/i9/api-reference/employee/promote-an-employee-to-administrator-role.md): Promotes an existing employee to administrator, granting them admin privileges while preserving their employee history.
- [Return I9 submissions for an employee](https://docs.symmetry.com/i9/api-reference/employee/return-i9-submissions-for-an-employee.md): Return I9 submissions for an employee.
- [Return a specific I9 submission for an employee](https://docs.symmetry.com/i9/api-reference/employee/return-a-specific-i9-submission-for-an-employee.md): Return a specific I9 submission for an employee.
- [Reject an I-9 submission](https://docs.symmetry.com/i9/api-reference/employee/reject-an-i-9-submission.md): Moves the submission to a rejected state. Only the latest I-9 submission for this employee can be rejected. The reason you provide may be shared with the employee (for example by email), depending on configuration.
- [Request Remote Reverification for an employee](https://docs.symmetry.com/i9/api-reference/employee/request-remote-reverification-for-an-employee.md): Allows an administrator to request remote reverification for an employee. Employee must have i9RemoteCounterSignAuthorized and i9RemoteReverificationAuthorized enabled.
- [Reset an I-9 submission](https://docs.symmetry.com/i9/api-reference/employee/reset-an-i-9-submission.md): Resets the specified I-9 submission so that a new submission can be requested. The existing submission becomes a historical record.
- [Return e-verify cases for a given employer](https://docs.symmetry.com/i9/api-reference/everify/return-e-verify-cases-for-a-given-employer.md): Return e-verify cases for a given employer.
- [Return e-verify case data](https://docs.symmetry.com/i9/api-reference/everify/return-e-verify-case-data.md): Return e-verify case data for the specified e-verify Case ID
- [Return API version](https://docs.symmetry.com/i9/api-reference/version/return-api-version.md): Return API version
- [Introduction to Payroll Point](https://docs.symmetry.com/prp/overview/introduction.md): What Symmetry Payroll Point does, how it determines taxes from an address, what it returns, and how it differs from the Symmetry Tax Engine.
- [Portal vs. API](https://docs.symmetry.com/prp/overview/portal-vs-api.md): Choose between Payroll Point Portal and the REST API. Compares Maps and Batch against the taxes endpoint, technical requirements, and typical users.
- [Tax coverage](https://docs.symmetry.com/prp/overview/tax-coverage.md): Which taxes Payroll Point returns: federal, state, local, and employer taxes across the United States, and what falls outside its scope.
- [Data and accuracy](https://docs.symmetry.com/prp/overview/data-and-accuracy.md): How Payroll Point geocodes an address, the shapefile data behind tax determination, how to read geocode quality, and what to do when a location resolves incorrectly.
- [Minimum wage add-on](https://docs.symmetry.com/prp/overview/mw-add-on.md): What the Payroll Point minimum wage add-on returns, where it appears in Portal and the API, and how it relates to Symmetry Minimum Wage Finder.
- [Prerequisites](https://docs.symmetry.com/prp/getting-started/prerequisites.md): What you need before your first Payroll Point lookup: credentials for Portal or the API, account configuration, and the global settings that change what comes back.
- [Quickstart: Look up taxes in Portal](https://docs.symmetry.com/prp/getting-started/portal-quickstart.md): Log in to Payroll Point Portal and run your first lookup. Covers Maps tax search, nexus and nonresident certificate inputs, and an optional Batch walkthrough.
- [Quickstart: Call the Payroll Point API](https://docs.symmetry.com/prp/getting-started/api-quickstart.md): Make your first PRP API tax lookup. Covers JWT authentication with an API key, calling `/prp/v1/taxes`, staging vs production, and reading the JSON response.
- [Required taxes](https://docs.symmetry.com/prp/core-concepts/required-taxes.md): How Payroll Point uses home and work locations, employer nexus, reciprocity, and courtesy withholding to decide which state taxes are required for an employee.
- [Reciprocity and nonresident certificates](https://docs.symmetry.com/prp/core-concepts/reciprocity-and-nonresident-certificates.md): Apply reciprocity and nonresident certificates in PRP. Covers cross-state withholding, the certificate input, and how results change with nexus.
- [Tax results](https://docs.symmetry.com/prp/core-concepts/tax-results.md): How to read a Payroll Point result: required versus additional taxes, employee versus employer taxes, resident versus nonresident, and how the pay date shapes what comes back.
- [Minimum wage concepts](https://docs.symmetry.com/prp/core-concepts/mw-overview.md): How Payroll Point selects minimum wage rates for a work location, and where the rates surface across Maps, Batch, the Wage Rates tab, and the API.
- [Rate types](https://docs.symmetry.com/prp/core-concepts/mw-rate-types.md): Match an employee to the correct rate within an authority. Covers majorType REG/TIP/EXM plus industryTypeCode and minorTypeCode override selection.
- [Maps overview](https://docs.symmetry.com/prp/portal/maps.md): Look up taxes for one employee's home and work address pair in Maps, and see the geospatial boundaries behind each tax returned.
- [Global settings](https://docs.symmetry.com/prp/portal/global-settings.md): Org-wide Portal settings that change which taxes are returned. Covers payer, authority, tax withholding, address suggestions, and splitting PA EITs and LSTs.
- [Retrieve recent minimum wage rate updates](https://docs.symmetry.com/prp/api/recent-mw-updates.md): Retrieve recently updated minimum wage rates via API. Covers `/prp/v1/minimumwage/id` with `updatedSince`, filtering by timeframe, and reading `mwUid` rate changes.
- [Retrieve upcoming minimum wage rate updates](https://docs.symmetry.com/prp/api/upcoming-mw-updates.md): Retrieve upcoming minimum wage rate updates via API. Covers `/prp/v1/minimumwage/rates/effective`, effective date ranges, and linking rates back to `mwUid` values.
- [PRP API overview](https://docs.symmetry.com/prp/api-reference/overview.md): Base URLs, authentication, and the tools (live Swagger and a Postman collection) for working with the Symmetry Payroll Point API.
- [Postman collection and environment for PRP API](https://docs.symmetry.com/prp/api-reference/postman-collection.md): Download the PRP Postman collection and environment directly from the API, set your credentials, and send sample requests to every Payroll Point endpoint.
- [Returns taxes based on single home and multiple work locations passed in](https://docs.symmetry.com/prp/api-reference/location-taxes/returns-taxes-based-on-single-home-and-multiple-work-locations-passed-in.md)
- [Returns minimum wage rates by location (address or coordinates) and effective date](https://docs.symmetry.com/prp/api-reference/minimum-wage/returns-minimum-wage-rates-by-location-address-or-coordinates-and-effective-date.md): The result contains all hierarchy levels based on address or coordinates (valid coordinates take precedence over the address). The valid date format is yyyy-mm-dd.
- [Returns upcoming minimum wage rates by effective date range](https://docs.symmetry.com/prp/api-reference/minimum-wage/returns-upcoming-minimum-wage-rates-by-effective-date-range.md): mwUid has to be a string in format stateCode-authorityType-authorityCode-majorType-industryTypeCode-minorTypeCode. Also wildcard '*' can be used and unspecified-rest is accepted as well. To specify an effective date  range the 'from' and 'to' parameters must be set. The valid date format is yyyy-mm-…
- [Returns minimum wage rates by location (address or coordinates) and effective date](https://docs.symmetry.com/prp/api-reference/minimum-wage/returns-minimum-wage-rates-by-location-address-or-coordinates-and-effective-date-1.md): The result contains all hierarchy levels based on address or coordinates (valid coordinates take precedence over the address). The valid date format is yyyy-mm-dd.
- [Returns minimum wage rates by the minimum wage unique id](https://docs.symmetry.com/prp/api-reference/minimum-wage/returns-minimum-wage-rates-by-the-minimum-wage-unique-id.md): mwUid has to be a string in format stateCode-authorityType-authorityCode-majorType-industryTypeCode-minorTypeCode. Also wildcard '*' can be used and unspecified-rest is accepted as well. If effectiveDate is specified, returns rates valid at this date; if updatedSince is specified, returns rates upda…
- [Returns Account information and transaction count between the dates passed as parameters](https://docs.symmetry.com/prp/api-reference/account-info/returns-account-information-and-transaction-count-between-the-dates-passed-as-parameters.md): Use yyyy-mm-dd date format
- [Postman environment](https://docs.symmetry.com/prp/api-reference/postman/postman-environment.md)
- [Postman collection](https://docs.symmetry.com/prp/api-reference/postman/postman-collection.md)
- [Return the Open API Yaml Configuration File.](https://docs.symmetry.com/prp/api-reference/documentation/return-the-open-api-yaml-configuration-file.md)
- [Introduction to Minimum Wage Finder](https://docs.symmetry.com/mwf/overview/introduction.md): What Symmetry Minimum Wage Finder does, how it resolves a work address to applicable minimum wage rates, what a lookup returns, and what falls outside its scope.
- [Portal vs. API](https://docs.symmetry.com/mwf/overview/portal-vs-api.md): Choose between Minimum Wage Finder Portal and the REST API. Compares Maps, Batch and Wage Rates against the rate endpoints, and typical users of each.
- [Rate coverage](https://docs.symmetry.com/mwf/overview/rate-coverage.md): What Minimum Wage Finder covers: every US authority that sets a minimum wage, across regular, tipped and exempt categories, and what falls outside its scope.
- [Data and accuracy](https://docs.symmetry.com/mwf/overview/data-and-accuracy.md): How Minimum Wage Finder resolves an address to coordinates, matches jurisdiction boundaries, keeps rates current, and what to check when a location resolves incorrectly.
- [Standalone MWF or PRP add-on](https://docs.symmetry.com/mwf/overview/standalone-or-add-on.md): The same minimum wage data reaches you two ways: as Symmetry Minimum Wage Finder, or as an add-on to Payroll Point. How the surfaces and endpoint paths differ.
- [Prerequisites](https://docs.symmetry.com/mwf/getting-started/prerequisites.md): What you need before your first Minimum Wage Finder lookup: credentials for Portal or the API, the account setup your administrator completes, and the minimum wage entitlement.
- [Quickstart: Look up rates in Portal](https://docs.symmetry.com/mwf/getting-started/portal-quickstart.md): Log in to MWF Portal and run your first rate lookup. Covers authorization keys, Maps single-address search, optional Batch CSV import, and next steps.
- [Quickstart: Call the MWF API](https://docs.symmetry.com/mwf/getting-started/api-quickstart.md): Make your first MWF API call end to end. Covers JWT login, /mwf/v1/location by address, /mwf/v1/id by mwUid, and staging versus production base URLs.
- [Rate types](https://docs.symmetry.com/mwf/core-concepts/rate-types.md): Match an employee to the correct rate within an authority. Covers majorType REG/TIP/EXM plus industryTypeCode and minorTypeCode override selection.
- [Maps overview](https://docs.symmetry.com/mwf/portal/maps.md): Look up applicable rates for one work address in Maps. Covers geospatial boundary display settings and how toggles change visualization only, not rates.
- [Batch overview](https://docs.symmetry.com/mwf/portal/batch.md): Run bulk minimum wage lookups in Batch via CSV import or manual entry. Covers creating and running batches, downloading results, the 5MB limit, and 30-day retention.
- [Retrieve recent minimum wage rate updates](https://docs.symmetry.com/mwf/api/recent-rate-updates.md): List recently changed rates with /mwf/v1/id and updatedSince. Covers mwUid wildcards, pageNumber and pageSize pagination, and totalElements handling.
- [Retrieve upcoming minimum wage rate updates](https://docs.symmetry.com/mwf/api/upcoming-rate-updates.md): Retrieve future-dated rates with /mwf/v1/rates/effective. Covers the from and to date range, their defaults, and mwUid wildcards.
- [Endpoints](https://docs.symmetry.com/mwf/resources/endpoints.md): Call MWF rate endpoints with sample requests. Covers /mwf/v1/location, /mwf/v1/id, /mwf/v1/rates/effective, params, useAddressSuggestion, and response objects.
- [MWF API overview](https://docs.symmetry.com/mwf/api-reference/overview.md): Base URLs, authentication, and the tools (live Swagger and a Postman collection) for working with the Symmetry Minimum Wage Finder API.
- [Postman collection and environment for MWF API](https://docs.symmetry.com/mwf/api-reference/postman-collection.md): Download the MWF Postman collection and environment directly from the API, set your credentials, and send sample requests to every Minimum Wage Finder endpoint.
- [Returns minimum wage rates by location (address or coordinates) and effective date](https://docs.symmetry.com/mwf/api-reference/minimum-wage/returns-minimum-wage-rates-by-location-address-or-coordinates-and-effective-date.md): The result contains all hierarchy levels based on address or coordinates (valid coordinates take precedence over the address). The valid date format is yyyy-mm-dd. Optionally, will include jursidictions that the provided location resides in.
- [Returns upcoming minimum wage rates by effective date range](https://docs.symmetry.com/mwf/api-reference/minimum-wage/returns-upcoming-minimum-wage-rates-by-effective-date-range.md): mwUid has to be a string in format stateCode-authorityType-authorityCode-majorType-industryTypeCode-minorTypeCode. Also wildcard '*' can be used and unspecified-rest is accepted as well. To specify an effective date  range the 'from' and 'to' parameters must be set. The valid date format is yyyy-mm-…
- [Returns minimum wage rates by location (address or coordinates) and effective date](https://docs.symmetry.com/mwf/api-reference/minimum-wage/returns-minimum-wage-rates-by-location-address-or-coordinates-and-effective-date-1.md): The result contains all hierarchy levels based on address or coordinates (valid coordinates take precedence over the address). The valid date format is yyyy-mm-dd.
- [Returns minimum wage rates by the minimum wage unique id](https://docs.symmetry.com/mwf/api-reference/minimum-wage/returns-minimum-wage-rates-by-the-minimum-wage-unique-id.md): mwUid has to be a string in format stateCode-authorityType-authorityCode-majorType-industryTypeCode-minorTypeCode. Also wildcard '*' can be used and unspecified-rest is accepted as well. If effectiveDate is specified, returns rates valid at this date; if updatedSince is specified, returns rates upda…
- [Postman environment](https://docs.symmetry.com/mwf/api-reference/postman/postman-environment.md)
- [Postman collection](https://docs.symmetry.com/mwf/api-reference/postman/postman-collection.md)
- [Return the Open API Yaml Configuration File.](https://docs.symmetry.com/mwf/api-reference/documentation/return-the-open-api-yaml-configuration-file.md)
- [What is Calculators by Symmetry (CBS)?](https://docs.symmetry.com/cbs/overview/what-is-cbs.md): What Calculators by Symmetry (CBS) is: accurate, compliant paycheck calculators you embed as a widget or call as a REST API, and how the two paths differ.
- [Widgets vs. API](https://docs.symmetry.com/cbs/overview/choose-path.md): Decide between Calculators by Symmetry (CBS) widgets and the calculators API based on what you're trying to build.
- [Available calculators](https://docs.symmetry.com/cbs/overview/available-calcs.md): Every calculator offered by Calculators by Symmetry (CBS), with a one-line description and the integration paths that support it.
- [Data and accuracy](https://docs.symmetry.com/cbs/overview/data-and-accuracy.md): How CBS handles calculation data across widgets and the API, and where the accuracy of its results comes from.
- [Prerequisites](https://docs.symmetry.com/cbs/getting-started/prerequisites.md): What you need before embedding a CBS widget or calling the calculators API: your key, supported browsers, and hosting.
- [Quickstart: Embed a widget](https://docs.symmetry.com/cbs/getting-started/embed-widget.md): Add a CBS widget to your page with a single script tag.
- [Quickstart: Call the calculators API](https://docs.symmetry.com/cbs/getting-started/call-api.md): Authenticate, discover the calculators, and run your first CBS calculation.
- [How calculators work](https://docs.symmetry.com/cbs/core-concepts/how-calcs-work.md): A CBS calculator is one REST resource and one widget running the same gross-to-net calculation.
- [Authentication model](https://docs.symmetry.com/cbs/core-concepts/authentication-model.md): How CBS authenticates: one API key used by both the widget and the API, and how it compares to Symmetry's other products.
- [Calculation methods by calculator](https://docs.symmetry.com/cbs/core-concepts/calc-methods.md): How each CBS calculator withholds federal and state tax: annualized, flat, or current aggregation, mapped per calculator (salary, bonus, gross-up, 401k).
- [Configuration methods](https://docs.symmetry.com/cbs/widgets/configuration-methods.md): The three ways to configure a CBS widget: inline JSON, an external URL, and the admin console, and how they combine.
- [Customize widget help text](https://docs.symmetry.com/cbs/widgets/customize-helptext.md): Override the popup help text a widget shows when a field receives focus, or turn help text off entirely.
- [Load widget defaults from a URL](https://docs.symmetry.com/cbs/widgets/defaults-from-url.md): Host a JSON file of widget default values and styling and point the widget at it via JSONP.
- [Make a widget responsive](https://docs.symmetry.com/cbs/widgets/make-responsive.md): Fit a CBS widget into a fixed-width or fluid container.
- [Show calculators side by side](https://docs.symmetry.com/cbs/widgets/multi-calc.md): Place up to four calculators next to each other with the multi-calculator widget.
- [Enable optional widget features](https://docs.symmetry.com/cbs/widgets/special-features.md): Turn on imputed income, calculation summation, and report printing or emailing.
- [Embed a widget in common layouts](https://docs.symmetry.com/cbs/widgets/examples.md): Recipes for embedding CBS widgets: employee self-service portals, popups, and multi-deduction setups.
- [Request and response structure](https://docs.symmetry.com/cbs/api/request-and-response.md): The CBS API envelope: content plus _links, and the model, fields, and calculation response shapes.
- [Rate limits](https://docs.symmetry.com/cbs/api/rate-limits.md): The CBS API usage-limit response headers and what happens when a trial key reaches its cap.
- [Build a custom salary calculator UI](https://docs.symmetry.com/cbs/api/build-calc-ui.md): Use the fields endpoint to render your own salary form, then POST inputs for results.
- [Run a gross-up calculation](https://docs.symmetry.com/cbs/api/run-gross-up.md): Determine the gross pay needed to hit a target net pay with the gross-up calculator.
- [Calculate bonus withholding](https://docs.symmetry.com/cbs/api/calc-bonus-withholding.md): Choose between the percent (flat) method and the aggregate method for bonus withholding.
- [Model 401(k) and 403(b) contribution changes](https://docs.symmetry.com/cbs/api/model-401k-403b-contributions.md): Show the paycheck impact of changing a retirement contribution.
- [Calculate a final paycheck](https://docs.symmetry.com/cbs/api/calc-final-paycheck.md): Handle termination pay with current and prior pay-period data using the final pay calculator.
- [Generate a printable pay stub](https://docs.symmetry.com/cbs/api/generate-pay-stub.md): Use the print object and report endpoint to produce a pay stub or check report.
- [Migrate between widget and API](https://docs.symmetry.com/cbs/api/migrate-widget-to-api.md): Move from a widget embed to a custom API integration, or back.
- [Test calculations against known values](https://docs.symmetry.com/cbs/api/test-known-values.md): Validate your integration's output against expected results.
- [API returns 401](https://docs.symmetry.com/cbs/api/401-unauthorized.md): Why the CBS API rejects a request with 401, and how to fix it.
- [CBS API overview](https://docs.symmetry.com/cbs/api-reference/overview.md): Base URLs, authentication, and the tools (live Swagger and a Postman collection) for working with the Calculators by Symmetry API.
- [Postman collection and environment for CBS API](https://docs.symmetry.com/cbs/api-reference/postman-collection.md): Download the CBS Postman collection and environment directly from the API, set your apiKey, and send sample requests to every calculator endpoint.
- [Get list of available calculators](https://docs.symmetry.com/cbs/api-reference/calculators/get-list-of-available-calculators.md): Returns a list of all available paycheck calculators with HATEOAS links
- [Get salary calculator configuration](https://docs.symmetry.com/cbs/api-reference/salary-calculator/get-salary-calculator-configuration.md): Returns the salary calculator model or field definitions for modeling salary-based employee paychecks
- [Calculate salary paycheck](https://docs.symmetry.com/cbs/api-reference/salary-calculator/calculate-salary-paycheck.md): Performs paycheck calculation for salary-based employees
- [Get hourly calculator configuration](https://docs.symmetry.com/cbs/api-reference/hourly-calculator/get-hourly-calculator-configuration.md): Returns the hourly calculator model or field definitions for modeling hourly-based employee paychecks
- [Calculate hourly paycheck](https://docs.symmetry.com/cbs/api-reference/hourly-calculator/calculate-hourly-paycheck.md): Performs paycheck calculation for hourly-based employees
- [Get grossup calculator configuration](https://docs.symmetry.com/cbs/api-reference/grossup-calculator/get-grossup-calculator-configuration.md): Returns the grossup calculator model or field definitions for reverse paycheck calculations
- [Calculate grossup paycheck](https://docs.symmetry.com/cbs/api-reference/grossup-calculator/calculate-grossup-paycheck.md): Performs reverse paycheck calculation to determine gross pay needed for desired net pay
- [Get 401k calculator configuration](https://docs.symmetry.com/cbs/api-reference/401k-calculator/get-401k-calculator-configuration.md): Returns the 401k calculator model or field definitions for modeling retirement contribution paychecks
- [Calculate 401k paycheck](https://docs.symmetry.com/cbs/api-reference/401k-calculator/calculate-401k-paycheck.md): Performs paycheck calculation with 401k retirement contributions
- [Get 401k data calculator configuration](https://docs.symmetry.com/cbs/api-reference/401k-calculator/get-401k-data-calculator-configuration.md): Returns the 401k retirement savings planning data model or field definitions
- [Calculate 401k retirement projections](https://docs.symmetry.com/cbs/api-reference/401k-calculator/calculate-401k-retirement-projections.md): Calculates multi-year 401k retirement savings projections based on contribution rates and return assumptions. Returns array of yearly projection data (30 years).
- [Get 403b calculator configuration](https://docs.symmetry.com/cbs/api-reference/403b-calculator/get-403b-calculator-configuration.md): Returns the 403b calculator model or field definitions for modeling retirement contribution paychecks
- [Calculate 403b paycheck](https://docs.symmetry.com/cbs/api-reference/403b-calculator/calculate-403b-paycheck.md): Performs paycheck calculation with 403b retirement contributions
- [Get 403b data calculator configuration](https://docs.symmetry.com/cbs/api-reference/403b-calculator/get-403b-data-calculator-configuration.md): Returns the 403b retirement savings planning data model or field definitions
- [Calculate 403b retirement projections](https://docs.symmetry.com/cbs/api-reference/403b-calculator/calculate-403b-retirement-projections.md): Calculates multi-year 403b retirement savings projections based on contribution rates and return assumptions. Returns array of yearly projection data (30 years).
- [Get final pay calculator configuration](https://docs.symmetry.com/cbs/api-reference/final-pay-calculator/get-final-pay-calculator-configuration.md): Returns the final pay calculator model or field definitions for calculating final paychecks with tips and severance
- [Calculate final pay paycheck](https://docs.symmetry.com/cbs/api-reference/final-pay-calculator/calculate-final-pay-paycheck.md): Performs final paycheck calculation with tips, severance, and multiple pay codes
- [Get stock option calculator configuration](https://docs.symmetry.com/cbs/api-reference/stock-option-calculator/get-stock-option-calculator-configuration.md): Returns the stock option calculator model or field definitions for calculating stock option exercise income
- [Calculate stock option paycheck](https://docs.symmetry.com/cbs/api-reference/stock-option-calculator/calculate-stock-option-paycheck.md): Performs paycheck calculation for stock option exercise income
- [Get tuition calculator configuration](https://docs.symmetry.com/cbs/api-reference/tuition-calculator/get-tuition-calculator-configuration.md): Returns the tuition calculator model or field definitions for calculating tuition reimbursement income
- [Calculate tuition paycheck](https://docs.symmetry.com/cbs/api-reference/tuition-calculator/calculate-tuition-paycheck.md): Performs paycheck calculation for tuition reimbursement income
- [Get tax tip calculator configuration](https://docs.symmetry.com/cbs/api-reference/tax-tip-calculator/get-tax-tip-calculator-configuration.md): Returns the tax tip calculator model or field definitions for calculating taxes on tips
- [Calculate tax tip paycheck](https://docs.symmetry.com/cbs/api-reference/tax-tip-calculator/calculate-tax-tip-paycheck.md): Performs paycheck calculation for hourly employees with reported tips
- [Get flat bonus calculator configuration](https://docs.symmetry.com/cbs/api-reference/flat-bonus-calculator/get-flat-bonus-calculator-configuration.md): Returns the flat bonus calculator model or field definitions for calculating flat bonus paychecks
- [Calculate flat bonus paycheck](https://docs.symmetry.com/cbs/api-reference/flat-bonus-calculator/calculate-flat-bonus-paycheck.md): Performs paycheck calculation for flat bonus amounts
- [Get aggregate bonus calculator configuration](https://docs.symmetry.com/cbs/api-reference/aggregate-bonus-calculator/get-aggregate-bonus-calculator-configuration.md): Returns the aggregate bonus calculator model or field definitions for calculating aggregate bonus paychecks
- [Calculate aggregate bonus paycheck](https://docs.symmetry.com/cbs/api-reference/aggregate-bonus-calculator/calculate-aggregate-bonus-paycheck.md): Performs paycheck calculation for aggregate bonus amounts
- [Process batch calculator requests](https://docs.symmetry.com/cbs/api-reference/data/process-batch-calculator-requests.md): POST's multiple calculator calculations to the STE for async queue processing. Returns an array of calculation results with tax details and deductions.
- [Process batch calculator requests with PDF report generation](https://docs.symmetry.com/cbs/api-reference/data/process-batch-calculator-requests-with-pdf-report-generation.md): POST's multiple calculator calculations to the STE for async queue processing and generates a PDF report for all calculations. Returns base64-encoded PDF reports. The calculator property must be in all caps.
- [Get deduction object](https://docs.symmetry.com/cbs/api-reference/deductions/get-deduction-object.md): Returns the deduction object for a specified deduction type. Supports custom, HSA, and 401k deduction types. Response format can be controlled via the format parameter (model, fields, or schema).
- [Get print object with calculator example](https://docs.symmetry.com/cbs/api-reference/print/get-print-object-with-calculator-example.md): Returns the print object structure with a salary calculator object added as an example. Used to understand the print data model structure for generating paycheck reports.
- [Generate PDF report for calculator](https://docs.symmetry.com/cbs/api-reference/print/generate-pdf-report-for-calculator.md): POST's a single calculator calculation to the STE and generates a PDF report. Returns base64-encoded PDF documents based on the specified report type. Calculator value in query parameter should match the calculator type in the request body.
- [Get state-specific parameters](https://docs.symmetry.com/cbs/api-reference/state-parameters/get-state-specific-parameters.md): Returns all possible state parameters for the given state and calculator type. Used to help build out CBS-Widgets UI and calculate paychecks with the STE. Different states have different required fields and validations.
- [Get OpenAPI specification in YAML format](https://docs.symmetry.com/cbs/api-reference/documentation/get-openapi-specification-in-yaml-format.md): Returns the complete OpenAPI 3.1 specification for CBS API in YAML format. This file can be imported into tools like Postman or used with OpenAPI code generators. The specification is alphabetically sorted for consistent output.
- [Postman collection](https://docs.symmetry.com/cbs/api-reference/postman/postman-collection.md): Returns the CBS API Postman collection. Import this URL into Postman to get all calculator request examples. Set apiKey in the environment after import. Requires pcc-api-key.
- [Postman environment](https://docs.symmetry.com/cbs/api-reference/postman/postman-environment.md): Returns the CBS API Postman environment with endpointURL set for the current deployment tier (local/test/staging/prod). Set apiKey in Postman after import. Requires pcc-api-key.
- [The Symmetry tax journey](https://docs.symmetry.com/symmetry/compliance/tax-journey.md): How a payroll tax change travels through Symmetry products—from an early bill on the Tax Radar, to confirmed data in Symmetry Guides and the Symmetry Tax Engine, to our release notes.