{
  "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"
}
Entities are a representation of your application’s end-users (individuals or corporation). 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

​
id
string
Unique identifier for the Entity.
​
type
enum
The type of Entity. Must be individual
​
individual
object | null
Individual information of the Entity.
​
error
object | null
An object representing an error that occurred while processing this Entity. See Entity errors.
​
address
object | null
The Entity's address.
​
status
enum
Status of the Entity.
​
verification
object
Verification status of the Entity. Verification requirements are set on a team-by-team basis.
​
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. .
​
products
string[]
A list of products that the Entity has access to. See Product Names.
​
restricted_products
string[]
A list of products that the Entity can have access to but is missing some requirements. (e.g. Missing Verification requirements) See Product Names.
​
subscriptions
string[]
A list of products that the Entity is subscribed to. See Subscription Names.
​
available_subscriptions
string[]
A list of products that the Entity can enroll into a subscription with. See Subscription Names.
​
restricted_subscriptions
string[]
A list of products that the Entity can subscribe to but is missing some requirements. (e.g. Missing Verification requirements) See Subscription Names.
​
metadata
object | null
Additional data provided during creation. See metadata
​
created_at
string
Timestamp of when the Entity was created.
​
updated_at
string
Timestamp of when the Entity was last updated.

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