Overview
The Credential API provides read-only access to verify user eligibility and query credential information.Core Queries
Get Credential Information
Check User Eligibility
1- User has the credential0- User does not have the credential
Field Reference
Key Fields
Credential Types
Credential Sources
Sync Status
Integration Patterns
Basic Verification
Quest-Specific Context
When checking eligibility for a specific quest, include thecampaignId parameter:
Best Practices
- Check Sync Status: Always verify
syncStatusisSYNCEDbefore relying on eligibility results - Handle Quest Context: Use
campaignIdparameter for quest-specific verifications - Cache Results: Cache eligibility results for 5-10 minutes to reduce API calls
- Error Handling: Handle invalid credential IDs and network errors gracefully
Common Errors
Next Steps
- User Verification Guide - Implementation patterns
- Quest API Reference - Quest requirements
- Authentication - Access token setup