API Reference

Fetch the form PDF

get
https://api.wingspan.app/v3/compliance/forms//pdf

Redirects (302) to a signed link to the completed form's PDF; the link expires within five minutes. Available to the payee who completed the form and to the payer; 404 until a PDF is available for the form. Browser pages that cannot follow a cross-site redirect from script should call GET /compliance/forms/{formId}/pdf-url instead. For a tax form, copy selects the Payer or Recipient copy and defaults after authorization; a form whose current submission has not been rendered returns 409. Engine viewer/file failures never fall back to a tax form.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Unique identifier of the form

Query Params
string
enum

Defaults after authorization to Payer for issuer, Recipient for recipient. Recipients cannot select Payer. T4A retains its single stored slip.

Allowed:
Headers
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).

Responses

Updated 4 months ago

Did this page help you?
Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
*/*
application/problem+json

Updated 4 months ago

Did this page help you?