The entity attributes endpoint
{
"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": 1,
"rating": "no_rating",
"metadata": {
"history": [
{
"institution_name": "FORWARD LENDING, INC.",
"inquiry_date": "2025-04-03"
}
]
}
},
"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"
}
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 |
Attribute Objects
Unique identifier for the EntityAttribute.
The ID of the associated Entity.
Status of the EntityAttribute.
Possible enum values
Possible enum values
pendingThe EntityAttribute is queued to be retrieved.
in_progressThe EntityAttribute is being retrieved.
completedThe EntityAttribute has successfully been retrieved.
failedThe EntityAttribute failed to be retrieved.
An object containing various credit health attributes.
Show properties
Show properties
Credit usage percentage.
Show properties
Show properties
The value of the credit card usage.
The rating of the credit card usage.
Possible enum values
Possible enum values
excellentThe credit card usage is excellent.
goodThe credit card usage is good.
fairThe credit card usage is fair.
needs_workThe credit card usage needs work.
Count of derogatory marks like collection records and public records.
Show properties
Show properties
The value of the derogatory marks.
The rating of the derogatory marks.
Possible enum values
Possible enum values
excellentThe derogatory marks are excellent.
goodThe derogatory marks are good.
fairThe derogatory marks are fair.
needs_workThe derogatory marks need work.
Count of hard inquiries.
Show properties
Show properties
The count of hard inquiries.
The rating of the hard inquiries.
Possible enum values
Possible enum values
excellentThe hard inquiries are excellent.
goodThe hard inquiries are good.
fairThe hard inquiries are fair.
needs_workThe hard inquiries need work.
Count of soft inquiries.
Show properties
Show properties
The count of soft inquiries.
The rating of the soft inquiries.
Possible enum values
Possible enum values
no_ratingNo rating is available.
Total number of accounts.
Show properties
Show properties
The count of total accounts.
The rating of the total accounts.
Possible enum values
Possible enum values
excellentThe total accounts are excellent.
goodThe total accounts are good.
fairThe total accounts are fair.
needs_workThe total accounts need work.
The average age of all open accounts.
Show properties
Show properties
The average age of credit accounts in months.
The rating of the credit age.
Possible enum values
Possible enum values
excellentThe credit age is excellent.
goodThe credit age is good.
fairThe credit age is fair.
needs_workThe credit age needs work.
The percentage of on-time payments.
Show properties
Show properties
The percentage of on-time payments.
The rating of the payment history.
Possible enum values
Possible enum values
excellentThe payment history is excellent.
goodThe payment history is good.
fairThe payment history is fair.
needs_workThe payment history needs work.
Whether the entity is delinquent.
Show properties
Show properties
Whether the entity is delinquent.
The rating of the delinquency.
Possible enum values
Possible enum values
no_ratingNo rating is available.
An object representing an error that occurred while processing this EntityAttribute. See EntityAttribute errors.
Timestamp of when the EntityAttribute was created.
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": 1,
"rating": "no_rating",
"metadata": {
"history": [
{
"institution_name": "FORWARD LENDING, INC.",
"inquiry_date": "2025-04-03"
}
]
}
},
"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"
}
{
"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": 1,
"rating": "no_rating",
"metadata": {
"history": [
{
"institution_name": "FORWARD LENDING, INC.",
"inquiry_date": "2025-04-03"
}
]
}
},
"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"
}
Changelog
- 2025
- 2024
API Versions
The entity attributes endpoint
{
"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": 1,
"rating": "no_rating",
"metadata": {
"history": [
{
"institution_name": "FORWARD LENDING, INC.",
"inquiry_date": "2025-04-03"
}
]
}
},
"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"
}
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 |
Attribute Objects
Unique identifier for the EntityAttribute.
The ID of the associated Entity.
Status of the EntityAttribute.
Possible enum values
Possible enum values
pendingThe EntityAttribute is queued to be retrieved.
in_progressThe EntityAttribute is being retrieved.
completedThe EntityAttribute has successfully been retrieved.
failedThe EntityAttribute failed to be retrieved.
An object containing various credit health attributes.
Show properties
Show properties
Credit usage percentage.
Show properties
Show properties
The value of the credit card usage.
The rating of the credit card usage.
Possible enum values
Possible enum values
excellentThe credit card usage is excellent.
goodThe credit card usage is good.
fairThe credit card usage is fair.
needs_workThe credit card usage needs work.
Count of derogatory marks like collection records and public records.
Show properties
Show properties
The value of the derogatory marks.
The rating of the derogatory marks.
Possible enum values
Possible enum values
excellentThe derogatory marks are excellent.
goodThe derogatory marks are good.
fairThe derogatory marks are fair.
needs_workThe derogatory marks need work.
Count of hard inquiries.
Show properties
Show properties
The count of hard inquiries.
The rating of the hard inquiries.
Possible enum values
Possible enum values
excellentThe hard inquiries are excellent.
goodThe hard inquiries are good.
fairThe hard inquiries are fair.
needs_workThe hard inquiries need work.
Count of soft inquiries.
Show properties
Show properties
The count of soft inquiries.
The rating of the soft inquiries.
Possible enum values
Possible enum values
no_ratingNo rating is available.
Total number of accounts.
Show properties
Show properties
The count of total accounts.
The rating of the total accounts.
Possible enum values
Possible enum values
excellentThe total accounts are excellent.
goodThe total accounts are good.
fairThe total accounts are fair.
needs_workThe total accounts need work.
The average age of all open accounts.
Show properties
Show properties
The average age of credit accounts in months.
The rating of the credit age.
Possible enum values
Possible enum values
excellentThe credit age is excellent.
goodThe credit age is good.
fairThe credit age is fair.
needs_workThe credit age needs work.
The percentage of on-time payments.
Show properties
Show properties
The percentage of on-time payments.
The rating of the payment history.
Possible enum values
Possible enum values
excellentThe payment history is excellent.
goodThe payment history is good.
fairThe payment history is fair.
needs_workThe payment history needs work.
Whether the entity is delinquent.
Show properties
Show properties
Whether the entity is delinquent.
The rating of the delinquency.
Possible enum values
Possible enum values
no_ratingNo rating is available.
An object representing an error that occurred while processing this EntityAttribute. See EntityAttribute errors.
Timestamp of when the EntityAttribute was created.
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": 1,
"rating": "no_rating",
"metadata": {
"history": [
{
"institution_name": "FORWARD LENDING, INC.",
"inquiry_date": "2025-04-03"
}
]
}
},
"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"
}
{
"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": 1,
"rating": "no_rating",
"metadata": {
"history": [
{
"institution_name": "FORWARD LENDING, INC.",
"inquiry_date": "2025-04-03"
}
]
}
},
"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"
}