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

# The credit score endpoint

export const credit_score_name = "CreditScore";

export const get_common_parameters = (resource_name = 'resource') => {
  return {
    id: {
      name: 'id',
      type: "string",
      required: false,
      description: `Unique identifier for the ${resource_name}.`
    },
    entity_id: {
      name: 'entity_id',
      type: 'string',
      required: false,
      description: 'The ID of the associated Entity.'
    },
    account_id: {
      name: 'account_id',
      type: 'string',
      required: false,
      description: 'The ID of the associated Account.'
    },
    error: {
      name: 'error',
      type: 'object | null',
      required: false,
      description: <>
          An object representing an error that occurred while processing
          this {resource_name}. See <a href={`/reference/errors/${resource_name.replace(/^([A-Z])/, function (match) {
        return match.toLowerCase();
      }).replace(/([A-Z])/g, function (match) {
        return "-" + match.toLowerCase();
      })}-errors`}>{resource_name} errors</a>.
        </>
    },
    status_error: {
      name: 'status_error',
      type: 'object | null',
      required: false,
      description: <>
          An object representing an error that occurred while processing
          this {resource_name}. See <a href="/reference/errors/product-errors#status-errors">{resource_name} errors</a>.
        </>
    },
    metadata: {
      name: 'metadata',
      type: 'object | null',
      required: false,
      description: <>
          Additional data provided during creation.
          See <a href="/reference/metadata">metadata</a>
        </>
    },
    created_at: {
      name: 'created_at',
      type: 'string',
      required: false,
      description: `Timestamp of when the ${resource_name} was created.`
    },
    updated_at: {
      name: 'updated_at',
      type: 'string',
      required: false,
      description: `Timestamp of when the ${resource_name} was last updated.`
    },
    status: (enums = []) => ({
      name: 'status',
      type: 'enum',
      required: false,
      description: `Status of the ${resource_name}.`,
      enums
    }),
    type: (enums = []) => ({
      name: 'type',
      type: 'enum',
      required: false,
      description: `The type of ${resource_name}.`,
      enums
    })
  };
};

export const ParamList = ({items = [], is_child = false}) => {
  return items.map(item => {
    const field_props = {
      id: Math.random().toString(),
      body: item.name,
      name: item.name,
      type: item.type,
      required: item.required
    };
    const enums = item.enums || [];
    const items = item.items || [];
    const has_items = items?.length > 0;
    const has_enums = enums?.length > 0;
    const should_default_open = item.defaultOpen || false;
    const render_child_item = () => {
      const child_props = {
        title: has_enums ? "Possible enum values" : "properties"
      };
      if (should_default_open) child_props.defaultOpen = true;
      const has_inline_enums = has_enums && enums.every(enum_item => typeof enum_item === 'string') && enums.map((enum_item, idx) => {
        const is_last = idx === enums.length - 1;
        const is_2nd_to_last = idx === enums.length - 2;
        return <>
            <code>{enum_item}</code>
            {is_last && ''}
            {is_2nd_to_last && ' or '}
            {!is_last && !is_2nd_to_last && ', '}
          </>;
      });
      const enum_list = has_enums && !has_inline_enums && <Accordion {...child_props}>
          {enums.map((enum_item, index) => <div key={`enum-${index}`}>
              <code>{enum_item.name}</code>
              <br />
              <p>{enum_item.description}</p>
            </div>)}
        </Accordion>;
      const item_list = has_items && <Expandable {...child_props}>
          <ParamList items={items || []} is_child />
        </Expandable>;
      return <>
          <p>
            {item.description}
            {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
          </p>

          {enum_list}
          {item_list}
        </>;
    };
    return is_child ? <ResponseField {...field_props}>{render_child_item()}</ResponseField> : <ParamField {...field_props}>{render_child_item()}</ParamField>;
  });
};

The Credit Score endpoint returns the latest credit score and score factors for an Entity.

<Info>Enterprise customers can customize their credit score bureau and model selections. Contact your Method CSM for more information.</Info>

**The Credit Score endpoint is available as a:**

| Type           | Use-Case                                                                                           |
| -------------- | -------------------------------------------------------------------------------------------------- |
| `Product`      | On-Demand view of an Entity's credit score.                                                        |
| `Subscription` | Continuous near real-time updates on an Entity's credit score. [Webhook Payload](#webhook-payload) |

## CreditScore Objects

<ParamList
  items={[
(get_common_parameters(credit_score_name).id),
(get_common_parameters().entity_id),
(get_common_parameters(credit_score_name).status(
[
  {
    name: 'pending',
    description: `The ${credit_score_name} is queued to be retrieved.`
  },
  {
    name: 'in_progress',
    description: `The ${credit_score_name} is being retrieved.`
  },
  {
    name: 'completed',
    description: `The ${credit_score_name} has successfully been retrieved.`
  },
  {
    name: 'failed',
    description: `The ${credit_score_name} failed to be retrieved.`
  }
]
)),
{
name: 'scores',
type:'object[]',
required: false,
description: 'An array of score objects.',
items: [
  {
    name: 'scores.score',
    type: 'number',
    description: 'The credit score.'
  },
  {
    name: 'scores.source',
    type: 'enum',
    description: 'The source of the credit score.',
    enums: [
      {
        name: 'equifax',
        description: 'Equifax is the source used to pull the credit score.'
      },
      {
        name: 'experian',
        description: 'Experian is the source used to pull the credit score.'
      },
      {
        name: 'transunion',
        description: 'TransUnion is the source used to pull the credit score.'
      }
    ]
  },
  {
    name: 'scores.model',
    type: 'enum',
    description: 'The model used to calculate the credit score.',
    enums: [
      {
        name: 'vantage_3',
        description: <><a href="https://www.creditkarma.com/credit-cards/i/vantagescore-30">VantageScore 3.0</a> credit score model.</>,
      },
      {
        name: 'vantage_4',
        description: <><a href="https://www.creditkarma.com/advice/i/new-vantagescore-4-0-explained">VantageScore 4.0</a> credit score model.</>,
      }
    ]
  },
  {
    name: 'scores.factors',
    type: 'object[]',
    description: 'An array of factors that contributed to the credit score.',
    items: [
      {
        name: 'scores.factors.code',
        type: 'string',
        description: 'The code of the factor.'
      },
      {
        name: 'scores.factors.description',
        type: 'string',
        description: 'The description of the factor.'
      }
    ]
  },
  {
    name: 'scores.created_at',
    type: 'string',
    description: 'Timestamp of when the credit score was generated.'
  }
]
},
(get_common_parameters(credit_score_name).error),
(get_common_parameters(credit_score_name).created_at),
(get_common_parameters(credit_score_name).updated_at),
]}
/>

## Webhook Payload

The [Webhook](/2026-03-30/reference/webhooks/overview) payload will contain the following information:

```json theme={null}
{
  "id": "string",
  "type": "credit_score.create" | "credit_score.update",
  "path": "/entities/<entity_id>/credit_scores/<crs_id>",
  "event": "<evt_id>"
}
```

<RequestExample>
  ```json THE CREDIT SCORE OBJECT theme={null}
  {
    "id": "crs_pn4ca33GXFaCE",
    "entity_id": "ent_au22b1fbFJbp8",
    "status": "completed",
    "scores": [
      {
        "score": 734,
        "source": "equifax",
        "model": "vantage_4",
        "factors": [
          {
            "code": "00034",
            "description": "Total of all balances on bankcard or revolving accounts is too high"
          },
          {
            "code": "00012",
            "description": "The date that you opened your oldest account is too recent"
          },
          {
            "code": "00063",
            "description": "Lack of sufficient relevant real estate account information"
          },
          {
            "code": "00016",
            "description": "The total of all balances on your open accounts is too high"
          }
        ],
        "created_at": "2024-04-12T00:12:32.768Z"
      }
    ],
    "error": null,
    "created_at": "2024-04-12T00:12:30.228Z",
    "updated_at": "2024-04-12T00:12:41.303Z"
  }
  ```
</RequestExample>