Skip to main content
Access to Symmetry Payroll Forms is licensed by Symmetry. Which credentials you’re issued depends on how you’re delivering SPF. We issue your credentials during onboarding. If you don’t have what you need, reach out through the Client Support Center.

​
The credentials

This page covers which credentials you’re issued and what each one unlocks. For how to authenticate with them (JWT access tokens, OAuth 2.0 postbacks, and proxy basic authentication), see Authentication in SPF.

​
API

API clients are issued an API Key, sometimes called a Hash. You don’t send it on SPF requests directly. You exchange it for a JWT access token, and that token authorizes every subsequent call.

​
Hosted

Hosted clients are issued a Profile Key that identifies your account. It appears in the URLs you use to reach your account’s resources:
Your account’s default settings (form modes, postback configuration, presentation options) are managed by Symmetry through the Admin Panel. Most can be overridden per session in your SPF Registration without a support ticket.

​
On-Premise

On-premise clients need two things. Download Center credentials to retrieve spf.war and the SPF_HOME package, and to pull each subsequent release. Because you control your own deployment schedule, staying current with releases is how you stay current with the forms. See Updating Symmetry Payroll Forms. A webservice API key for the Symmetry Location Service, set as config.webservice.apiKey in your settings.json. Without it, SPF can’t normalize addresses or resolve them to jurisdictions.

​
The Symmetry Location Service

Address normalization, geocoding, and jurisdiction matching are provided by the Symmetry Location Service, which underpins form determination for U.S. addresses. SLS usage may carry its own license fee depending on your agreement. Talk to your Symmetry Account Executive about how it applies to you. Canadian addresses don’t currently go through SLS. See Symmetry Location Service.

Authentication in SPF

JWT, OAuth 2.0, and basic authentication configuration.

Implementation types

Which set of credentials applies to you.