API Docs
Login for full accessGet a demo

Return applicable forms for given home and work addresses

post
https://api.symmetry.com/spf/v2/forms

Retrieve all applicable forms and address normalization and geocoding data for specified home and work address.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
homeAddress
object
required

The address sub-element of the employer element contains all data pertaining to an employer's physical address.

workAddresses
array of objects
required
length between 1 and 10
workAddresses*

The address sub-element of the employer element contains all data pertaining to an employer's physical address.

string
required

Civic number and street name of the address. Cannot be null or empty.

string

Apartment, floor, unit number, or other address designation that is part of the address.

string
required

City of the address. Cannot be null or empty.

string

States and territories

string

Address zip code. Must be exactly 5 or exactly 9 digits. All non-numeric characters will be automatically removed before validation (for example, 85260-2662 will be validated as 852602662). For SPF US only.

string

State employer identification number. Required by some US forms. Should only be specified on employer addresses.

string

States and territories

string

Postal code. For Canadian SPF only.

nexus
array of strings
nexus
lockInLetters
array of strings
lockInLetters
boolean
boolean
boolean
Headers
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

Updated 2 months ago

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*

Updated 2 months ago

Jump to top