Get a download link for a submission's PDF

get

https://api.wingspan.app/v3/compliance/forms/{formId}/submissions/{submissionId}/pdf-url

Returns, as JSON, the same signed link that GET /compliance/forms/{formId}/submissions/{submissionId}/pdf puts in its Location header. Use it where a redirect cannot be followed. Do not store the link; it expires at expiresAt.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

formId

string

required

Unique identifier of the form

submissionId

string

required

Query Params

copy

string

enum

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

Allowed:

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

200Signed link to the file

401Unauthenticated

403Forbidden

404Resource not found

409Conflict

422Validation error

503A downstream dependency is temporarily unavailable; retryable. Body carries code: ServiceUnavailable and may include extensions.retryAfter.