Get a jurisdiction's payroll tax setup form

get

https://api.wingspan.app/v3/payments/payer-settings/jurisdictions/{country}/{jurisdiction}/schema

Returns the jurisdiction's W-2 payroll tax setup form (its fields, sections, and validation rules) with the values currently stored for the effective Account. The Account must have a W-2 employer payroll profile (otherwise 404), and the jurisdiction must be configurable or enabled on the Account (otherwise 403).

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

country

string

enum

required

The country of the jurisdiction, as a lowercase two-letter code.

Allowed:

jurisdiction

string

required

^[A-Z]{2}$

The jurisdiction's two-letter code within the country. Must be one of the configurable or enabled jurisdictions on the Account, as listed in employerPayrollSettings.jurisdictions.{country} of GET /payments/payer-settings.

Headers

X-Wingspan-Account

string

^(?:[A-Za-z0-9_.]{22}|[a-f0-9]{24})$

Select the Account for an Account-scoped operation. A direct ServiceAccount API key MUST supply this header, and the target must be within the ServiceAccount owner's or Authorization grant's Account boundary. A Person bearer may select an Account on which it has an active Stakeholder, and an Account session may select its bound Account (or a descendant only when the session explicitly includes descendants).

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Bearer

JWT

Loading…

Response

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

application/json

application/problem+json

200Form schema and current values

400Malformed request syntax

401Unauthenticated

403Forbidden

404Resource not found