Attributes provide structured financial metrics derived from an Entity’s linked accounts. Rather than giving you raw account data, Attributes distill the information into actionable categories that your product can use to generate insights, recommendations, and personalized guidance.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.
Entity vs Account Attributes
Attributes are available at two levels:- Entity Attributes: Aggregated across all of an Entity’s connected accounts. Use
POST /entities/{ent_id}/attributesto compute them. Available as a Product (on-demand) or Subscription (continuous updates via webhooks). - Account Attributes: Per-account metrics for a single Account. Use
POST /accounts/{acc_id}/attributes. Available as a Product only.
How It Works
Attribute requests are asynchronous. When you create an Attributes request, you’ll receive an immediate response withstatus: "in_progress" and attributes: null. Once processing completes, the status updates to completed and the attributes object is populated. Use webhooks or poll the retrieve endpoint to get the final result.
Each attribute in the response is an object with a value field and an error field. If an attribute couldn’t be computed (for example, insufficient historical data for a 60-day trend), value will be null and error will contain details about why.
Available Categories
Entity Attributes span six categories:- Revolving Credit Card: Balances, credit limits, utilization, weighted average APR, usage patterns, minimum payments, delinquency flags, and 30/60/90-day balance and utilization trends.
- Personal Loan: Balances, original loan amounts, estimated monthly installments, utilization, weighted average APR, and 30/60/90-day trends.
- Mortgage: Balances, original loan amounts, weighted average APR, and 30/60/90-day trends.
- Overall: Cross-category totals for original loan amounts, overall utilization, and 30/60/90-day utilization trends.
- Installment: Total installment balance and 30/60/90-day balance changes.
- Other: Balances and trends for account types not covered above.
400 error.
Quick Start
Error Handling
Request-level errors (the Attributes request itself fails):PRODUCT_UNAVAILABLE: The Entity doesn’t support Attributes.TEAM_CAPABILITY_RESTRICTED: Your team doesn’t have access to Attributes.PRODUCT_VERIFICATION_MISSING: Entity must be verified first.PRODUCT_RESTRICTED_CONNECT_REQUIRED: Entity must have a completed Connect record.
ENTITY_ATTRIBUTE_INSUFFICIENT_DATA: Not enough historical data to compute this attribute.ACCOUNT_ATTRIBUTE_INSUFFICIENT_DATA: Same, for Account-level attributes.
Attributes API Reference
Full API documentation for Entity and Account Attributes.