Documentation / BlockScore™ /

BlockScore™

Credit scoring APIs with alternative data pipelines, provider-defined scoring models, and cross-lingual AI agent configuration.

Provider-Built Models

Providers build and own their credit risk models. FreshCredit® provides infrastructure, APIs, and alternative data pipelines — providers control scoring logic.

Alternative Data

Go beyond traditional bureau data. Incorporate behavioral signals, real-time financial patterns, transaction history, and verified credentials for 25% predictive lift.

Cross-Lingual AI

Financial AI agents supporting 2,400+ languages for global credit decisioning. Process data across languages without translation loss.

Algorithmic Transparency

Open methodologies and auditable model outputs. Research standards from The FreshCredit® Org ensure transparent, fair, compliant scoring.

API Reference /

POST/v1/blockscore/score

Generate a credit score using a specific model

Request

{
  "user_id": "user_123",
  "model_id": "model_custom_456",
  "data_sources": ["blockid", "transactions", "alternative"],
  "callback_url": "https://your-app.com/webhooks/blockscore"
}

Response

{
  "score_id": "scr_xyz789",
  "score": 742,
  "rating": "good",
  "model_id": "model_custom_456",
  "factors": [
    { "name": "payment_history", "impact": "high", "direction": "positive" },
    { "name": "credit_utilization", "impact": "medium", "direction": "positive" }
  ],
  "generated_at": "2024-01-15T10:30:00Z"
}

POST/v1/blockscore/models

Create a custom credit scoring model

Request

{
  "name": "My Custom Model",
  "description": "Model for thin-file consumers",
  "base_model": "freshcredit_v3",
  "features": [
    { "source": "blockid", "weight": 0.3 },
    { "source": "transactions", "weight": 0.4 },
    { "source": "alternative", "weight": 0.3 }
  ],
  "custom_rules": [
    { "condition": "payment_history > 0.9", "adjustment": +20 }
  ]
}

Response

{
  "model_id": "model_custom_456",
  "status": "training",
  "estimated_completion": "2024-01-15T12:00:00Z"
}

GET/v1/blockscore/models/{model_id}

Retrieve model details and performance metrics

Response

{
  "model_id": "model_custom_456",
  "name": "My Custom Model",
  "status": "active",
  "performance": {
    "auc_roc": 0.87,
    "precision": 0.82,
    "recall": 0.79,
    "predictive_lift": "25%"
  },
  "created_at": "2024-01-15T10:00:00Z"
}

Data Sources /

blockidIdentity

Identity verification status and credentials

transactionsFinancial

User-authorized transaction history

alternativeAlternative

Behavioral signals and alternative data

employmentEmployment

Verified employment and income data

rentalHousing

Rental payment history

utilitiesUtilities

Utility and telecom payment history

Webhook Events /

blockscore.score.completedSent when a score generation is completed

blockscore.model.trainedSent when a custom model finishes training

blockscore.model.updatedSent when a model is updated or retrained

Next Steps

Explore BlockIQ™Download SDKs