{
  "connect": {
    "id": "prd_jPRDcQPMk43Ek",
    "name": "connect",
    "status": "unavailable",
    "status_error": {
        "type": "INVALID_REQUEST",
        "sub_type": "ACCOUNT_CONSENT_UNAVAILABLE",
        "message": "Account consent for your organization is unavailable."
    },
    "latest_request_id": null,
    "is_subscribable": true,
    "created_at": "2024-04-12T00:09:07.521Z",
    "updated_at": "2024-04-12T00:09:07.532Z"
  },
  "credit_score": {
    "id": "prd_jKpF9izhfqL9w",
    "name": "credit_score",
    "status": "available",
    "status_error": null,
    "latest_request_id": null,
    "is_subscribable": true,
    "created_at": "2024-04-12T00:09:07.522Z",
    "updated_at": "2024-04-12T00:09:09.088Z"
  },
  "identity": {
    "id": "prd_tnpbLh8jCMw4X",
    "name": "identity",
    "status": "restricted",
    "status_error": {
        "type": "INVALID_REQUEST",
        "sub_type": "TEAM_CAPABILITY_RESTRICTED",
        "message": "Team access is not available. Reach out to the Method team to learn more."
    },
    "latest_request_id": null,
    "is_subscribable": false,
    "created_at": "2024-04-12T00:09:07.523Z",
    "updated_at": "2024-04-12T00:09:07.534Z"
  }
}

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:

NameUse-CaseResource Doc
connectOn-Demand comprehensive view of an Entity’s outstanding liabilities.Connect
credit_scoreOn-Demand view of an Entity’s credit score.Credit Scores
identityOn-Demand retrieval of the full Identity (PII) for any EntityIdentities

​
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>",
}

{
  "connect": {
    "id": "prd_jPRDcQPMk43Ek",
    "name": "connect",
    "status": "unavailable",
    "status_error": {
        "type": "INVALID_REQUEST",
        "sub_type": "ACCOUNT_CONSENT_UNAVAILABLE",
        "message": "Account consent for your organization is unavailable."
    },
    "latest_request_id": null,
    "is_subscribable": true,
    "created_at": "2024-04-12T00:09:07.521Z",
    "updated_at": "2024-04-12T00:09:07.532Z"
  },
  "credit_score": {
    "id": "prd_jKpF9izhfqL9w",
    "name": "credit_score",
    "status": "available",
    "status_error": null,
    "latest_request_id": null,
    "is_subscribable": true,
    "created_at": "2024-04-12T00:09:07.522Z",
    "updated_at": "2024-04-12T00:09:09.088Z"
  },
  "identity": {
    "id": "prd_tnpbLh8jCMw4X",
    "name": "identity",
    "status": "restricted",
    "status_error": {
        "type": "INVALID_REQUEST",
        "sub_type": "TEAM_CAPABILITY_RESTRICTED",
        "message": "Team access is not available. Reach out to the Method team to learn more."
    },
    "latest_request_id": null,
    "is_subscribable": false,
    "created_at": "2024-04-12T00:09:07.523Z",
    "updated_at": "2024-04-12T00:09:07.534Z"
  }
}
Retrieve IdentitiesList all Products