> ## 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 entity attributes endpoint

export const entity_attribute_name = "EntityAttribute";

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 Entity Attributes endpoint provides various credit health attributes for an Entity.

**The Entity Attributes endpoint is available as a:**

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

## Attribute Objects

<ParamList
  items={[
(get_common_parameters(entity_attribute_name).id),
(get_common_parameters().entity_id),
(get_common_parameters(entity_attribute_name).status(
[
  {
    name: 'pending',
    description: `The ${entity_attribute_name} is queued to be retrieved.`
  },
  {
    name: 'in_progress',
    description: `The ${entity_attribute_name} is being retrieved.`
  },
  {
    name: 'completed',
    description: `The ${entity_attribute_name} has successfully been retrieved.`
  },
  {
    name: 'failed',
    description: `The ${entity_attribute_name} failed to be retrieved.`
  }
]
)),
{
name: 'attributes',
type:'object',
required: false,
description: 'An object containing various credit health attributes.',
items: [
  {
    name: 'attributes.credit_health_credit_card_usage',
    type: 'object',
    description: 'Credit usage percentage.',
    items: [
      {
        name: 'attributes.credit_health_credit_card_usage.value',
        type: 'number',
        description: 'The value of the credit card usage.'
      },
      {
        name: 'attributes.credit_health_credit_card_usage.rating',
        type: 'enum',
        description: 'The rating of the credit card usage.',
        enums: [
          {
            name: 'excellent',
            description: 'The credit card usage is excellent.'
          },
          {
            name: 'good',
            description: 'The credit card usage is good.'
          },
          {
            name: 'fair',
            description: 'The credit card usage is fair.'
          },
          {
            name: 'needs_work',
            description: 'The credit card usage needs work.'
          }
        ]
      }
    ]
  },
  {
    name: 'attributes.credit_health_derogatory_marks',
    type: 'object',
    description: 'Count of derogatory marks like collection records and public records.',
    items: [
      {
        name: 'attributes.credit_health_derogatory_marks.value',
        type: 'number',
        description: 'The value of the derogatory marks.'
      },
      {
        name: 'attributes.credit_health_derogatory_marks.rating',
        type: 'enum',
        description: 'The rating of the derogatory marks.',
        enums: [
          {
            name: 'excellent',
            description: 'The derogatory marks are excellent.'
          },
          {
            name: 'good',
            description: 'The derogatory marks are good.'
          },
          {
            name: 'fair',
            description: 'The derogatory marks are fair.'
          },
          {
            name: 'needs_work',
            description: 'The derogatory marks need work.'
          }
        ]
      }
    ]
  },
  {
    name: 'attributes.credit_health_hard_inquiries',
    type: 'object',
    description: 'Count of hard inquiries.',
    items: [
      {
        name: 'attributes.credit_health_hard_inquiries.value',
        type: 'number',
        description: 'The count of hard inquiries.'
      },
      {
        name: 'attributes.credit_health_hard_inquiries.rating',
        type: 'enum',
        description: 'The rating of the hard inquiries.',
        enums: [
          {
            name: 'excellent',
            description: 'The hard inquiries are excellent.'
          },
          {
            name: 'good',
            description: 'The hard inquiries are good.'
          },
          {
            name: 'fair',
            description: 'The hard inquiries are fair.'
          },
          {
            name: 'needs_work',
            description: 'The hard inquiries need work.'
          }
        ]
      },
      {
        name: 'attributes.credit_health_hard_inquiries.metadata',
        type: 'object',
        description: 'Metadata about the hard inquiries.',
        items: [
          {
            name: 'attributes.credit_health_hard_inquiries.metadata.history',
            type: 'array',
            description: 'List of hard inquiry records.',
            items: [
              {
                name: 'institution_name',
                type: 'string',
                description: 'Name of the institution that made the inquiry.'
              },
              {
                name: 'inquiry_date',
                type: 'string',
                description: 'Date when the inquiry was made.'
              }
            ]
          }
        ]
      }
    ]
  },
  {
    name: 'attributes.credit_health_soft_inquiries',
    type: 'object',
    description: 'Count of soft inquiries.',
    items: [
      {
        name: 'attributes.credit_health_soft_inquiries.value',
        type: 'number',
        description: 'The count of soft inquiries.'
      },
      {
        name: 'attributes.credit_health_soft_inquiries.rating',
        type: 'enum',
        description: 'The rating of the soft inquiries.',
        enums: [
          {
            name: 'no_rating',
            description: 'No rating is available.'
          }
        ]
      },
      {
        name: 'attributes.credit_health_soft_inquiries.metadata',
        type: 'object',
        description: 'Metadata about the soft inquiries.',
        items: [
          {
            name: 'attributes.credit_health_soft_inquiries.metadata.history',
            type: 'array',
            description: 'List of soft inquiry records.',
            items: [
              {
                name: 'institution_name',
                type: 'string',
                description: 'Name of the institution that made the inquiry.'
              },
              {
                name: 'inquiry_date',
                type: 'string',
                description: 'Date when the inquiry was made.'
              },
              {
                name: 'institution_type',
                type: 'string',
                description: 'Type of the institution that made the inquiry.',
                enums: [
                  {
                    name: 'method',
                    description: 'The inquiry was made by Method.'
                  },
                  {
                    name: 'unknown',
                    description: 'The inquiry was made by an unknown institution.'
                  }
                ]
              }
            ]
          }
        ]
      }
    ]
  },
  {
    name: 'attributes.credit_health_total_accounts',
    type: 'object',
    description: 'Total number of accounts.',
    items: [
      {
        name: 'attributes.credit_health_total_accounts.value',
        type: 'number',
        description: 'The count of total accounts.'
      },
      {
        name: 'attributes.credit_health_total_accounts.rating',
        type: 'enum',
        description: 'The rating of the total accounts.',
        enums: [
          {
            name: 'excellent',
            description: 'The total accounts are excellent.'
          },
          {
            name: 'good',
            description: 'The total accounts are good.'
          },
          {
            name: 'fair',
            description: 'The total accounts are fair.'
          },
          {
            name: 'needs_work',
            description: 'The total accounts need work.'
          }
        ]
      }
    ]
  },
  {
    name: 'attributes.credit_health_credit_age',
    type: 'object',
    description: 'The average age of all open accounts.',
    items: [
      {
        name: 'attributes.credit_health_credit_age.value',
        type: 'number',
        description: 'The average age of credit accounts in months.'
      },
      {
        name: 'attributes.credit_health_credit_age.rating',
        type: 'enum',
        description: 'The rating of the credit age.',
        enums: [
          {
            name: 'excellent',
            description: 'The credit age is excellent.'
          },
          {
            name: 'good',
            description: 'The credit age is good.'
          },
          {
            name: 'fair',
            description: 'The credit age is fair.'
          },
          {
            name: 'needs_work',
            description: 'The credit age needs work.'
          }
        ]
      }
    ]
  },
  {
    name: 'attributes.credit_health_payment_history',
    type: 'object',
    description: 'The percentage of on-time payments.',
    items: [
      {
        name: 'attributes.credit_health_payment_history.value',
        type: 'number',
        description: 'The percentage of on-time payments.'
      },
      {
        name: 'attributes.credit_health_payment_history.rating',
        type: 'enum',
        description: 'The rating of the payment history.',
        enums: [
          {
            name: 'excellent',
            description: 'The payment history is excellent.'
          },
          {
            name: 'good',
            description: 'The payment history is good.'
          },
          {
            name: 'fair',
            description: 'The payment history is fair.'
          },
          {
            name: 'needs_work',
            description: 'The payment history needs work.'
          }
        ]
      }
    ]
  },
  {
    name: 'attributes.credit_health_open_accounts',
    type: 'object',
    description: 'The count of open accounts.',
    items: [
      {
        name: 'attributes.credit_health_open_accounts.value',
        type: 'number',
        description: 'The count of open accounts.'
      },
      {
        name: 'attributes.credit_health_open_accounts.rating',
        type: 'enum',
        description: 'The rating of the open accounts.',
        enums: [
          {
            name: 'no_rating',
            description: 'No rating is available.'
          }
        ]
      }
    ]
  },
  {
    name: 'attributes.credit_health_entity_delinquent',
    type: 'object',
    description: 'Whether the entity is delinquent.',
    items: [
      {
        name: 'attributes.credit_health_entity_delinquent.value',
        type: 'boolean',
        description: 'Whether the entity is delinquent.'
      },
      {
        name: 'attributes.credit_health_entity_delinquent.rating',
        type: 'enum',
        description: 'The rating of the delinquency.',
        enums: [
          {
            name: 'no_rating',
            description: 'No rating is available.'
          }
        ]
      },
      {
        name: 'attributes.credit_health_entity_delinquent.metadata',
        type: 'object',
        description: 'Metadata about the entity delinquency.',
        items: [
          {
            name: 'attributes.credit_health_entity_delinquent.metadata.delinquent_account_ids',
            type: 'string[]',
            description: 'The IDs of the delinquent accounts.'
          }
        ]
      }
    ]
  }
]
},
(get_common_parameters(entity_attribute_name).error),
(get_common_parameters(entity_attribute_name).created_at),
(get_common_parameters(entity_attribute_name).updated_at),
]}
/>

## Webhook Payload

The [Webhook](/2024-04-04/reference/webhooks/overview) payload will contain the following information:

```json theme={null}
{
  "id": "string",
  "type": "attribute.create",
  "path": "/entities/<ent_id>/attributes/<attr_id>"
}
```

<RequestExample>
  ```json THE ATTRIBUTE OBJECT theme={null}
  {
    "id": "attr_nrPjaahMX4yRA",
    "entity_id": "ent_BzirqpLEm3BW7",
    "status": "completed",
    "attributes": {
      "credit_health_credit_card_usage": {
        "value": 22,
        "rating": "good"
      },
      "credit_health_derogatory_marks": {
        "value": 1,
        "rating": "fair"
      },
      "credit_health_hard_inquiries": {
        "value": 1,
        "rating": "fair",
        "metadata": {
          "history": [
            {
              "institution_name": "CBNA",
              "inquiry_date": "2025-02-01"
            }
          ]
        }
      },
      "credit_health_soft_inquiries": {
        "value": 2,
        "rating": "no_rating",
        "metadata": {
          "history": [
            {
              "institution_name": "CITI CARDS CBNA",
              "inquiry_date": "2025-04-03",
              "institution_type": "unknown"
            },
            {
              "institution_name": "FORWARD LENDING, INC.",
              "inquiry_date": "2025-03-03",
              "institution_type": "method"
            }
          ]
        }
      },
      "credit_health_total_accounts": {
        "value": 15,
        "rating": "fair"
      },
      "credit_health_credit_age": {
        "value": 42,
        "rating": "needs_work"
      },
      "credit_health_payment_history": {
        "value": 100,
        "rating": "excellent"
      },
      "credit_health_open_accounts": {
        "value": 10,
        "rating": "no_rating"
      },
      "credit_health_entity_delinquent": {
        "value": true,
        "rating": "no_rating",
        "metadata": {
          "delinquent_account_ids": [
            "acc_4xJ38CQy3mNRr",
            "acc_NMi7FhTJYeBYy"
          ]
        }
      }
    },
    "error": null,
    "created_at": "2026-04-09T17:02:47.910Z",
    "updated_at": "2026-04-09T17:02:47.910Z"
  }
  ```
</RequestExample>