The entity attributes endpoint

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.

Attribute Objects

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.

attributes.credit_health_credit_card_usage

object

Credit usage percentage.

attributes.credit_health_derogatory_marks

object

Count of derogatory marks like collection records and public records.

attributes.credit_health_hard_inquiries

object

Count of hard inquiries.

attributes.credit_health_total_accounts

object

Total number of open accounts.

attributes.credit_health_credit_age

object

The average age of all open accounts.

attributes.credit_health_payment_history

object

The percentage of on-time payments.

attributes.credit_health_open_accounts

object

The count of open accounts.

attributes.credit_health_entity_delinquent

object

Whether the entity is delinquent.

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.

API Reference

Entities

Accounts

Payments

Elements

Events

Supporting Endpoints

The entity attributes endpoint

Attribute Objects

API Reference

Entities

Accounts

Payments

Elements

Events

Supporting Endpoints

​Attribute Objects

Attribute Objects