Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.methodfi.com/llms.txt

Use this file to discover all available pages before exploring further.

Entities are a representation of your application’s end-users (individuals or corporations). Throughout Method’s ecosystem, an Entity is the legal owner of an Account, and is the primary object for many of Method’s API endpoints.
Entities should be persisted with a 1:1 relationship throughout the lifecycle of your end-user.

​
PII Requirements

Entity PII requirements are pre-defined during onboarding based on your team’s specific use case. Entities require at a minimum name + phone number for most services. Some Products and Subscriptions may require additional information to be provided to Method to enable certain features. Contact your Method CSM for more information.

​
Entity Objects

​
connect
string | null
ID of the Connect record. .
​
credit_score
string | null
ID of the CreditScore record. .
​
attribute
string | null
ID of the Attribute record. .
​
vehicle
string | null
ID of the Vehicle record. .

​
Webhook Payload

The Webhook payload will contain the following information: 
{
  "id": "string",
  "type": "entity.create" | "entity.update",
  "path": "/entities/<ent_id>",
  "event": "<evt_id>"
}

{
  "id": "ent_BzirqpLEm3BW7",
  "type": "individual",
  "individual": {
    "first_name": "Kevin",
    "last_name": "Doyle",
    "phone": "+15121231113",
    "dob": "1997-03-18",
    "email": "kevin.doyle@gmail.com",
    "ssn_4": "xxxx",
    "ssn": "xxxxxxxxx"
  },
  "error": null,
  "address": {
    "line1": "3300 N Interstate 35",
    "line2": null,
    "city": "Austin",
    "state": "TX",
    "zip": "78705"
  },
  "status": "incomplete",
  "verification": {
    "identity": {
      "verified": false,
      "matched": false,
      "latest_verification_session": null,
      "methods": [
        "element",
        "kba"
      ]
    },
    "phone": {
      "verified": true,
      "latest_verification_session": "evf_P4QXNj93Y9J8L",
      "methods": []
    }
  },
  "connect": null,
  "credit_score": null,
  "attribute": null,
  "vehicle": null,
  "products": [
    "identity"
  ],
  "restricted_products": [
    "credit_score",
    "connect",
    "attribute",
    "vehicle"
  ],
  "subscriptions": [],
  "available_subscriptions": [],
  "restricted_subscriptions": [
    "connect",
    "credit_score"
  ],
  "metadata": null,
  "created_at": "2023-10-24T21:50:53.024Z",
  "updated_at": "2023-10-24T21:50:53.024Z"
}