PDF codes

Create a PDF code

Hosts a PDF and returns a dynamic QR code pointing at it. Provide pdf_url or pdf_base64 (max 20 MB). Counts toward the dynamic-code limit.

post/pdf/create/

Request

  • Base URL: https://hovercode.com/api/v2
  • URL: https://hovercode.com/api/v2/pdf/create/
  • Auth: API key in header Authorization

Request body

OR

Example request

{
  "filename": "menu.pdf"
}

Response

OK

idstring uuid required
qr_datastring nullable

Link URL, plain text, or (GS1) the Digital Link short URL. Omitted for vCard codes.

qr_type'Link' | 'PDF' | 'Text' | 'vCard' | 'App stores' | 'Call' | 'Send email' | 'Send message' | 'Page' | 'Wifi' | 'Form' | 'GS1' required
display_namestring nullable
shortlink_urlstring uri nullable

Short link the code encodes; null for static codes.

dynamicboolean required
framestring nullable

Frame slug.

frame_colorstring nullable
logostring nullable

Logo image URL.

primary_colorstring nullable
eye_style'Square' | 'Rounded' | 'Drop' | 'Leaf'
eye_colorstring nullable
background_colorstring nullable

Hex color; null when transparent.

pattern'Original' | 'Circles' | 'Squares' | 'Diamonds' | 'Triangles' | 'Lines'
textstring nullable
text_secondarystring nullable
has_borderboolean
svgstring nullable

Inline SVG markup.

svg_filestring uri nullable
pngstring uri nullable
createdstring date-time required
gps_trackingboolean
error_correction'L' | 'M' | 'Q' | 'H' | 'null' nullable
pdf_file_urlstring uri

The raw hosted PDF file.

Example response

{
  "frame_color": "#111111",
  "primary_color": "#111111",
  "eye_color": "#111111"
}

Changes

No recorded changes to this operation across all 1 revision of this API.