Return applicable guided flows for given home and work addresses

post

https://api.symmetry.com/spf/guided-flows

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.

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*

streetAddress1

string

required

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

streetAddress2

string

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

city

string

required

City of the address. Cannot be null or empty.

state

string

States and territories

zipCode

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.

stateEIN

string

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

provinceTerritory

string

States and territories

postalCode

string

Postal code. For Canadian SPF only.

nexus

array of strings

nexus

lockInLetters

array of strings

lockInLetters

interstateEmployee

boolean

useAddressSuggestion

boolean

Headers

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