API Reference
Entities
- The entity endpoint
- POSTCreate an Individual
- POSTCreate a Corporation
- PUTUpdate an Entity
- GETRetrieve an Entity
- GETList all Entities
- Connect
- Verification Sessions
- Credit Scores
- Attributes
- Vehicles
- Identities
- Products
- Subscriptions
- Consent
Accounts
- The account endpoint
- POSTCreate an Account
- GETRetrieve an Account
- GETList all Accounts
- Updates
- Transactions
- Card Brand
- Attributes
- Payoffs
- Balances
- Sensitive
- Products
- Subscriptions
- Verification Sessions
- Consent
Payments
Supporting Endpoints
- Merchants
- Webhooks
- Reports
- Simulations (Dev)
- Health Check
List all Entities
curl https://production.methodfi.com/entities \
-H "Method-Version: 2024-04-04" \
-H "Authorization: Bearer sk_WyZEWVfTcH7GqmPzUPk65Vjc"
{
"data": [
{
"id": "ent_76kPG9mJyyGYL",
"type": "individual",
"individual": {
"first_name": "Kevin",
"last_name": "Doyle",
"phone": "+15121231111",
"dob": "1997-03-18",
"email": "kevin.doyle@gmail.com",
"ssn_4": null,
"ssn": "xxxxxxxxx"
},
"error": null,
"address": {
"line1": "3300 N Interstate 35",
"line2": null,
"city": "Austin",
"state": "TX",
"zip": "78705"
},
"status": "active",
"verification": {
"identity": {
"verified": true,
"matched": true,
"latest_verification_session": "evf_mQ6yr6VVJLNEb",
"methods": []
},
"phone": {
"verified": true,
"latest_verification_session": "evf_P4QXNj93Y9J8L",
"methods": []
}
},
"connect": null,
"credit_score": null,
"products": [
"connect",
"credit_score",
"identity"
],
"restricted_products": [
"attribute"
],
"subscriptions": [
"connect"
],
"available_subscriptions": [],
"restricted_subscriptions": [
"credit_score"
],
"metadata": null,
"created_at": "2023-10-23T05:46:14.550Z",
"updated_at": "2023-10-23T05:46:14.550Z"
},
{
"id": "ent_A6bmTtFmxQhGQ",
"type": "corporation",
"corporation": {
"name": "Alphabet Inc.",
"dba": "Google",
"ein": "641234567",
"owners": [
{
"first_name": "Sergey",
"last_name": "Brin",
"phone": "+16505555555",
"email": "sergey@google.com",
"dob": "1973-08-21",
"address": {
"line1": "600 Amphitheatre Parkway",
"line2": null,
"city": "Mountain View",
"state": "CA",
"zip": "94043"
}
}
]
},
"error": null,
"address": {
"line1": "1600 Amphitheatre Parkway",
"line2": null,
"city": "Mountain View",
"state": "CA",
"zip": "94043"
},
"status": "active",
"metadata": null,
"created_at": "2023-10-24T21:26:17.225Z",
"updated_at": "2023-10-24T21:26:17.225Z"
} ,
{
"id": "ent_mxp3B3yyKLHTH",
"type": "individual",
"individual": {
"first_name": "Alex",
"last_name": "Kennedy",
"phone": "+19565555555",
"dob": "1985-04-23",
"email": "alex.kennedy@hey.com",
"ssn_4": null,
"ssn": null
},
"error": null,
"address": {
"line1": "1 Hacker Way",
"line2": null,
"city": "Menlo Park",
"state": "CA",
"zip": "94025"
},
"status": "active",
"verification": {
"identity": {
"verified": true,
"matched": true,
"latest_verification_session": "evf_mQ6yr6VVJLNEb",
"methods": []
},
"phone": {
"verified": true,
"latest_verification_session": "evf_P4QXNj93Y9J8L",
"methods": []
}
},
"connect": null,
"credit_score": null,
"products": [
"connect",
"credit_score"
],
"restricted_products": [
"identity"
],
"subscriptions": [],
"available_subscriptions": [
"connect",
"credit_score"
],
"restricted_subscriptions": [],
"metadata": null,
"created_at": "2023-10-23T05:46:14.550Z",
"updated_at": "2023-10-23T05:46:14.550Z"
}
]
}
Returns all the Entities associated with your team, or an empty array if none have been created.
Query Parameters
The type of Entities to retrieve. One of individual
or corporation
The status of Entities to retrieve. One of active
, incomplete
or disabled
ISO 8601 formatted date (YYYY-MM-DD) to filter for Entities created on and after the date provided.
ISO 8601 formatted date (YYYY-MM-DD) to filter for Entities created on and before the date provided.
The number of the page to return.
The ID of a resource from which a page should start or end. Mutually exclusive with page
.
The number of Entities to return per page.
Attributes that can be expanded into an object to provide additional information.
connect
This is an Entity property, and refers to the Connect Object.
credit_score
This is an Entity property, and refers to the CreditScore Object.
attribute
This is an Entity property, and refers to the Attribute Object.
vehicle
This is an Entity property, and refers to the Vehicle Object.
identity_latest_verification_session
This is an Entity property, and refers to the EntityVerificationSession Object.
phone_latest_verification_session
This is an Entity property, and refers to the EntityVerificationSession Object.
Returns
Returns a list of Entities.
curl https://production.methodfi.com/entities \
-H "Method-Version: 2024-04-04" \
-H "Authorization: Bearer sk_WyZEWVfTcH7GqmPzUPk65Vjc"
{
"data": [
{
"id": "ent_76kPG9mJyyGYL",
"type": "individual",
"individual": {
"first_name": "Kevin",
"last_name": "Doyle",
"phone": "+15121231111",
"dob": "1997-03-18",
"email": "kevin.doyle@gmail.com",
"ssn_4": null,
"ssn": "xxxxxxxxx"
},
"error": null,
"address": {
"line1": "3300 N Interstate 35",
"line2": null,
"city": "Austin",
"state": "TX",
"zip": "78705"
},
"status": "active",
"verification": {
"identity": {
"verified": true,
"matched": true,
"latest_verification_session": "evf_mQ6yr6VVJLNEb",
"methods": []
},
"phone": {
"verified": true,
"latest_verification_session": "evf_P4QXNj93Y9J8L",
"methods": []
}
},
"connect": null,
"credit_score": null,
"products": [
"connect",
"credit_score",
"identity"
],
"restricted_products": [
"attribute"
],
"subscriptions": [
"connect"
],
"available_subscriptions": [],
"restricted_subscriptions": [
"credit_score"
],
"metadata": null,
"created_at": "2023-10-23T05:46:14.550Z",
"updated_at": "2023-10-23T05:46:14.550Z"
},
{
"id": "ent_A6bmTtFmxQhGQ",
"type": "corporation",
"corporation": {
"name": "Alphabet Inc.",
"dba": "Google",
"ein": "641234567",
"owners": [
{
"first_name": "Sergey",
"last_name": "Brin",
"phone": "+16505555555",
"email": "sergey@google.com",
"dob": "1973-08-21",
"address": {
"line1": "600 Amphitheatre Parkway",
"line2": null,
"city": "Mountain View",
"state": "CA",
"zip": "94043"
}
}
]
},
"error": null,
"address": {
"line1": "1600 Amphitheatre Parkway",
"line2": null,
"city": "Mountain View",
"state": "CA",
"zip": "94043"
},
"status": "active",
"metadata": null,
"created_at": "2023-10-24T21:26:17.225Z",
"updated_at": "2023-10-24T21:26:17.225Z"
} ,
{
"id": "ent_mxp3B3yyKLHTH",
"type": "individual",
"individual": {
"first_name": "Alex",
"last_name": "Kennedy",
"phone": "+19565555555",
"dob": "1985-04-23",
"email": "alex.kennedy@hey.com",
"ssn_4": null,
"ssn": null
},
"error": null,
"address": {
"line1": "1 Hacker Way",
"line2": null,
"city": "Menlo Park",
"state": "CA",
"zip": "94025"
},
"status": "active",
"verification": {
"identity": {
"verified": true,
"matched": true,
"latest_verification_session": "evf_mQ6yr6VVJLNEb",
"methods": []
},
"phone": {
"verified": true,
"latest_verification_session": "evf_P4QXNj93Y9J8L",
"methods": []
}
},
"connect": null,
"credit_score": null,
"products": [
"connect",
"credit_score"
],
"restricted_products": [
"identity"
],
"subscriptions": [],
"available_subscriptions": [
"connect",
"credit_score"
],
"restricted_subscriptions": [],
"metadata": null,
"created_at": "2023-10-23T05:46:14.550Z",
"updated_at": "2023-10-23T05:46:14.550Z"
}
]
}
curl https://production.methodfi.com/entities \
-H "Method-Version: 2024-04-04" \
-H "Authorization: Bearer sk_WyZEWVfTcH7GqmPzUPk65Vjc"
{
"data": [
{
"id": "ent_76kPG9mJyyGYL",
"type": "individual",
"individual": {
"first_name": "Kevin",
"last_name": "Doyle",
"phone": "+15121231111",
"dob": "1997-03-18",
"email": "kevin.doyle@gmail.com",
"ssn_4": null,
"ssn": "xxxxxxxxx"
},
"error": null,
"address": {
"line1": "3300 N Interstate 35",
"line2": null,
"city": "Austin",
"state": "TX",
"zip": "78705"
},
"status": "active",
"verification": {
"identity": {
"verified": true,
"matched": true,
"latest_verification_session": "evf_mQ6yr6VVJLNEb",
"methods": []
},
"phone": {
"verified": true,
"latest_verification_session": "evf_P4QXNj93Y9J8L",
"methods": []
}
},
"connect": null,
"credit_score": null,
"products": [
"connect",
"credit_score",
"identity"
],
"restricted_products": [
"attribute"
],
"subscriptions": [
"connect"
],
"available_subscriptions": [],
"restricted_subscriptions": [
"credit_score"
],
"metadata": null,
"created_at": "2023-10-23T05:46:14.550Z",
"updated_at": "2023-10-23T05:46:14.550Z"
},
{
"id": "ent_A6bmTtFmxQhGQ",
"type": "corporation",
"corporation": {
"name": "Alphabet Inc.",
"dba": "Google",
"ein": "641234567",
"owners": [
{
"first_name": "Sergey",
"last_name": "Brin",
"phone": "+16505555555",
"email": "sergey@google.com",
"dob": "1973-08-21",
"address": {
"line1": "600 Amphitheatre Parkway",
"line2": null,
"city": "Mountain View",
"state": "CA",
"zip": "94043"
}
}
]
},
"error": null,
"address": {
"line1": "1600 Amphitheatre Parkway",
"line2": null,
"city": "Mountain View",
"state": "CA",
"zip": "94043"
},
"status": "active",
"metadata": null,
"created_at": "2023-10-24T21:26:17.225Z",
"updated_at": "2023-10-24T21:26:17.225Z"
} ,
{
"id": "ent_mxp3B3yyKLHTH",
"type": "individual",
"individual": {
"first_name": "Alex",
"last_name": "Kennedy",
"phone": "+19565555555",
"dob": "1985-04-23",
"email": "alex.kennedy@hey.com",
"ssn_4": null,
"ssn": null
},
"error": null,
"address": {
"line1": "1 Hacker Way",
"line2": null,
"city": "Menlo Park",
"state": "CA",
"zip": "94025"
},
"status": "active",
"verification": {
"identity": {
"verified": true,
"matched": true,
"latest_verification_session": "evf_mQ6yr6VVJLNEb",
"methods": []
},
"phone": {
"verified": true,
"latest_verification_session": "evf_P4QXNj93Y9J8L",
"methods": []
}
},
"connect": null,
"credit_score": null,
"products": [
"connect",
"credit_score"
],
"restricted_products": [
"identity"
],
"subscriptions": [],
"available_subscriptions": [
"connect",
"credit_score"
],
"restricted_subscriptions": [],
"metadata": null,
"created_at": "2023-10-23T05:46:14.550Z",
"updated_at": "2023-10-23T05:46:14.550Z"
}
]
}