Hide-My-Email.info API Documentation
All documents

QR Codes and vCard Sharing

The QR code endpoints are split into two groups:

  • Account-scoped endpoints for creating and reading QR alias share configurations. These require secret: sk1_... and x-account-access-id: aid1.....
  • Public share endpoints for recipients scanning a QR code. These do not require authentication headers and must not be called with secret or x-account-access-id present.

A QR alias share links a business card alias to a shareable category/secret pair. Recipients scan the QR code, which encodes a URL containing category and secret, and can then download a vCard contact file.

Account-Scoped Endpoints

Create or update a QR alias share

POST /api/v1/qr/new-alias

Creates or updates the QR alias share configuration for the authenticated account.

Request body fields

  • aliasId - required alias to expose via the QR share
  • cardId - optional business card to associate

Response fields

  • shareId
  • category
  • secret
  • aliasId
  • aliasAddress
  • cardId

Response codes

  • 200 OK
  • 400 Bad Request
  • 401 Unauthorized

Example

curl -X POST "http://Hide-My-Email.info/api/v1/qr/new-alias" \
  -H "secret: sk1_example" \
  -H "x-account-access-id: aid1_example" \
  -H "Content-Type: application/json" \
  -d "{\"aliasId\":\"alias_123\",\"cardId\":\"card_123\"}"

Read a QR alias share by ID

`GET /api/v1/qr/new-alias/

Returns the QR alias share configuration for the given share identifier.

Path parameters

  • shareId

Response fields

  • shareId
  • category
  • secret
  • aliasId
  • aliasAddress
  • cardId

Response codes

  • 200 OK
  • 401 Unauthorized
  • 404 Not Found

Example

curl "http://Hide-My-Email.info/api/v1/qr/new-alias/share_123" \
  -H "secret: sk1_example" \
  -H "x-account-access-id: aid1_example"

Public Share Endpoints

These endpoints are used by QR code recipients. They must not be called with secret or x-account-access-id headers.

The category and secret path parameters are embedded in the QR code URL and identify the share without exposing account credentials.

Get share status

`GET /api/v1/qr/

Returns the current status of a QR alias share link.

Path parameters

  • category - share category from the QR code URL
  • secret - share secret from the QR code URL

Response fields

  • isActive
  • aliasAddress

Response codes

  • 200 OK

Example

curl "http://Hide-My-Email.info/api/v1/qr/new-alias/abc123/status"

Get vCard download info

`GET /api/v1/qr/

Returns metadata about the vCard available for download from this share link.

Path parameters

  • category
  • secret

Response fields

  • fileName
  • aliasAddress
  • requiresName

Response codes

  • 200 OK

Example

curl "http://Hide-My-Email.info/api/v1/qr/new-alias/abc123/download-info"

Get QR code image

`GET /api/v1/qr/

Returns the QR code as a PNG image.

Path parameters

  • category
  • secret

Response: PNG image stream (image/png).

Response codes

  • 200 OK

Example

curl "http://Hide-My-Email.info/api/v1/qr/new-alias/abc123/image" -o qr.png

Download vCard (GET)

`GET /api/v1/qr/

Downloads the vCard contact file for this share link.

Path parameters

  • category
  • secret

Response: vCard file stream (text/vcard).

Response codes

  • 200 OK
  • 404 Not Found

Example

curl -L "http://Hide-My-Email.info/api/v1/qr/new-alias/abc123/download" -o contact.vcf

Download vCard (POST)

`POST /api/v1/qr/

Downloads the vCard contact file, optionally including a recipient-provided name in the contact data.

Path parameters

  • category
  • secret

Request body fields

  • name - optional string to include in the vCard

Response: vCard file stream (text/vcard).

Response codes

  • 200 OK
  • 400 Bad Request
  • 404 Not Found

Example

curl -X POST "http://Hide-My-Email.info/api/v1/qr/new-alias/abc123/download" \
  -H "Content-Type: application/json" \
  -d "{\"name\":\"Bob\"}" \
  -o contact.vcf
© 2026 PrivacyGuard.company. All rights reserved.