Create an individual entity

Creates a new individual entity, and initiates the KYC / AML verification. The identity verification will almost always be fulfilled synchronously. If a verification takes longer than 5 seconds, the request will be handled asynchronously and a webhook will be fired when there is an update.

An Entity can be created with an empty object and progressively updated with more information from your end user. See Entity Capabilities for more info.

Parameters

`type`

string

The type of the entity. Option for individual entity: individual

Required

`individual`

object

Individual information of the entity.

Required

`individual.first_name`

string

The legal first name of the individual entity.

Required

`individual.last_name`

string

The legal last name of the individual entity.

Required

`individual.phone`

string

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

💡 Tip The entity's phone number must be verified before used for creating an Entity.

Required

`individual.email`

string

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

Optional

`individual.dob`

string

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

Optional

`address`

object

The entity's address.

Optional

`address.line1`

string

The first line of the entity's address.

Optional

`address.line2`

string

The second line of the entity's address.

Optional

`address.city`

string

The city of the entity's address.

Optional

`address.state`

string

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

Optional

`address.zip`

string

The ZIP code of the entity's address.

Optional

cURL
Node.js
Python

POST /entities
curl https://production.methodfi.com/entities \
  -X POST \
  -H "Authorization: Bearer sk_WyZEWVfTcH7GqmPzUPk65Vjc" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "individual",
    "individual": {
      "first_name": "Kevin",
      "last_name": "Doyle",
      "phone": "+16505555555",
      "email": "kevin.doyle@gmail.com",
      "dob": "1997-03-18"
    },
    "address": {
      "line1": "3300 N Interstate 35",
      "line2": null,
      "city": "Austin",
      "state": "TX",
      "zip": "78705"
    }
  }'

POST /entities
const entity = await method.entities.create({
  type: 'individual',
  individual: {
    first_name: 'Kevin',
    last_name: 'Doyle',
    phone: '+16505555555',
    email: 'kevin.doyle@gmail.com',
    dob: '1997-03-18',
  },
  address: {
    line1: '3300 N Interstate 35',
    line2: null,
    city: 'Austin',
    state: 'TX',
    zip: '78705',
  },
});

POST /entities
entity = method.entities.create({
  'type': 'individual',
  'individual': {
    'first_name': 'Kevin',
    'last_name': 'Doyle',
    'phone': '+16505555555',
    'email': 'kevin.doyle@gmail.com',
    'dob': '1997-03-18',
  },
  'address': {
    'line1': '3300 N Interstate 35',
    'line2': None,
    'city': 'Austin',
    'state': 'TX',
    'zip': '78705'
  }
})

RESPONSE
{
  "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",
    "data:sync"
  ],
  "available_capabilities": [
    "data:retrieve"
  ],
  "pending_capabilities": [],
  "error": null,
  "status": "active",
  "metadata": null,
  "created_at": "2020-12-09T00:40:51.107Z",
  "updated_at": "2020-12-09T00:40:51.107Z"
}