> ## Documentation Index
> Fetch the complete documentation index at: https://docs.methodfi.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Connect

export const ParamList = ({items = [], is_child = false}) => {
  return items.map(item => {
    const field_props = {
      id: Math.random().toString(),
      body: item.name,
      name: item.name,
      type: item.type,
      required: item.required
    };
    const enums = item.enums || [];
    const items = item.items || [];
    const has_items = items?.length > 0;
    const has_enums = enums?.length > 0;
    const should_default_open = item.defaultOpen || false;
    const render_child_item = () => {
      const child_props = {
        title: has_enums ? "Possible enum values" : "properties"
      };
      if (should_default_open) child_props.defaultOpen = true;
      const has_inline_enums = has_enums && enums.every(enum_item => typeof enum_item === 'string') && enums.map((enum_item, idx) => {
        const is_last = idx === enums.length - 1;
        const is_2nd_to_last = idx === enums.length - 2;
        return <>
            <code>{enum_item}</code>
            {is_last && ''}
            {is_2nd_to_last && ' or '}
            {!is_last && !is_2nd_to_last && ', '}
          </>;
      });
      const enum_list = has_enums && !has_inline_enums && <Accordion {...child_props}>
          {enums.map((enum_item, index) => <div key={`enum-${index}`}>
              <code>{enum_item.name}</code>
              <br />
              <p>{enum_item.description}</p>
            </div>)}
        </Accordion>;
      const item_list = has_items && <Expandable {...child_props}>
          <ParamList items={items || []} is_child />
        </Expandable>;
      return <>
          <p>
            {item.description}
            {has_inline_enums && [has_inline_enums.length > 1 ? ' One of ' : ' Must be ', ...has_inline_enums]}
          </p>

          {enum_list}
          {item_list}
        </>;
    };
    return is_child ? <ResponseField {...field_props}>{render_child_item()}</ResponseField> : <ParamField {...field_props}>{render_child_item()}</ParamField>;
  });
};

<Note>Mode: `connect`</Note>

Opal Connect is the primary way to connect user liability accounts with Method.
This pre-built flow gathers a user's consent, verifies their identity, and completes any needed verifications to ensure their accounts are connected to the Method ecosystem.

<img src="https://mintcdn.com/methodfinancial/eYCszB8Xv_iFcf77/images/connect-hero.svg?fit=max&auto=format&n=eYCszB8Xv_iFcf77&q=85&s=be7a6b5840a512b80707df91e7d31fdd" alt="connect-hero" width="1920" height="1080" data-path="images/connect-hero.svg" />

## What this mode does

Connect lets users find and connect their liability accounts (credit cards, loans, mortgages, etc.). Configure whether users may select a single account, multiple accounts, or by default select all eligible accounts.

## Parameters

<ParamList
  items={[
{
  name: "selection_type",
  type: "enum",
  required: true,
  description:
    "Whether to select a single account, multiple accounts, or all eligible accounts.",
  enums: ["single", "multiple", "all"],
},
{
  name: "account_filters",
  type: "object",
  required: false,
  description:
    "Filters to explicitly include or exclude accounts during selection.",
  items: [
    {
      name: "account_filters.include",
      type: "object",
      required: false,
      description: "Accounts to explicitly include.",
      items: [
        {
          name: "account_filters.include.account_types",
          type: "string[]",
          required: false,
          description: "Only surface these liability types for selection.",
          enums: [
            { name: "credit_card" },
            { name: "auto_loan" },
            { name: "mortgage" },
            { name: "student_loan" },
            { name: "personal_loan" },
          ],
        },
        {
          name: "account_filters.include.products",
          type: "string[]",
          required: false,
          description: "Only surface accounts that support these products.",
          enums: [
            { name: "balance" },
            { name: "sensitive" },
            { name: "payoff" },
            { name: "update" },
            { name: "payment" },
          ],
        },
      ],
    },
    {
      name: "account_filters.exclude",
      type: "object",
      required: false,
      description: "Accounts to exclude from the flow.",
      items: [
        {
          name: "account_filters.exclude.account_types",
          type: "string[]",
          required: false,
          description: "Mark specific liability types as ineligible.",
          enums: [
            { name: "credit_card" },
            { name: "auto_loan" },
            { name: "mortgage" },
            { name: "student_loan" },
            { name: "personal_loan" },
          ],
        },
        {
          name: "account_filters.exclude.mch_ids",
          type: "string[]",
          required: false,
          description: "Mark accounts tied to the provided merchant IDs as ineligible.",
        },
        {
          name: "account_filters.exclude.unverified_account_numbers",
          type: "boolean",
          required: false,
          description: "Mark accounts with unverified account numbers as ineligible.",
        },
      ],
    },
  ],
},
{
  name: "skip_pii",
  type: "string[]",
  description: "The PII to skip.",
  enums: ["name", "dob", "address", "ssn_4"],
},
]}
/>

## Create a token

You can create a connect session token using one of the supported patterns:

* Existing entity: provide `entity_id` + `mode` + `connect`
* Create new entity: provide `entity` + `mode` + `connect`
* Resume session: provide `session_id` only (omit `mode` and `connect`)

### Existing Entity

```json theme={null}
{
  "entity_id": "ent_...",
  "mode": "connect",
  "connect": {
    "selection_type": "single",
    "account_filters": {
      "include": {
        "account_types": ["credit_card", "auto_loan"],
        "products": ["balance"]
      }
    }
  }
}
```

### Create New Entity

```json theme={null}
{
  "entity": {
    "type": "individual",
    "individual": {
      "first_name": "Kevin",
      "last_name": "Doyle",
      "phone": "+15125551234"
    }
  },
  "mode": "connect",
  "connect": {
    "selection_type": "multiple",
    "account_filters": {
      "exclude": {
        "account_types": ["personal_loan"],
        "mch_ids": ["mch_123"],
        "unverified_account_numbers": true
      }
    }
  }
}
```

### Response

```json theme={null}
{
  "token": "otkn_...",
  "valid_until": "2025-06-10T22:50:53.024Z",
  "session_id": "osess_..."
}
```

## Launch Opal

<Tabs>
  <Tab title="React (Web)">
    ```tsx theme={null}
    import { OpalProvider, useOpal } from "@methodfi/opal-react";

    function Screen() {
      const { open } = useOpal({ env: "dev", onEvent: (e) => {} });
      const start = async () => {
        const { token } = await getTokenFromBackend();
        open({ token });
      };
      return <button onClick={start}>Connect Accounts</button>;
    }
    ```
  </Tab>

  <Tab title="React Native">
    ```tsx theme={null}
    import { OpalProvider, useOpal } from "@methodfi/opal-react-native";

    function Screen() {
      const { open } = useOpal({ env: "dev", onEvent: (e) => {} });
      const start = async () => {
        const { token } = await getTokenFromBackend();
        open({ token });
      };
      return <Button title="Connect Accounts" onPress={start} />;
    }
    ```
  </Tab>
</Tabs>