The Connect endpoint identifies & connects all the liability accounts (e.g. Credit Card, Mortgage, Auto Loans, Student Loans, etc.)
for an Entity across Method’s network of 15,000+ FI / Lenders.
To further provide a comprehensive view the Connect endpoint
will perform a soft-pull of the Entity’s credit report.
The Connect endpoint is available as a:
| Type | Use-Case |
|---|
Product | On-Demand comprehensive view of an Entity’s outstanding liabilities. |
Subscription | Comprehensive view of an Entity’s outstanding liabilities and continuous near real-time updates on new liabilities. Webhook Payload |
Connect Objects
Webhook Payload
The Webhook payload will contain the following information:
{
"id": "string",
"type": "connect.create" | "connect.update" | "connect.available",
"path": "/entities/<ent_id>/connect/<cxn_id>"
}
{
"id": "cxn_4ewMmBbjYDMR4",
"entity_id": "ent_qKNBB68bfHGNA",
"status": "completed",
"accounts": [
"acc_eKKmrXDpJBKgw",
"acc_GV8WbmJW7KGRy",
"acc_MLPKh9gQDDbT8",
"acc_LbXE8wVYJLrKt",
"acc_J3P9fayDFjpAy",
"acc_eFFRV9zmpLREK"
],
"requested_products": [
"card_brand"
],
"requested_subscriptions": [
"card_brand"
],
"error": null,
"created_at": "2024-04-12T14:56:46.645Z",
"updated_at": "2024-04-12T14:56:46.645Z"
}