Skip to main content

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 Subscriptions endpoint controls the state of all Subscriptions for an Entity. Subscriptions are Products that can provide continuous updates via Webhooks. (e.g. Credit Score Subscription provides updates on an Entity’s credit score)
Most subscriptions are accessible by default. However, some subscriptions have restricted access requiring team-by-team enablement and elevated account verification.

​
Subscription Names

Subscriptions that an Entity can be enrolled in:
NameUse-CaseResource Doc
connectComprehensive view of an Entity’s outstanding liabilities and continuous near real-time updates on new liabilities.Connect
credit_scoreContinuous near real-time updates on an Entity’s credit score.Credit Scores
attributeContinuous near real-time updates on an Entity’s attributes.Attributes

​
Subscriptions Objects

​
Webhook Payload

The Webhook payload will contain the following information: 
{
  "id": "string",
  "type": "subscription.create" | "subscription.update",
  "path": "/entities/<ent_id>/subscriptions/<sub_id>",
}

{
  "credit_score": {
    "id": "sub_6f7XtMLymQx3f",
    "name": "credit_score",
    "status": "active",
    "payload": null,
    "latest_request_id": "crs_pn4ca33GXFaCE",
    "created_at": "2024-04-12T00:21:58.765Z",
    "updated_at": "2024-04-12T00:21:58.765Z"
  }
}