Retrieve completed form PDF and tax parameters

post

https://api.symmetry.com/spf/fillPdf

Return a completed form PDF and relevant tax parameters based on submitted employee data.

Body Params

formId

string

required

Form IDs - Use the /getAllFormIds endpoint to get all withholding form IDs available

formVersion

string

employee

object

required

employer

object

fields

object

required

signForm

string

enum

Defaults to PREVIEW

Allowed:

signatureFormat

string

Defaults to %name% %dateTime%

Use the following variables to set a format: %name% (full name), %firstName, %middleInitial%, %lastName%, %date%, and %dateTime%

federalValues

object

Object representation of the Federal W4 (W4101) tax parameters. This object will also accept the tax parameters directly, ex: filingStatus or FED.filingStatus

hasFederalLockInLetter

boolean

Indicates that the employee has a Federal lock in letter. SPF US only.

Headers

Timezone

string

A Timezone ID. If not specified, defaults to ETC/UTC. Documented here: https://client-docs.symmetry.com/docs/spf-api-timezones

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

404

Language

Credentials

Bearer

JWT

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

*/*

200OK

400

403Forbidden

500Internal Server Error