API Endpoints

Below is brief description of the SPF-API endpoints. Please click on any title to be directed to additional endpoint information.

SPF-API endpoints uses a JWT token for authentication and authorization. An authentication endpoint is available that will accept your product API Key or Hash and provide a valid JWT token.

The getAllFormsIds endpoint is used to return a list of all form IDs available in the Symmetry Payroll Forms API.

The forms endpoint receives a single home address and one or more work address(es) representing the employee’s physical work locations. It returns a list of applicable forms for the employee’s withholding scenario.

The guided-flows endpoint receives one home address and one or more work address(es) representing the employee’s physical work locations. It returns a list of applicable flows for the employee’s withholding scenario.

Resulting flows are then used to filter the list of all applicable forms down to a list of required forms. Note that some states/scenarios do not required additional information to filter the applicable forms.

The flowQuestionSet endpoint returns a question set for a given flow. Flow question sets are used to filter the list of potentially applicable form down to a list of required forms. Each question set may contain one or more questions, validation regular expressions, and navigation aids.

The formQuestionSet endpoint returns a question set for a given form. Each question set may contain one or more questions, validation regular expressions, and navigation aids.

The fillPdf endpoint receives a json object containing employee and employer information, along with answers to the form question sets. This endpoint then validates and processes the data returning a complete PDF in base 64 format and the relevant tax parameters. Validation is done using the regular expressions provided in the question sets to check validity, in addition to validation of question dependencies.

The getPdf endpoint returns the requested unflattened PDF by form ID as a byte stream with an Accept header value of application/pdf. See the getAllFormIds endpoint for all the available form IDs that are currently supported.

A GET method request to the fillpdf endpoint will return information for a given form. It provides all the fields that can be expected as well as each field’s validation regular expression. This endpoint also returns the tax parameters schema for the requested form.

The docs/config endpoint returns the Open API (Swagger) configuration used to generate the SPF-API Open API documentation page. This configuration can be used to generate a client API, see Swagger CodeGen for more details.


Jump to top