Skip to main content
The Entity Attributes endpoint provides various credit health attributes for an Entity. The Entity Attributes endpoint is available as a:
TypeUse-Case
ProductOn-Demand view of an Entity’s credit attributes.
SubscriptionComprehensive view of an Entity’s attributes and continuous near real-time updates on attributes. Webhook Payload

​
Attribute Objects

​
id
string
Unique identifier for the EntityAttribute.
​
entity_id
string
The ID of the associated Entity.
​
status
enum
Status of the EntityAttribute.
pending
The EntityAttribute is queued to be retrieved.in_progress
The EntityAttribute is being retrieved.completed
The EntityAttribute has successfully been retrieved.failed
The EntityAttribute failed to be retrieved.
​
attributes
object
An object containing various credit health attributes.
​
error
object | null
An object representing an error that occurred while processing this EntityAttribute. See EntityAttribute errors.
​
created_at
string
Timestamp of when the EntityAttribute was created.
​
updated_at
string
Timestamp of when the EntityAttribute was last updated.

​
Webhook Payload

The Webhook payload will contain the following information: 
{
  "id": "string",
  "type": "attribute.create",
  "path": "/entities/<ent_id>/attributes/<attr_id>"
}

{
  "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": "2024-09-09T00:16:44.838Z",
  "updated_at": "2024-09-09T00:16:44.838Z"
}