Getting Started
Quickstart guide to integrate with the FreshCredit platform. Set up your environment, make your first API call, and understand core concepts.
Create an Account
Sign up for a FreshCredit developer account to get access to the dashboard and API credentials.
Get Your API Keys
Generate your API key and secret from the developer dashboard. Keep these secure and never expose them in client-side code.
// Your API credentials
const API_KEY = 'fc_live_xxxxxxxxxxxxxxxx'
const API_SECRET = 'fc_secret_xxxxxxxxxxxxxxxx'Make Your First Request
Test your integration by making a request to our health endpoint. This validates your authentication is working correctly.
curl -X GET https://api.freshcredit.com/v1/health \
-H "Authorization: Bearer fc_live_xxxxxxxxxxxxxxxx" \
-H "X-FreshCredit-Signature: {hmac_signature}" \
-H "Content-Type: application/json"Integrate BlockID™
Start verifying identities with our BlockID™ API. Use verifiable credentials to streamline KYC processes.
const response = await fetch('https://api.freshcredit.com/v1/blockid/verify', {
method: 'POST',
headers: {
'Authorization': `Bearer ${API_KEY}`,
'X-FreshCredit-Signature': signature,
'Content-Type': 'application/json',
},
body: JSON.stringify({
user_id: 'user_123',
verification_type: 'kyc_basic',
}),
});Self-Custody Identity
Users own their identity data with edge-held credentials that they control and permission to third parties.
Event-Driven Architecture
Real-time webhooks notify your systems of verification completions, score updates, and offer matches.
Tiered Access Control
OAuth 2.0 scopes provide granular permissions, allowing users to grant specific access levels to their data.
RESTful API Design
Consistent, predictable API endpoints with comprehensive error handling and detailed documentation.