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.
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.
The Entity has completed all Verification and can access most of Method's products. Verification requirements are set on a team-by-team basis and some verification might be auto populated.
incomplete
The Entity has not completed all Verification requirements based on the PII provided and your team's restrictions.
disabled
The Entity has been disabled and no longer has access to Method's products. Entities can transition into the disabled status if an Entity withdraws consent (via the Consent endpoint or via a Payment failure)
The Verification Methods that the Entity can use to verify their identity. Verification and the available methods are unique on a team-by-team basis. One of kba, byo_kyc or element
The Verification Methods that the Entity can use to verify their phone number. Verification and the available methods are unique on a team-by-team basis. One of sms, sna or byo_sms
