Connect
The connect endpoint
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
id
string
Unique identifier for the Connect.
entity_id
string
The ID of the associated Entity.
status
enum
Status of the Connect.
accounts
string[] | null
An array of new accounts that have been connected to this Entity.
error
object | null
An object representing an error that occurred while processing this Connect. See Connect errors.
created_at
string
Timestamp of when the Connect was created.
updated_at
string
Timestamp of when the Connect was last updated.
Webhook Payload
The Webhook payload will contain the following information: