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