Form schemas

A form schema describes the formData of one form type. Use it to validate data before you send it, or to render a form in your own UI. The routes are read-only.

Endpoints

Method and path	What it does
`GET /v3/compliance/form-schemas`	List the published schema for every form type. Paginated.
`GET /v3/compliance/form-schemas/{formType}`	Read the schema for one type.

formType is one of W9, W4, W8Ben, 1099Nec, 1099Misc, 1099K, W2, or T4A.

Both routes are Person-scoped. Don't send X-Wingspan-Account: it returns 400 AccountScopeNotApplicable, as does an Account session or service account credential.

Response

Field	Notes
`type`	The form type.
`version`	Schema version.
`title`, `description`	Human-readable.
`jsonSchema`	A JSON Schema document for programmatic validation of `formData`.
`fields`	A flat list for rendering. Each has `name`, `label`, `type` (`String`, `Number`, `Money`, `Date`, `Boolean`, or `Enum`), `isRequired`, `enumValues`, and `description`.

curl https://api.wingspan.app/v3/compliance/form-schemas/W9 \
  -H "Authorization: Bearer $WINGSPAN_TOKEN"

An unknown formType returns 404.

Where it fits

W9, W4, and W8Ben are collected directly from a worker. The 1099*, W2, and T4A forms are produced and filed by a tax filing. See File and deliver 1099s for submitting forms.