APIReferenceCodes
Download the code's artwork
The finished design as an image: frame, stickers, logo and all, exactly what the dashboard downloads. PNG and JPG at the requested pixel size, SVG as vectors with the frame embedded as a raster. Mesh shader frames render as a gradient.
Authorization
apiKey AuthorizationBearer <token>
An API key from Settings, Developers: Authorization: Bearer kc_live_...
In: header
Path Parameters
id*string
Length
1 <= lengthQuery Parameters
format?string
Default
"png"Value in
- "png"
- "svg"
- "jpg"
size?integer
Edge length in pixels for png and jpg; the drawing resolution for svg.
Range
256 <= value <= 4096Default
1024background?string
Hex colour behind the code for jpg (no alpha channel). Default white.
Match
^[0-9a-fA-F]{6}$Response Body
application/json
curl -X GET "https://example.com/codes/string/image""string"