Entities
Retrieve an Entity
- Introduction
- Authentication
- Environments
- Idempotency
- Expanding Resources
- Request IDs
- Versioning
- Pagination
- Metadata
- Errors
- The entity endpoint
- POSTCreate an Individual
- POSTCreate a Corporation
- PUTUpdate an Entity
- GETList all Entities
- GETRetrieve an Entity
- Connect
- Verification Sessions
- Credit Scores
- Identities
- Products
- Subscriptions
- Consent
- The account endpoint
- POSTCreate an Account
- GETList all Accounts
- GETRetrieve an Account
- Updates
- Transactions
- Card Brand
- Payoffs
- Balances
- Sensitive
- Products
- Subscriptions
- Verification Sessions
- Consent
- The payment endpoint
- POSTCreate a Payment
- GETList all Payments
- GETRetrieve a Payment
- DELDelete a Payment
- Merchants
- Webhooks
- Reports
- Simulations (Dev)
- Health Check
API Reference
Entities
Accounts
Payments
Supporting Endpoints
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"
],
"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 the Entity associated with the ID.
Path Parameters
ent_id
string
The ID of the Entity.
Query Parameters
expand
enum[]
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.
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"
],
"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/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"
],
"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"
}