Skip to main content
Many objects allow you to request additional information as an expanded response by using the expand query parameter. This parameter is available for entities, accounts, and Connect and applies to the response of that request only. In many cases, an object contains the ID of a related object in its response attributes. For example, an Entity might have an associated CreditScore ID. You can expand these objects in line with the expand query parameter. The expandable label in this documentation indicates ID fields that you can expand into objects. You can expand multiple objects at the same time by identifying multiple items in the expand array. Performing expansions on list requests might result in increased response times. In the case of Connect, recursive expansion up to 2 levels is supported. The first level expands the returned accounts. The second level allows expansion of any account-level properties using the notation accounts.expandable_field, such as accounts.update. For more information, see Connect Expand Enum

​
Props

​
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.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.sensitive
This is an Account property, and refers to the Sensitive Object.balance
This is an Account property, and refers to the Balance Object.card_brand
This is an Account property, and refers to the CardBrand Object.attribute
This is an Account property, and refers to the Attribute Object.payoff
This is an Account property, and refers to the Payoff Object.transaction
This is an Account property, and refers to the Transaction Object.update
This is an Account property, and refers to the Update Object.payment_instrument
This is an Account property, and refers to the PaymentInstrument Object.latest_verification_session
This is an Account property, and refers to the AccountVerificationSession Object.

​
Returns

Returns a list of the requested resource with the requested attributes expanded. 
curl "https://production.methodfi.com/entities/ent_BzirqpLEm3BW7?expand[]=connect" \
  -H "Authorization: Bearer sk_WyZEWVfTcH7GqmPzUPk65Vjc"

  {
    "id": "ent_BzirqpLEm3BW7",
    "type": "individual",
    "individual": {
      "first_name": "Kevin",
      "last_name": "Doyle",
      "phone": "+15121231113",
      "dob": "1997-03-18",
      "email": "kevin.doyle@gmail.com",
      "ssn_4": null,
      "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": {
      "id": "cxn_4ewMmBbjYDMR4",
      "entity_id": "ent_qKNBB68bfHGNA",
      "status": "completed",
      "accounts": [
        "acc_eKKmrXDpJBKgw",
        "acc_GV8WbmJW7KGRy",
        "acc_MLPKh9gQDDbT8",
        "acc_LbXE8wVYJLrKt",
        "acc_J3P9fayDFjpAy",
        "acc_eFFRV9zmpLREK"
      ],
      "error": null,
      "created_at": "2024-04-12T14:56:46.645Z",
      "updated_at": "2024-04-12T14:56:46.786Z"
    },
    "credit_score": "crs_pn4ca33GXFaCE",
    "identity": null,
    "products": [
      "connect",
      "credit_score"
    ],
    "restricted_products": [
      "identity",
      "attribute"
    ],
    "subscriptions": [],
    "available_subscriptions": [],
    "restricted_subscriptions": [
      "connect",
      "credit_score"
    ],
    "metadata": null,
    "created_at": "2024-04-12T14:56:34.710Z",
    "updated_at": "2024-04-12T14:56:34.744Z"

}