Password Protection

Password protection allows you to secure your QR codes and control who can access the content. When a user scans a password-protected QR code, they'll be prompted to enter the password before accessing the content.

Overview

Password protection is available on all QR code types and provides an additional layer of security for sensitive content. This feature is perfect for:

• Exclusive Content - Protect premium or members-only content
• Event Access - Control access to event-specific information
• Internal Documents - Secure company or team resources
• Beta Testing - Limit access to new features or content

Implementation

Basic Password Protection

Add password protection to any QR code by including the settings object inside the input property:

{
  "typology": "/api/qr-typologies/0598466c-025c-11ef-83ba-06c4e69992ab",
  "input": {
    "url": "https://example.com/premium-content",
    "settings": {
      "password_protected": true,
      "password": "my-secret-password"
    }
  },
  "title": "Protected Website QR"
}

Request Parameters

User Experience

When a user scans a password-protected QR code:

1. Scan Detection - The QR code scanner detects the protected content
2. Password Prompt - A password input field appears
3. Authentication - User enters the password
4. Access Granted - If correct, user is redirected to the content
5. Access Denied - If incorrect, an error message is shown

HTTP Response Codes

Password Protection Responses

Example Error Response

{
  "error": "Password required",
  "message": "This QR code is password protected. Please enter the password to access the content."
}

Examples

Website QR with Password Protection

{
  "typology": "/api/qr-typologies/0598466c-025c-11ef-83ba-06c4e69992ab",
  "input": {
    "url": "https://example.com/exclusive-content",
    "settings": {
      "password_protected": true,
      "password": "exclusive2024"
    }
  },
  "title": "Exclusive Content Access"
}

File QR with Password Protection

{
  "typology": "/api/qr-typologies/0598466c-025c-11ef-83ba-06c4e69992ac",
  "input": {
    "file": "https://example.com/secure-document.pdf",
    "settings": {
      "password_protected": true,
      "password": "document-secret"
    }
  },
  "title": "Secure Document"
}

Business Card QR with Password Protection

{
  "typology": "/api/qr-typologies/0598466c-025c-11ef-83ba-06c4e69992ad",
  "input": {
    "name": "John Doe",
    "email": "john@example.com",
    "phone": "+1234567890",
    "settings": {
      "password_protected": true,
      "password": "contact-secret"
    }
  },
  "title": "Private Contact Info"
}

Best Practices

Password Security

1. Strong Passwords - Use strong, unique passwords (minimum 8 characters)
2. Avoid Common Passwords - Don't use easily guessable passwords
3. Regular Updates - Change passwords periodically for sensitive content
4. Unique Passwords - Use different passwords for different QR codes

User Experience

1. Clear Instructions - Provide clear instructions on how to access the content
2. Password Sharing - Share passwords securely with intended users
3. Fallback Options - Consider providing alternative access methods
4. Error Messages - Use clear, helpful error messages

Implementation Tips

1. Test Thoroughly - Test password protection with various QR code scanners
2. Monitor Access - Track successful and failed authentication attempts
3. Plan for Recovery - Have a plan for password recovery or reset
4. Documentation - Document password requirements for your team

Security Considerations

Password Storage

• Passwords are securely hashed and stored in our system
• We never store passwords in plain text
• Password transmission is encrypted using HTTPS

Access Control

• Passwords are case-sensitive
• Failed attempts are logged for security monitoring
• Consider implementing rate limiting for repeated failed attempts

Compliance

• Password protection helps meet data protection requirements
• Useful for GDPR compliance when sharing sensitive information
• Supports enterprise security policies

Troubleshooting

Common Issues

1. Password Not Working

• Verify the password is correct and case-sensitive
• Check for extra spaces or special characters
• Ensure the QR code was created with password protection enabled

1. Scanner Compatibility

• Some older QR code scanners may not support password protection
• Recommend using modern, updated scanner apps
• Test with multiple scanner applications

1. Network Issues

• Ensure stable internet connection for authentication
• Check if the QR code URL is accessible
• Verify API endpoints are responding correctly

Next Steps

• Learn about Visit Limits
• Explore other QR code types
• Set up Analytics
• Create your first protected QR code