Skip to main content
The Entity Verification Sessions manages phone and identity verification sessions for Entities. Entities need to verify their identity and/or phone in order for them to be used throughout the Method API.

​
Verification Requirements

Entity verification requirements differ on a team-by-team basis. A team’s unique verification process is pre-defined during onboarding based on your team’s specific use case. Contact your Method CSM for more information. The method key in entity.verification object will enumerate the phone & identity verifications available for your Entity. Refer to the Entity Object.
Any Entity Verification Session will expire 10 minutes after creation. If the verification is not completed within that time limit, another verification session will need to be created.

​
Entity Verification Session Objects

​
id
string
Unique identifier for the EntityVerificationSession.
​
entity_id
string
The ID of the associated Entity.
​
status
enum
Status of the EntityVerificationSession.
pending
The EntityVerificationSession has been initiated. Method is gathering information to send over to verify the Entity.in_progress
Method has sent over information to verify the Entity and is waiting for a PUT from the client.verified
Method has successfully verified the Entity's phone or identity. The EntityVerificationSession has successfully been completed.failed
The EntityVerificationSession has failed due to either not being able to verify the Entity or session has expired.
​
type
enum
The type of EntityVerificationSession.
identity
The EntityVerificationSession is an identity verification.phone
The EntityVerificationSession is a phone verification.
​
method
enum
The method being used to verify this Entity's type of EntityVerificationSession. Refer to Verification Methods for more information.
sms
Verifying the Entity's phone via Method's SMS.sna
Verifying the Entity's phone via Method's Silent Network Authentication (SNA).byo_sms
Verified the Entity's phone via non-Method verification.byo_kyc
Verified the Entity's identity via non-Method verification.kba
Verifying the Entity's identity via Method's Knowledge-Based Authentication (KBA).element
Verifying the Entity's identity via Method's Element.method_verified
Method has already verified the PII provided.
​
error
object | null
An object representing an error that occurred while processing this EntityVerificationSession. See EntityVerificationSession errors.
​
created_at
string
Timestamp of when the EntityVerificationSession was created.
​
updated_at
string
Timestamp of when the EntityVerificationSession was last updated.

​
Additional Properties based on method

  • sms
  • sna
  • byo_sms
  • byo_kyc
  • kba
  • element
​
sms
object | null
The sms object being used to store critical information related to the verification.

​
Verification Methods

MethodDescription
smsSMS is used to verify the Entity’s phone number by sending a SMS code and expecting to receive that same SMS code back to verify the phone.
snaSilent Network Auth (SNA) is an authentication method to confirm an Entity’s phone number in the background without requiring the user to wait or leave the app.
byo_smsBring-Your-Own SMS (BYO SMS) means the Entity’s phone number has already been verified via a non-Method provider. Skipping phone verification requirement.
byo_kycBring-Your-Own Know-Your-Consumer (BYO KYC) means the Entity’s identity has already been verified via a non-Method provider. Skipping identity verification requirement.
kbaKnowledge-Based Authentication (KBA) is an authentication method which confirms a person’s identity by asking a series of knowledge questions which only the true owner should know.
elementVerification has been done using a Method Element.
method_verifiedMethod has already verified the PII provided.

​
Webhook Payload

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

{
  "id": "evf_3VT3bHTCnPbrm",
  "entity_id": "ent_XgYkTdiHyaz3e",
  "status": "verified",
  "type": "phone",
  "method": "sms",
  "sms": {
    "timestamp": "2024-02-25T20:02:09.718Z"
  },
  "error": null,
  "created_at": "2024-04-10T16:40:16.271Z",
  "updated_at": "2024-04-10T16:40:16.271Z"
}