Getting Started

Sign up for a FreshCredit provider account at app.freshcredit.com. Complete the onboarding flow to get your organization ID and initial API credentials.

Navigate to Settings > API Keys in your dashboard. Generate a production API key and store it securely. FreshCredit uses HMAC-SHA256 signed requests for authentication.

// Your API credentials
const API_KEY = 'fc_live_xxxxxxxxxxxxxxxx'
const API_SECRET = 'fc_secret_xxxxxxxxxxxxxxxx'

Test your integration with a simple health check. All API requests must include your API key in the Authorization header and a timestamp-signed signature.

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"

Start with identity verification. BlockID™ provides KYC/AML automation with privacy-preserving verification through zero-knowledge proofs.

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',
  }),
});