Entities
Retrieve an Entity
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
Entities
Retrieve an Entity
GET
/
entities
/
:ent_id
curl https://production.methodfi.com/entities/ent_au22b1fbFJbp8 \
-H "Method-Version: 2024-04-04" \
-H "Authorization: Bearer sk_WyZEWVfTcH7GqmPzUPk65Vjc"
{
"id": "ent_au22b1fbFJbp8",
"type": "individual",
"individual": {
"first_name": "Kevin",
"last_name": "Doyle",
"phone": "+15121231111",
"dob": "1997-03-18",
"email": "kevin.doyle@gmail.com",
"ssn_4": "xxxx",
"ssn": null,
},
"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",
"vehicle"
],
"restricted_products": [
"identity",
"attribute"
],
"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 the Entity associated with the ID.
Path Parameters
The ID of the Entity.
Query Parameters
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 the Entity associated with the ID.
curl https://production.methodfi.com/entities/ent_au22b1fbFJbp8 \
-H "Method-Version: 2024-04-04" \
-H "Authorization: Bearer sk_WyZEWVfTcH7GqmPzUPk65Vjc"
{
"id": "ent_au22b1fbFJbp8",
"type": "individual",
"individual": {
"first_name": "Kevin",
"last_name": "Doyle",
"phone": "+15121231111",
"dob": "1997-03-18",
"email": "kevin.doyle@gmail.com",
"ssn_4": "xxxx",
"ssn": null,
},
"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",
"vehicle"
],
"restricted_products": [
"identity",
"attribute"
],
"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/ent_au22b1fbFJbp8 \
-H "Method-Version: 2024-04-04" \
-H "Authorization: Bearer sk_WyZEWVfTcH7GqmPzUPk65Vjc"
{
"id": "ent_au22b1fbFJbp8",
"type": "individual",
"individual": {
"first_name": "Kevin",
"last_name": "Doyle",
"phone": "+15121231111",
"dob": "1997-03-18",
"email": "kevin.doyle@gmail.com",
"ssn_4": "xxxx",
"ssn": null,
},
"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",
"vehicle"
],
"restricted_products": [
"identity",
"attribute"
],
"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"
}