The entity endpoint

{
  "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

string

Unique identifier for the Entity.

type

enum

The type of Entity. Must be individual

individual

object | null

Individual information of the Entity.

Show properties

individual.first_name

string | null

The legal first name of the individual.

individual.last_name

string | null

The legal last name of the individual.

individual.phone

string | null

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.

Show properties

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.

Possible enum values

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.

Show properties

verification.identity

object

Identity verification status for the Entity.

Show properties

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.

Show properties

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. .

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.

string

Unique identifier for the Entity.

type

enum

The type of Entity. Must be individual

individual

object | null

Individual information of the Entity.

Show properties

individual.first_name

string | null

The legal first name of the individual.

individual.last_name

string | null

The legal last name of the individual.

individual.phone

string | null

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.

Show properties

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.

Possible enum values

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

verification

object

Verification status of the Entity. Verification requirements are set on a team-by-team basis.

Show properties

verification.identity

object

Identity verification status for the Entity.

Show properties

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.

Show properties

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. .

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.

string

Unique identifier for the Entity.

type

enum

The type of Entity. Must be corporation

corporation

object | null

Corporation information of the Entity.

Show properties

corporation.name

string | null

The legal name of the corporation Entity.

corporation.dba

string | null

DBA (Doing Business As) name of the corporation Entity.

corporation.ein

string | null

The EIN of the corporation Entity.

corporation.owners

object[]

The details of the corporation's owners (only include individuals owning 25% or more of the corporation).

Show properties

corporation.owners.first_name

string | null

The legal first name of the corporation owner.

corporation.owners.last_name

string | null

The legal last name of the corporation owner.

corporation.owners.phone

string | null

Mobile phone number of the corporation owner in E.164 format. The number will only be used for KYC / AML verification.

corporation.owners.email

string | null

Email address of the corporation owner. The email will only be used for KYC / AML verification.

corporation.owners.dob

string | null

The corporation owner's date of birth in ISO 8601 format.

corporation.owners.address

object

The corporation owner's address.

Show properties

corporation.owners.address.line1

string | null

The first line of the corporation owner's address.

corporation.owners.address.line2

string | null

The second line of the corporation owner's address.

corporation.owners.address.city

string | null

The city of the corporation owner's address.

corporation.owners.address.state

string | null

The two-letter abbreviation for the state of the corporation owner's address.

corporation.owners.address.zip

string | null

The ZIP code of the corporation owner.

error

object | null

An object representing an error that occurred while processing this Entity. See Entity errors.

address

object | null

The Entity's address.

Show properties

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.

Possible enum values

active

The Entity has passed basic KYB verification.

incomplete

The Entity could not be verified using the information provided. Update the Entity by providing more information to enable capabilities.

disabled

The Entity has been disabled and no longer has capabilities. Entities can transition into the disabled status if an Entity revokes authorization for a payment that has already been sent.

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

Webhook Errors Create an Individual

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

API Reference

Entities

Accounts

Payments

Elements

Events

Supporting Endpoints

PII Requirements

Entity Objects

Webhook Payload

API Reference

Entities

Accounts

Payments

Elements

Events

Supporting Endpoints

​PII Requirements

​Entity Objects

​Webhook Payload

PII Requirements

Entity Objects

Webhook Payload