QR Codes | PingRep Docs

QR Code Generation

Generate QR codes that link directly to PingRep profiles. Embed them in print materials, conference badges, email signatures, or your own application. QR codes can be returned as PNG or SVG, with full control over colors and scale.

Generate Your QR Code

Create a QR code for the authenticated user's profile.

GET

/api/v1/qr/me

API Key

Generate a QR code image for your own profile.

Query Parameters

formatstringOptional

Image format. Either png or svg. Defaults to png.

scalenumberOptional

Scale factor from 1 to 20. Higher values produce larger images. Defaults to 5.

include_databooleanOptional

When true, returns JSON with URL instead of raw image. Defaults to false.

darkstringOptional

Hex color for the dark modules. Defaults to #000000.

lightstringOptional

Hex color for the light modules. Defaults to #FFFFFF.

Response

When include_data=false (default), the response is raw binary with the appropriate content type:

Content-Type: image/png for PNG format
Content-Type: image/svg+xml for SVG format

When include_data=true, the response is JSON:

urlstringRequired

Direct URL to the generated QR code image.

includesDatabooleanRequired

Confirms data mode was used.

Get QR Code URL

Retrieve just the URL for your QR code without downloading the image.

GET

/api/v1/qr/me/url

API Key

Get the URL for your profile QR code.

Generate QR for Any Profile

Create a QR code for a specific profile by ID.

GET

/api/v1/qr/{profile_id}

API Key

Generate a QR code for a specific profile.

Embedding in Applications

For web apps, use SVG format for sharp rendering at any size. For print materials, use PNG at scale=15 or higher. Both formats support custom brand colors through the dark and light parameters.

Brand Colors

Match QR codes to your brand by setting custom colors. The dark parameter controls the QR modules (squares), and the light parameter controls the background. Ensure enough contrast between the two colors for reliable scanning.