> ## Documentation Index
> Fetch the complete documentation index at: https://docs.xerobi.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Certification API FAQ

> Frequently asked questions about the Xerobi Certification & Badge API

## Getting Started with Credentials

### Basic Credential Operations

> [accordion] How do I issue a digital credential?
>
> Issue credentials using the `/credentials` endpoint with a template and recipient information:
>
> ```bash theme={null}
> curl -X POST "https://api.hixbe.com/certify/credentials" \
>   -H "Authorization: Bearer YOUR_API_KEY" \
>   -H "Xerobi-Version: 2026-01-01" \
>   -H "Content-Type: application/json" \
>   -d '{
>     "template_id": "tmpl_123",
>     "recipient": {
>       "name": "John Doe",
>       "email": "john@example.com"
>     },
>     "expires_at": "2026-12-31T23:59:59Z"
>   }'
> ```

> [accordion] What types of credentials can I issue?
>
> You can issue certificates, badges, diplomas, licenses, and other verifiable credentials using customizable templates.

> [accordion] How do recipients access their credentials?
>
> Recipients receive a secure link via email or direct API response. They can view, download, and share their verifiable credentials.

### Templates and Design

> [accordion] How do I create credential templates?
>
> Design templates through the API or dashboard with custom layouts, branding, and variable fields:
>
> ```bash theme={null}
> curl -X POST "https://api.hixbe.com/certify/templates" \
>   -H "Authorization: Bearer YOUR_API_KEY" \
>   -H "Xerobi-Version: 2026-01-01" \
>   -H "Content-Type: application/json" \
>   -d '{
>     "name": "Completion Certificate",
>     "type": "certificate",
>     "design": {
>       "background_color": "#ffffff",
>       "text_fields": [
>         {"label": "Recipient Name", "variable": "recipient_name"},
>         {"label": "Course", "variable": "course_name"},
>         {"label": "Completion Date", "variable": "completion_date"}
>       ]
>     }
>   }'
> ```

> [accordion] Can I customize credential appearance?
>
> Yes, templates support custom colors, fonts, logos, and layouts. You can include images, signatures, and security features.

> [accordion] How do I update existing templates?
>
> Templates can be updated, but this affects future credentials only. Existing issued credentials remain unchanged.

## Verification and Validation

### Credential Verification

> [accordion] How do I verify a credential?
>
> Use the verification endpoint with the credential ID:
>
> ```bash theme={null}
> curl -X POST "https://api.hixbe.com/certify/credentials/verify" \
>   -H "Authorization: Bearer YOUR_API_KEY" \
>   -H "Xerobi-Version: 2026-01-01" \
>   -H "Content-Type: application/json" \
>   -d '{
>     "credential_id": "cred_1234567890"
>   }'
> ```

> [accordion] What does verification check?
>
> Verification confirms: credential authenticity, issuer validity, expiration status, revocation status, and tamper-proofing.

> [accordion] Can anyone verify credentials?
>
> Yes, credentials include public verification URLs that anyone can use without API access.

### Public Verification

> [accordion] How do public verification links work?
>
> Each credential has a unique verification URL like `https://verify.hixbe.com/cred_1234567890` that shows credential details and validity status.

> [accordion] Can I customize verification pages?
>
> Yes, you can white-label verification pages with your branding and custom domains.

> [accordion] Are verification links permanent?
>
> Yes, verification links remain active even after credential expiration, clearly showing expired status.

## Badges and Micro-Credentials

### Badge Management

> [accordion] What's the difference between badges and certificates?
>
> Badges are typically smaller achievements or skills, while certificates represent larger accomplishments like course completion or degrees.

> [accordion] How do I create badges?
>
> Create badges similar to certificates but with badge-specific metadata:
>
> ```bash theme={null}
> curl -X POST "https://api.hixbe.com/certify/badges" \
>   -H "Authorization: Bearer YOUR_API_KEY" \
>   -H "Xerobi-Version: 2026-01-01" \
>   -H "Content-Type: application/json" \
>   -d '{
>     "name": "JavaScript Expert",
>     "description": "Demonstrated advanced JavaScript skills",
>     "image_url": "https://example.com/badge-image.png",
>     "criteria": "Complete advanced JS course with 90%+ score"
>   }'
> ```

> [accordion] Can badges be stacked or sequenced?
>
> Yes, you can create badge pathways where earning one badge unlocks requirements for others.

## Programs and Pathways

### Learning Programs

> [accordion] What are certification programs?
>
> Programs are structured learning pathways with multiple credentials, prerequisites, and progression tracking.

> [accordion] How do I set up a program?
>
> Create programs with credential requirements and progression rules:
>
> ```bash theme={null}
> curl -X POST "https://api.hixbe.com/certify/programs" \
>   -H "Authorization: Bearer YOUR_API_KEY" \
>   -H "Xerobi-Version: 2026-01-01" \
>   -H "Content-Type: application/json" \
>   -d '{
>     "name": "Web Development Certification",
>     "description": "Complete web development pathway",
>     "credentials": [
>       {"template_id": "tmpl_html", "required": true},
>       {"template_id": "tmpl_css", "required": true},
>       {"template_id": "tmpl_js", "required": true}
>     ]
>   }'
> ```

> [accordion] How does program completion work?
>
> As learners earn individual credentials, the system tracks progress and automatically issues program completion certificates.

## Security and Compliance

### Credential Security

> [accordion] How are credentials secured?
>
> Credentials use cryptographic signatures, tamper-proofing, and blockchain-based verification to ensure authenticity.

> [accordion] Can credentials be forged?
>
> No, each credential contains cryptographic proofs that prevent forgery and detect tampering.

> [accordion] What about GDPR and privacy?
>
> We comply with GDPR and other privacy regulations. Personal data is encrypted and you control data retention policies.

### Revocation Management

> [accordion] How do I revoke a credential?
>
> Use the revoke endpoint to mark credentials as invalid:
>
> ```bash theme={null}
> curl -X POST "https://api.hixbe.com/certify/credentials/revoke" \
>   -H "Authorization: Bearer YOUR_API_KEY" \
>   -H "Xerobi-Version: 2026-01-01" \
>   -H "Content-Type: application/json" \
>   -d '{
>     "credential_id": "cred_1234567890",
>     "reason": "Policy violation"
>   }'
> ```

> [accordion] What happens when a credential is revoked?
>
> Revoked credentials show as invalid in verification checks and display revocation notices to viewers.

> [accordion] Can revoked credentials be reinstated?
>
> Yes, you can unrevoke credentials if the revocation was made in error.

## Integration and Webhooks

### Certification Webhooks

> [accordion] What webhook events are available?
>
> * `credential.issued` - New credential issued
> * `credential.verified` - Credential verification performed
> * `credential.revoked` - Credential revoked
> * `badge.earned` - Badge awarded
> * `program.completed` - Program completion

> [accordion] How do I set up certification webhooks?
>
> Register webhook endpoints for certification events:
>
> ```bash theme={null}
> curl -X POST "https://api.hixbe.com/certify/webhooks" \
>   -H "Authorization: Bearer YOUR_API_KEY" \
>   -H "Xerobi-Version: 2026-01-01" \
>   -H "Content-Type: application/json" \
>   -d '{
>     "url": "https://yourapp.com/webhooks/certify",
>     "events": ["credential.issued", "credential.revoked"]
>   }'
> ```

> [accordion] How do I handle webhook security?
>
> Verify webhook signatures and implement idempotency using event IDs to handle duplicate notifications.

## Audit and Compliance

### Audit Logging

> [accordion] What audit events are logged?
>
> All credential operations are logged: issuance, verification, revocation, viewing, and sharing activities.

> [accordion] How do I access audit logs?
>
> Use the audit logs endpoint to retrieve activity history:
>
> ```bash theme={null}
> curl -X GET "https://api.hixbe.com/certify/audit-logs?credential_id=cred_123" \
>   -H "Authorization: Bearer YOUR_API_KEY" \
>   -H "Xerobi-Version: 2026-01-01"
> ```

> [accordion] How long are audit logs retained?
>
> Audit logs are retained for 7 years to comply with regulatory requirements.

## Testing and Development

### Sandbox Testing

> [accordion] How do I test certification features?
>
> Use the sandbox environment to create test credentials without affecting production data.

> [accordion] Are sandbox credentials verifiable?
>
> Sandbox credentials have their own verification URLs and don't appear in production verification systems.

> [accordion] Can I migrate test data to production?
>
> No, sandbox and production are separate. You'll need to recreate templates and credentials in production.

## Performance and Scaling

### Rate Limits and Scaling

> [accordion] What are the rate limits?
>
> Certification API allows 200 requests per minute per API key, with higher limits for enterprise accounts.

> [accordion] How do I handle bulk credential issuance?
>
> Use batch endpoints for issuing multiple credentials efficiently, or implement queuing for large volumes.

> [accordion] Can I integrate with LMS platforms?
>
> Yes, we provide integrations with popular LMS platforms like Moodle, Canvas, and custom systems.

## Error Handling

### Common Certification Errors

> [accordion] CREDENTIAL\_ALREADY\_EXISTS
>
> This credential ID is already in use. Use unique identifiers for each credential.

> [accordion] INVALID\_CREDENTIAL\_DATA
>
> Credential data doesn't match the template schema. Validate data before submission.

> [accordion] VERIFICATION\_FAILED
>
> Credential verification failed. Check if the credential was revoked or tampered with.

## Pricing and Billing

### Certification Costs

> [accordion] How am I billed for credentials?
>
> Billing is typically per credential issued, with volume discounts available. Verification checks may have separate pricing.

> [accordion] Are there storage costs?
>
> Credentials are stored securely with no additional storage fees. Custom verification domains may have additional costs.

> [accordion] What about enterprise pricing?
>
> Enterprise plans offer unlimited credentials, white-labeling, and priority support.

## Use Cases and Examples

### Common Implementation Patterns

> [accordion] E-learning platform integration
>
> Issue certificates upon course completion, track learner progress, and provide verifiable proof of skills.

> [accordion] Professional certification
>
> Create badge pathways for career development, maintain certification records, and enable easy verification.

> [accordion] Event attendance certificates
>
> Automatically issue certificates to event attendees, with QR codes for easy verification.

## Need More Help?

> [card] [Certification API Docs](https://docs.xerobi.com/certify-api/introduction)
>
> Complete API reference

> [card] [Webhooks](https://docs.xerobi.com/faq-guides/webhooks.md)
>
> Set up credential event notifications

> [card] [Error Handling](https://docs.xerobi.com/faq-guides/error-handling.md)
>
> Handle credential errors

> [card] [Best Practices](https://docs.xerobi.com/faq-guides/best-practices.md)
>
> Credential integration best practices

> [card] [Troubleshooting](https://docs.xerobi.com/faq-guides/troubleshooting)
>
> Certification-specific issues

> [card] [Support](mailto:support@xerobi.com)
>
> Contact our support team


## Related topics

- [Xerobi Certification & Badge API Introduction](https://docs.xerobi.com/certify/introduction.md)
- [Payment API FAQ](https://docs.xerobi.com/faq-guides/payment-api-faq.md)
- [SMS API FAQ](https://docs.xerobi.com/faq-guides/sms-api-faq.md)
- [API Versioning](https://docs.xerobi.com/faq-guides/versioning.md)
- [Xerobi Developer Documentation](https://docs.xerobi.com/index.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.