Skip to main content

The entity object

Entities are a representation of your application's end-users. Throughout Method's ecosystem, an Entity is the legal owner of any Account.
When creating an Entity we will perform a KYC / AML verification on your behalf. In most cases, the verification takes seconds and only requires basic information from your end-user.

Attributes

id

string
Unique identifier for the entity

type

enum
The type of the entity
Possible enum values

individual

A person or individual.

c_corporation

A company or corporation.

individual

object,null
Individual information of the entity.

individual.first_name

string,null
The legal first name of the individual entity.

individual.last_name

string,null
The legal last name of the individual entity.

individual.phone

string,null
Mobile phone number of the individual entity in E.164 format. The number will only be used for KYC / AML verification.

individual.email

string,null
Email address of the individual entity. The email will only be used for KYC / AML verification.

individual.dob

string,null
The entity's date of birth in ISO 8601 format.

corporation

object,null
Corporation information of the entity.

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

corporation.owners[].first_name

string
The legal first name of the corporation owner.

corporation.owners[].last_name

string
The legal last name of the corporation owner.

corporation.owners[].phone

string
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
Email address of the corporation owner. The email will only be used for KYC / AML verification.

corporation.owners[].dob

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

corporation.owners[].address

object
The corporation owner's address.

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's address.

capabilities

enum[]

The active capabilities of the entity.

An entity will have specific capabilities based on the data provided. An entity can be further updated with more information to expand the capabilities of an entity.
Possible enum values

payments:receive

The entity can be a destination and receive payments from any other entity.

Minimum required information: first_name, last_name, and phone.

payments:send

The entity can be a source and send payments from any ACH account regardless of how they were created.

Minimum required information: first_name, last_name, and phone.

data:retrieve

The entity can automatically retrieve and link their debts through Method Data - Retrieve an entity's debts.

Minimum required information: first_name, last_name, and phone.

data:sync

Minimum required information: first_name, last_name, and phone.

available_capabilities

enum[]
The capabilities of an entity that require additional verification to fully activate.

pending_capabilities

enum[]
A list of possible capabilities for an entity that an entity can activate.

error

object,null
An object representing an error that occurred for this entity. See entity errors.

address

object
The entity's address.

address.line1

string,null
The first line of the entity's address.

address.line2

string,null
The second line of the entity's address.

address.city

string,null
The city of the entity's address.

address.state

string,null
The two-letter abbreviation for the state of the entity's address.

address.zip

string,null
The ZIP code of the entity's address.

status

enum
Status of the entity's KYC / AML verification. An entity will enter the following statuses as it undergoes KYC / AML verification.
Possible enum values

active

The entity has passed basic KYC / AML verification. Once active, the entity will have at least the payments:receive capability.

incomplete

The entity does not have any capabilities yet. 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.
{
  "id": "ent_au22b1fbFJbp8",
  "type": "individual",
  "individual": {
    "first_name": "Kevin",
    "last_name": "Doyle",
    "phone": "+16505555555",
    "email": "kevin.doyle@gmail.com",
    "dob": "1997-03-18"
  },
  "corporation": null,
  "receive_only": null,
  "address": {
    "line1": "3300 N Interstate 35",
    "line2": null,
    "city": "Austin",
    "state": "TX",
    "zip": "78705"
  },
  "capabilities": [
    "payments:send",
    "payments:receive"
  ],
  "available_capabilities": [],
  "pending_capabilities": [],
  "error": null,
  "status": "active",
  "metadata": null,
  "created_at": "2020-12-09T00:40:51.107Z",
  "updated_at": "2020-12-09T00:40:51.107Z"
}