GET
/
elements
/
token
/
{pk_elem_id}
/
results
curl https://production.methodfi.com/elements/token/pk_elem_dDe4r9M6X3Ad9zjpbgYpzLNtRCXfhPYR/results \
  -X GET \
  -H "Method-Version: 2024-04-04" \
  -H "Authorization: Bearer sk_WyZEWVfTcH7GqmPzUPk65Vjc"
{
  "authenticated": true,
  "cxn_id": "cxn_xr86xHEcWmpmB",
  "accounts": [
    "acc_jPXLFqd6KzH3N",
    "acc_DALLeLrj3TH8h"
  ],
  "entity_id": "ent_GWKYtnFyE79db",
  "events": [
    {
      "type": "open",
      "metadata": {
        "element_type": "connect",
        "op": "open"
      },
      "timestamp": "2024-04-25T02:35:28.097Z"
    },
    {
      "type": "success",
      "metadata": {
        "entity_id": "ent_GWKYtnFyE79db",
        "accounts": [
          "acc_jPXLFqd6KzH3N",
          "acc_DALLeLrj3TH8h"
        ],
        "element_type": "connect",
        "op": "success"
      },
      "timestamp": "2024-04-25T02:35:57.120Z"
    },
    {
      "type": "exit",
      "metadata": {
        "element_type": "connect",
        "op": "exit"
      },
      "timestamp": "2024-04-25T02:35:57.138Z"
    }
  ]
}

Returns results and metadata for a given Element token.

Path Parameters

pk_elem_id
string
required

ID of the Element token.

Returns

Returns information about the Element token and session.

curl https://production.methodfi.com/elements/token/pk_elem_dDe4r9M6X3Ad9zjpbgYpzLNtRCXfhPYR/results \
  -X GET \
  -H "Method-Version: 2024-04-04" \
  -H "Authorization: Bearer sk_WyZEWVfTcH7GqmPzUPk65Vjc"
{
  "authenticated": true,
  "cxn_id": "cxn_xr86xHEcWmpmB",
  "accounts": [
    "acc_jPXLFqd6KzH3N",
    "acc_DALLeLrj3TH8h"
  ],
  "entity_id": "ent_GWKYtnFyE79db",
  "events": [
    {
      "type": "open",
      "metadata": {
        "element_type": "connect",
        "op": "open"
      },
      "timestamp": "2024-04-25T02:35:28.097Z"
    },
    {
      "type": "success",
      "metadata": {
        "entity_id": "ent_GWKYtnFyE79db",
        "accounts": [
          "acc_jPXLFqd6KzH3N",
          "acc_DALLeLrj3TH8h"
        ],
        "element_type": "connect",
        "op": "success"
      },
      "timestamp": "2024-04-25T02:35:57.120Z"
    },
    {
      "type": "exit",
      "metadata": {
        "element_type": "connect",
        "op": "exit"
      },
      "timestamp": "2024-04-25T02:35:57.138Z"
    }
  ]
}

Auth Events

Event prefixDescription
AUTH_INTROIndicates when the user opens, closes, or continues past the Intro screen
AUTH_NAMEIndicates when the user opens, closes, or continues past the input name screen
AUTH_PHONEIndicates when the user opens, closes, or continues past the input phone screen
AUTH_PHONE_VERIFYIndicates when the user opens the phone verification screen, submits a code, resends a code, or closes the screen
AUTH_DOBIndicates when the user opens, closes, or continues past the date of birth input screen
AUTH_ADDRESSIndicates when the user opens, closes, or continues past the address input screen
AUTH_SSN4Indicates when the user opens, closes, or continues past the last 4 of SSN input screen
AUTH_SECQIndicates when the user opens, closes, incorrectly answers, or continues past the security questions screen
AUTH_CONSENTIndicates when the user opens, closes, or continues past the account consent screen
AUTH_SUCCESSIndicates when the user successfully completes the Authentication portion of Connect
AUTH_FAILUREIndicates if the user ran into an error during the Authentication portion of Connect

Account Verification Events

Event prefixDescription
AVF_ACCOUNT_LISTIndicates when the user opens or exits out of the account list
AVF_LEARN_MOREIndicates when the user opens or exits out of the Learn More modal
AVF_ACCOUNT_VERIFYIndicates when the user opens, submits, or closes the verification modal for a specific account
AVF_SUCCESSIndicates when the user opens or continues past the verification success screen
AVF_EMPTY_SUCCESSIndicates when the user opens or continues past the success screen shown if there were no accounts that required verification
AVF_SKIP_ALLIndicates when the user skips all account verifications
AVF_ERRORIndicates when the user is displyed an error screen during account verification