The subscriptions endpoint

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:

Name	Use-Case	Resource Doc
connect	Comprehensive view of an Entity’s outstanding liabilities and continuous near real-time updates on new liabilities.	Connect
credit_score	Continuous near real-time updates on an Entity’s credit score.	Credit Scores
attribute	Continuous 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>",
}

THE SUBSCRIPTION OBJECT

{
  "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"
  }
}