Factuarea APIDevelopers

Download transport document QR code

Download the QR code that encodes the permanent public URL of the document, generated on the server as ?format=svg (default) or ?format=png.

  • The URL is the same in every version.
  • Pass ?download=1 for Content-Disposition: attachment.
  • A draft has no URL and returns 422.
GET
/transport_documents/{transport_document}/qr

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

transport_document*string

Query Parameters

format?string

Image format of the QR code: svg (default) or png.

Value in"svg" | "png"
download?string

Pass 1 (or true) to receive the image with Content-Disposition: attachment; otherwise it is served inline.

Value in"0" | "1" | "true" | "false"

Headers

Factuarea-Version?string

Pin the API version (YYYY-MM-DD, Stripe-style date versioning) for this request; omit to use the key's pinned version, or the latest if none. Unsupported version → 400 unsupported_api_version; malformed → 400 parameter_invalid_format. The effective version is echoed in the Factuarea-Version response header. See the Versioning guide.

Formatdate
X-Active-Profile?string

Operate on behalf of a child company (gestoría master key): pass its public id (UUID v7) and the request runs against that child's data without changing the key's scope, tier or environment (omit to use the key's own company). Invalid UUID → 400 parameter_invalid_uuid; unknown or non-owned id → 404 profile_not_found. See the Acting on behalf guide.

Formatuuid

Response Body

application/json

application/json

application/json

application/json

application/json

application/json