Skip to main content

Best Practices for Credential Issuance

Follow these best practices to ensure successful credential issuance and optimal recipient experience.

Before Issuance​

Verify Recipient Information​

  • Email Addresses: Double-check email addresses before issuing

  • Spell Check: Verify spelling of recipient names and email addresses

  • Format Validation: Ensure email addresses are properly formatted

  • Test Emails: Send test emails to verify delivery (if possible)

Complete Attributes Accurately​

  • Required Fields: Fill in all required attributes

  • Data Accuracy: Verify all data is accurate and up-to-date

  • Consistent Format: Use consistent formatting across credentials

  • Data Validation: Validate data types and formats before issuing

Template Preparation​

  • Template Review: Review template structure before issuing

  • Attribute Mapping: Ensure all attributes are properly mapped

  • Required vs Optional: Understand which attributes are required

  • Default Values: Set appropriate default values where applicable

During Issuance​

Set Appropriate Expiration Dates​

  • Purpose-Based: Set expiration based on credential purpose

  • Compliance: Consider regulatory or compliance requirements

  • Renewal Planning: Plan for credential renewal if needed

  • Clear Communication: Inform recipients about expiration dates

Choose Appropriate Delivery Methods​

  • Email: Use for most standard use cases

  • Direct Links: Use when you control the communication channel

  • QR Codes: Use for in-person events or physical documents

  • Multiple Methods: Consider offering multiple delivery options

Personalize Messages​

  • Custom Messages: Add personalized messages to recipients

  • Clear Instructions: Provide clear instructions for claiming

  • Support Information: Include support contact information

  • Branding: Maintain consistent branding in communications

After Issuance​

Track Credential States​

  • Regular Monitoring: Check credential states regularly

  • Identify Issues: Look for credentials stuck in early states

  • Follow Up: Contact recipients if credentials aren't claimed

  • Analytics: Monitor claim rates and identify patterns

Follow Up with Recipients​

  • Reminders: Send reminders for unclaimed credentials

  • Support: Offer support for recipients who need help

  • Feedback: Collect feedback to improve the process

  • Documentation: Provide documentation or help resources

Monitor and Resolve Errors​

  • Error Review: Review errors promptly

  • Root Cause: Identify root causes of errors

  • Fix Issues: Fix issues before retrying

  • Prevent Recurrence: Update processes to prevent similar errors

Security Best Practices​

Secure Communication​

  • HTTPS: Always use HTTPS for API calls

  • API Keys: Store API keys securely

  • Authentication: Implement proper authentication

  • Access Control: Limit access to credential issuance

Data Protection​

  • Minimal Data: Only include necessary information

  • Privacy: Consider privacy implications of credential data

  • Encryption: Ensure data is encrypted in transit and at rest

  • Access Logs: Maintain access logs for audit purposes

Credential Security​

  • Unique URIs: Each credential offer has a unique URI

  • Expiration: Set appropriate expiration periods

  • Revocation: Revoke credentials when no longer valid

  • Monitoring: Monitor for suspicious activity

Recipient Experience​

Clear Communication​

  • Simple Language: Use clear, simple language

  • Step-by-Step: Provide step-by-step instructions

  • Visual Aids: Include screenshots or diagrams when helpful

  • Multiple Languages: Consider multi-language support if needed

Easy Claiming Process​

  • Simple Steps: Minimize steps required to claim

  • Mobile Friendly: Ensure process works on mobile devices

  • Wallet Compatibility: Provide wallet recommendations

  • Support: Offer support for technical issues

Timely Delivery​

  • Prompt Issuance: Issue credentials promptly after events

  • Delivery Confirmation: Confirm delivery when possible

  • Resend Capability: Make it easy to resend offers

  • Status Updates: Provide status updates to recipients

Bulk Issuance Best Practices​

CSV File Preparation​

  • Data Validation: Validate all data before uploading

  • Format Consistency: Use consistent formatting

  • Required Fields: Ensure all required fields are present

  • Test Batch: Test with small batch first

Batch Management​

  • Monitor Progress: Monitor bulk issuance progress

  • Error Handling: Handle errors gracefully

  • Retry Logic: Implement retry logic for failures

  • Reporting: Generate reports on batch results

Group Issuance​

  • Group Maintenance: Keep groups updated

  • Appropriate Templates: Use suitable templates for groups

  • Common Attributes: Leverage common attributes efficiently

  • Individual Needs: Handle individual requirements when needed

Performance Optimization​

Efficient Issuance​

  • Batch Operations: Use bulk issuance for multiple credentials

  • Async Processing: Use async processing for large batches

  • Rate Limiting: Respect rate limits and implement backoff

  • Caching: Cache template data when possible

Monitoring and Analytics​

  • Metrics Tracking: Track key metrics

  • Performance Monitoring: Monitor issuance performance

  • Error Tracking: Track and analyze errors

  • Optimization: Use analytics to optimize processes

Regulatory Compliance​

  • GDPR: Ensure GDPR compliance for EU recipients

  • Data Retention: Follow data retention policies

  • Consent: Obtain necessary consent where required

  • Documentation: Maintain compliance documentation

  • Terms of Service: Ensure credentials comply with terms

  • Privacy Policy: Follow privacy policy requirements

  • Data Protection: Protect recipient data appropriately

  • Audit Trail: Maintain audit trail for legal purposes

Troubleshooting​

Common Issues​

  • Email Not Received: Check spam folders, verify addresses

  • Link Not Working: Verify link hasn't expired, check format

  • QR Code Not Scanning: Ensure quality, size, and contrast

  • Wallet Issues: Verify wallet compatibility, provide alternatives

Error Resolution​

  • Identify Root Cause: Determine why error occurred

  • Fix Issue: Address the underlying problem

  • Retry: Retry after fixing the issue

  • Document: Document solution for future reference

Continuous Improvement​

Feedback Collection​

  • Recipient Feedback: Collect feedback from recipients

  • Internal Reviews: Conduct internal process reviews

  • Analytics: Use analytics to identify improvement areas

  • Testing: Regularly test issuance processes

Process Refinement​

  • Update Procedures: Update procedures based on learnings

  • Template Optimization: Optimize templates for efficiency

  • Automation: Automate repetitive tasks

  • Documentation: Keep documentation up-to-date

Next Steps​