For SPF-API nexus is the situation of when a business has a tax presence in a particular state. Therefore, we have a nexus element can be used to specify a list of states in which a company may have a business presence or, Nexus. This list of states will be used to consider which state’s withholding forms are relevant.

Nexus is an important element for SPF-API because without it an employee could be served incorrect payroll forms. If nexus is not specified, the SPF-API will act as if a user has nexus in every state. This could result in an employee completing more payroll forms than they need, but will also make sure they complete all required withholding forms for their tax scenario.

The SPF-API /forms and /guided-flows endpoints support the ability to specify Nexus. Below shows how a user can specify which states they have nexus in.

Sample Request

{
    "homeAddress": {
        "streetAddress1": "11 S Union St",
        "city": "Montgomery",
        "state": "AL",
        "zipCode": "36130"
    },
    "workAddresses": [
        {
            "streetAddress1": "64 N Union St",
            "city": "Montgomery",
            "state": "AL",
            "zipCode": "36130"
        }
    ],
    "nexus": [
        "AL",
        "LA",
        "MS"
    ]
}

Jump to top