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

# Enhanced Credit Score

> Get an enhanced credit score with off-chain asset data

## Overview

Returns an enhanced credit score that combines on-chain activity with additional off-chain asset information for a more comprehensive creditworthiness assessment.

<Info>
  Enhanced scores incorporate verified off-chain asset data to provide a more complete financial picture.
</Info>

## Path Parameters

<ParamField path="address" type="string" required>
  Ethereum address or ENS name (e.g., `vitalik.eth` or `0x742d35Cc6634C0532925a3b844Bc9e7595f0Ab17`)
</ParamField>

## Request Body

<ParamField body="total_asset_usd" type="number">
  Total value of off-chain assets in USD to include in the score calculation
</ParamField>

## Response

<ResponseField name="address" type="string">
  The resolved Ethereum address (checksummed)
</ResponseField>

<ResponseField name="score" type="integer">
  Enhanced credit score between 300 and 1000
</ResponseField>

<ResponseField name="decile" type="integer">
  Score decile from 1 to 10
</ResponseField>

<ResponseField name="range" type="string">
  Score range: `low`, `fair`, `good`, `very_good`, or `excellent`
</ResponseField>

<ResponseField name="model_version" type="string">
  The scoring model version (currently `andromeda_1.0`)
</ResponseField>

<ResponseField name="timestamp" type="string">
  ISO 8601 timestamp when the score was calculated
</ResponseField>

## Boost Calculation

The boost is calculated as a percentage of the gap between the current score and 1000:

* **Maximum boost**: 15% of (1000 - current\_score)
* **Boost factor**: Proportional to additional assets (capped at \$50,000)
* **Example**: Score 700 with \$50k off-chain assets = up to +45 points

<RequestExample>
  ```bash cURL theme={null}
  curl -X POST "https://api.credprotocol.com/api/v2/score/address/vitalik.eth" \
    -H "Authorization: Bearer YOUR_API_KEY" \
    -H "Content-Type: application/json" \
    -d '{"total_asset_usd": 50000}'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch('https://api.credprotocol.com/api/v2/score/address/vitalik.eth', {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer YOUR_API_KEY',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({ total_asset_usd: 50000 })
  });

  const data = await response.json();
  console.log(`Enhanced score: ${data.score}`);
  ```

  ```python Python theme={null}
  import requests

  response = requests.post(
      'https://api.credprotocol.com/api/v2/score/address/vitalik.eth',
      headers={'Authorization': 'Bearer YOUR_API_KEY'},
      json={'total_asset_usd': 50000}
  )

  data = response.json()
  print(f"Enhanced score: {data['score']}")
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  {
    "address": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
    "score": 870,
    "decile": 8,
    "range": "very_good",
    "model_version": "andromeda_1.0",
    "timestamp": "2024-01-15T10:30:00Z"
  }
  ```

  ```json 404 theme={null}
  {
    "detail": "Address not found or has no on-chain activity"
  }
  ```
</ResponseExample>

## When to Use Enhanced Scores

<AccordionGroup>
  <Accordion title="Lending Decisions">
    Use enhanced scores for more accurate risk assessment when making lending decisions. The additional identity verification reduces the risk of sybil attacks.
  </Accordion>

  <Accordion title="Trust Scoring">
    When you need to assess the trustworthiness of a counterparty, enhanced scores provide a more holistic view by incorporating reputation data.
  </Accordion>

  <Accordion title="User Onboarding">
    Offer better terms or reduced requirements to users with high enhanced scores, as they've demonstrated verified identity and reputation.
  </Accordion>
</AccordionGroup>
