Products
The products endpoint
Products
The products endpoint
The Entity Products endpoint outlines the Products (capabilities) an Entity has access to, and provides an overview of the status of all the Products.
Access to most products requires an Entity to be active. However, some products have restricted access requiring team-by-team enablement.
Product Names
Products that an Entity can have access to:
| Name | Use-Case | Resource Doc |
|---|---|---|
connect | On-Demand comprehensive view of an Entity’s outstanding liabilities. | Connect |
credit_score | On-Demand view of an Entity’s credit score. | Credit Scores |
identity | On-Demand retrieval of the full Identity (PII) for any Entity | Identities |
attribute | On-Demand view of an Entity’s credit health attributes. | Attributes |
Product Objects
id
string
Unique identifier for the Product.
name
string
The name of the Product. See Product Names.
status
enum
Status of the Product.
status_error
object | null
An object representing an error that occurred while processing this Product. See Product errors.
latest_request_id
string | null
ID of the most recently created Product resource.
is_subscribable
boolean
A field indicating whether a Product supports Subscription enrollment.
created_at
string
Timestamp of when the Product was created.
updated_at
string
Timestamp of when the Product was last updated.
Webhook Payload
The Webhook payload will contain the following information:
{
"id": "string",
"type": "product.create" | "product.update",
"path": "/entities/<ent_id>/products/<prd_id>",
}