Developer July 16, 2025

Simplified API endpoint for badge issuance

M

MD MAZAHARUL HUQ

Published on July 16, 2025

 

 New Simple API Implementation

 1. Endpoint URL

 GET/POST https://app.issuebadge.com/api/v1/simple/issue

 2. Authentication

 - API key can be passed as:
   - Query parameter: ?api_key=YOUR_API_KEY
   - Header: X-API-Key: YOUR_API_KEY

 3. Required Parameters

 - api_key - Your API key (Bearer token)
 - name - Recipient's name
 - email - Recipient's email
 - badge_id - Badge UUID (e.g., W238GD8PK)
 - idempotency_key - Unique key to prevent duplicate issues

 4. Optional Parameters

 - phone - Recipient's phone number
 - metadata - Array of custom data

 5. Example Usage

 GET Request:
 curl "https://app.issuebadge.com/api/v1/simple/issue?api_key=YOUR_TOKEN&name=John%20Doe&email=john@example.com&ba
 dge_id=W238GD8PK&idempotency_key=unique123"

 POST Request with Form Data:
 curl -X POST https://app.issuebadge.com/api/v1/simple/issue \
   -d "api_key=YOUR_TOKEN" \
   -d "name=John Doe" \
   -d "email=john@example.com" \
   -d "badge_id=W238GD8PK" \
   -d "idempotency_key=unique123"

 POST Request with Header:
 curl -X POST https://app.issuebadge.com/api/v1/simple/issue \
   -H "X-API-Key: YOUR_TOKEN" \
   -d "name=John Doe" \
   -d "email=john@example.com" \
   -d "badge_id=W238GD8PK" \
   -d "idempotency_key=unique123"

 6. Success Response

 {
   "success": true,
   "message": "Badge issued successfully",
   "issue_id": "encrypted_id_here",
   "public_url": "https://app.issuebadge.com/issue/show/encrypted_id_here",
   "badge_name": "Achievement Badge",
   "recipient_name": "John Doe",
   "recipient_email": "john@example.com"
 }

 7. Additional Endpoint

 You can also check issued badge details:
 GET https://app.issuebadge.com/api/v1/simple/issue/{issue_id}?api_key=YOUR_TOKEN

 Key Features:

 -  Simple authentication via API key
 -  Supports both GET and POST methods
 -  Idempotency support (prevents duplicate issues)
 -  Returns public URL for the issued badge
 -  Validates badge existence before issuing
 -  Maintains tenant isolation

Share this article

Ready to Start Issuing Digital Badges?

Join thousands of organizations using Issue Badge to recognize achievements and build credibility.

Get Started Free