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.
Mobile phone number of the individual in E.164 format. The number will only be used for KYC / AML verification.
individual.dob
string | null
The individual's date of birth in ISO 8601 format.
individual.email
string | null
Email address of the individual. The email will only be used for KYC / AML verification.
individual.ssn_4
string | null
The last 4 digits of the individual's SSN. This field is hidden after the SSN 4 is provided, and can be accessed via Entity Identity.
individual.ssn
string | null
The individual's SSN. This field is hidden after the SSN is provided, and can be accessed via Entity Identity.
error
object | null
An object representing an error that occurred while processing this Entity. See Entity errors.
address
object | null
The Entity's address.
address.line1
string
The first line of the Entity's address.
address.line2
string
The second line of the Entity's address.
address.city
string
The city of the Entity's address.
address.state
string
The two-letter abbreviation for the state of the Entity's address.
address.zip
string
The ZIP code of the Entity's address.
status
enum
Status of the Entity.
active
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)
verification
object
Verification status of the Entity. Verification requirements are set on a team-by-team basis.
verification.identity
object
Identity verification status for the Entity.
verification.identity.verified
boolean
The Entity's identity, who they claim to be, has been verified.
verification.identity.matched
boolean
The Entity's identity has been matched through a Method trusted provider.
verification.identity.latest_verification_session
string | null
The ID of the latest verification session for the Entity's identity. .
verification.identity.methods
string[]
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
verification.phone
object
Phone verification status for the Entity.
verification.phone.verified
boolean
The Entity's phone number has been verified.
verification.phone.latest_verification_session
string | null
The ID of the latest verification session for the Entity's phone number. .
verification.phone.methods
string[]
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
connect
string | null
ID of the Connect record. .
credit_score
string | null
ID of the CreditScore 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
