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
vehicle	On-Demand view of an Entity’s vehicles.	Vehicles

Product Objects

Webhook Payload

The Webhook payload will contain the following information:

{
  "id": "string",
  "type": "product.create" | "product.update",
  "path": "/entities/<ent_id>/products/<prd_id>",
}

THE PRODUCT OBJECT

{
  "connect": {
    "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,
    "latest_successful_request_id": null,
    "is_subscribable": true,
    "created_at": "2024-04-12T00:09:07.521Z",
    "updated_at": "2024-04-12T00:09:07.532Z"
  },
  "credit_score": {
    "name": "credit_score",
    "status": "available",
    "status_error": null,
    "latest_request_id": null,
    "latest_successful_request_id": null,
    "is_subscribable": true,
    "created_at": "2024-04-12T00:09:07.522Z",
    "updated_at": "2024-04-12T00:09:09.088Z"
  },
  "identity": {
    "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,
    "latest_successful_request_id": null,
    "is_subscribable": false,
    "created_at": "2024-04-12T00:09:07.523Z",
    "updated_at": "2024-04-12T00:09:07.533Z"
  },
  "attribute": {
    "name": "attribute",
    "status": "restricted",
    "status_error": {
        "type": "INVALID_REQUEST",
        "sub_type": "PRODUCT_RESTRICTED_CONNECT_REQUIRED",
        "message": "Entity must have a completed Connect record to access this product."
    },
    "latest_request_id": null,
    "latest_successful_request_id": null,
    "is_subscribable": false,
    "created_at": "2024-04-12T00:09:07.523Z",
    "updated_at": "2024-04-12T00:09:07.533Z"
  },
  "vehicle": {
    "name": "vehicle",
    "status": "restricted",
    "status_error": {
        "type": "INVALID_REQUEST",
        "sub_type": "PRODUCT_RESTRICTED_CONNECT_REQUIRED",
        "message": "Entity must have a completed Connect record to access this product."
    },
  "latest_request_id": null,
  "latest_successful_request_id": null,
  "is_subscribable": false,
  "created_at": "2024-04-12T00:09:07.523Z",
  "updated_at": "2024-04-12T00:09:07.534Z"
  }
}