/* Styles for Dark Mode */
html:is(.dark) {
    p, div {
        color: #E6E8EE;
    }

    #sidebar {
        border-right-color: rgb(var(--gray-800));
    }
}

/* Styles for Light Mode */
html:not(.dark) {
    #sidebar {
        border-right-color: rgb(var(--gray-200));
    }
}


/* Shared styles */
#sidebar {
    position: fixed;
    left: 2rem;
    border-right-width: 1px;
    border-right-style: solid;
}

#navbar .max-w-8xl {
    max-width: 100%;
}

/* Media */
@media(min-width: 1870px) {
    #content-area {
        padding-left: 0;
    }
}

@media(min-width: 1755px) {
    #content-area {
        padding-left: 5rem;
        min-width: 50%;
    }

    #content-container {
        padding-left: 10rem;
    }

    #content-side-layout {
        min-width: 43%;
    }

    #content-side-layout > :first-child {
        min-width: 100%;
    }
}


Path Parameters

Auth Events

Account Verification Events

Returns

Method API Docs

API Reference

Elements

Libraries

Changelog

v1 Documentation

Sign In

Get Started

Retrieve Element Results

Learn how to get started with Method's API.

Introduction

Authentication

Environments

Idempotency

Expanding Resources

Request IDs

Versioning

Pagination

Metadata

Request Errors

Resource Errors

Product Errors

Subscription Errors

Webhook Errors

Events Overview

General Events

Element Specific Events

The entity endpoint

Create an Individual

Create a Corporation

Update an Entity

Retrieve an Entity

List all Entities

The connect endpoint

Create a Connect

Retrieve a Connect

List all Connects

The entity verification sessions endpoint

Retrieve a Verification Session

List all Verification Sessions

The credit score endpoint

Create Individual Credit Scores

Retrieve Individual Credit Scores

List all Credit Scores

The attributes endpoint

Create Attributes

Retrieve Attributes

List all Attributes

The identities endpoint

Create Identities

Retrieve Identities

List all Identities

The products endpoint

Retrieve a Product

List all Products

The subscriptions endpoint

Create a Subscription

Retrieve a Subscription

List all Subscriptions

Delete a Subscription

Withdraw an Entity's Consent

The account endpoint

Create an Account

Retrieve an Account

List all Accounts

The updates endpoint

Create an Update

Retrieve an Update

List all Updates

The transactions endpoint

Retrieve a Transaction

List all Transactions

The card brand endpoint

Create a Card Brand

Retrieve a Card Brand

List all Card Brands

The payoffs endpoint

Create a Payoff

Retrieve a Payoff

List all Payoffs

The balances endpoint

Create a Balance

Retrieve a Balance

List all Balances

The sensitive endpoint

Create a Sensitive

Retrieve a Sensitive

List all Sensitives

The account verification sessions endpoint

Create a Verification

Retrieve a Verification

List all Verifications

Withdraw an Account's Consent

The payment endpoint

Create a Payment

Retrieve a Payment

List all Payments

Delete a Payment

The element endpoint

Create an Element Token

The sessions endpoint

Get Session

Create Session

Update Session

The event endpoint

Retrieve an Event

List all Events

The merchant endpoint

Retrieve a Merchant

List all Merchants

The webhook endpoint

IP Whitelisting

Create a Webhook

Retrieve a Webhook

List all Webhook

Delete a Webhook

The report endpoint

Create a Report

Retrieve a Report

Download a Report

The simulate endpoint

Update a Payment's Status

Create a Transaction

Simulate an Event

Perform a Health Check

Overview

Element SDKs

Connect Overview

Create a Connect Element Token

Launching a Connect Session

Getting Connect Results

Monthly updates featuring the latest added features, improvements, and bug fixes.

November 2024

November Updates

October 2024

October Updates

September 2024

September Updates

We are excited to announce the launch of API v2 - the highly anticipated second version of Method's API!

2024-04-04

Introducing API v2

Event prefix	Description
AUTH_INTRO	Indicates when the user opens, closes, or continues past the Intro screen
AUTH_NAME	Indicates when the user opens, closes, or continues past the input name screen
AUTH_PHONE	Indicates when the user opens, closes, or continues past the input phone screen
AUTH_PHONE_VERIFY	Indicates when the user opens the phone verification screen, submits a code, resends a code, or closes the screen
AUTH_DOB	Indicates when the user opens, closes, or continues past the date of birth input screen
AUTH_ADDRESS	Indicates when the user opens, closes, or continues past the address input screen
AUTH_SSN4	Indicates when the user opens, closes, or continues past the last 4 of SSN input screen
AUTH_SECQ	Indicates when the user opens, closes, incorrectly answers, or continues past the security questions screen
AUTH_CONSENT	Indicates when the user opens, closes, or continues past the account consent screen
AUTH_SUCCESS	Indicates when the user successfully completes the Authentication portion of Connect
AUTH_FAILURE	Indicates if the user ran into an error during the Authentication portion of Connect

Event prefix	Description
AVF_ACCOUNT_LIST	Indicates when the user opens or exits out of the account list
AVF_LEARN_MORE	Indicates when the user opens or exits out of the Learn More modal
AVF_ACCOUNT_VERIFY	Indicates when the user opens, submits, or closes the verification modal for a specific account
AVF_SUCCESS	Indicates when the user opens or continues past the verification success screen
AVF_EMPTY_SUCCESS	Indicates when the user opens or continues past the success screen shown if there were no accounts that required verification
AVF_SKIP_ALL	Indicates when the user skips all account verifications
AVF_ERROR	Indicates when the user is displyed an error screen during account verification

API Reference

Entities

Accounts

Payments

Elements

Events

Supporting Endpoints

​Path Parameters

​Returns

​Auth Events

​Account Verification Events

Path Parameters

Returns

Auth Events

Account Verification Events