2024-04-04
), the highly anticipated second version of Method’s API.
Over the past year, our team has been dedicated to gathering feedback and working closely with our clients to create an even more powerful and developer-friendly API.
This release is packed with new features and enhancements that build upon Method’s credential-less consumer permissioned financial network.
Expanded integrations with Visa/Mastercard power new features such as real-time credit card transaction notifications, and enabling 1-click checkout experiences for merchants.
This is in addition to our real-time financial institution liability updates, which have been significantly upgraded to provide better accuracy, expanded coverage, and reduced latency.
2024-04-04
.
During the transition phase, teams will be allowed to utilize any API version in tandem.
Note that once upgraded manually, it’s not possible to revert to older versions. Contact your Method CSM for more information on upgrade rollbacks.
Method-Version
to 2024-04-04
. See API Versioning for more information.2024-04-04
How are auth_sessions different in the new version of the API?
What are the new products in 2024-04-04?
POST /entities/{ent_id}/auth_session
GET /entities/{ent_id}/credit_score
verification
field in the Entity object.
POST /entities/{ent_id}/auth_session
is replaced by kba entity verification session.POST /entities/{ent_id}/auth_session
is replaced by byo_kyc entity verification session.individual.phone_verification_type
and individual.phone_verification_timestamp
via the create Entity request are replaced by byo_sms phone verification requirements.capabilities
, available_capabilities
, and pending_capabilities
in the Entity object to verify if an entity’s identity has been matched or if more PII is required.
verification.identity.verified
and verification.identity.matched
in the verification
field in the Entity object.verification
field in the Entity object returns the status of Identity Verification (verification.identity
) and Phone Verification (verification.phone
).method
key in the entity.verification
object enumerates the phone and identity verifications available for your entity.
byo_kyc
to skip KBA, and byo_sms
to skip phone verification.status
key in an entity will only transition to active
when all verification requirements have been completed.GET /entities/{ent_id}/sensitive
Name | Use-Case | Resource Doc |
---|---|---|
connect | On-Demand comprehensive view of an Entity’s outstanding liabilities. | Connect |
credit_score | On-Demand view of an Entity’s credit score. | Credit Scores |
identity | On-Demand retrieval of the full Identity (PII) for any Entity | Identities |
capabilities
, available_capabilities
, and pending_capabilities
in the Entity object to determine the capabilities an entity has access to.
These fields have been deprecated from the Entity object and removed in favor of:
products
(products available for this entity)restricted_products
(products not currently available, but can be made available)Name | Use-Case | Resource Doc |
---|---|---|
connect | Comprehensive view of an Entity’s outstanding liabilities and continuous near real-time updates on new liabilities. | Connect |
credit_score | Continuous near real-time updates on an Entity’s credit score. | Credit Scores |
corporation
during Create a Corporation entity.
c_corporation
, s_corporation
, llc
, partnership
, and sole_proprietorship
have been deprecated and removed in favor of corporation
individual.ssn
, and individual.ssn_4
verification
products
restricted_products
subscriptions
available_subscriptions
restricted_subscriptions
individual.phone_verification_type
, and individual.phone_verification_timestamp
have been deprecated and removed in favor of Entity Verification Sessionscapabilities
, available_capabilities
, and pending_capabilities
have been deprecated and removed in favor of Products, Subscriptions, and Entity Verification Sessions
verification
field in the Entity object returns the status of Identity Verification (verification.identity
) and Phone Verification (verification.phone
).products
array returns the products the entity has access to, replacing capabilities
.restricted_products
array returns the products the entity does not have access to, replacing pending_capabilities
.Fields removed from Entity
individual.phone_verification_type
individual.phone_verification_timestamp
capabilities
available_capabilities
pending_capabilities
Fields added to Entity
individual.ssn
individual.ssn_4
verification
products
restricted_products
subscriptions
available_subscriptions
restricted_subscriptions
2024-04-04
/entities/{ent_id}/auth_session
removed in favor of Connect/entities/{ent_id}/credit_score
removed in favor of Credit Scores/entities/{ent_id}/sensitive
removed in favor of Identities/entities/{ent_id}/refresh_capabilities
is no longer supported in 2024-04-04
/entities/{ent_id}/manual_auth_session
is no longer supported in 2024-04-04
/entities/{ent_id}/vehicles
is no longer supported in 2024-04-04
sync
endpoint by enabling push notifications directly from the financial institution.
As part of the 2024-04-04
release the Account object has been modified, and most Account data is now returned by an Update object. See Account object changes for more information.
/accounts/{acc_id}/syncs
has been deprecated and removed in favor of Create an Update/accounts/{acc_id}/sync_enrollment
or via your Method CSM has been deprecated and removed in favor of Updates and Subscriptionsdata_status
data_sync_type
data_last_successful_sync
data_status_error
data_source
data_updated_at
update.snapshot
subscription type. See Subscriptions for more information.account.liability.<liability_type>
) has been deprecated and removed in favor of an Update object and an expansion. See Account for more information.data_status
to determine real-time financial institution coverage has been deprecated and removed in favor of the products
array including updates
. See Updates for more information.direct
and monthly snapshot
updates.
direct
: Near real-time account update (balance, due dates, etc.) from the account’s financial institution (replaces a sync
).snapshot
: Monthly snapshot update (balance, due dates, etc.) from the account’s financial institution (replaces credit report-based updates).update
or update.snapshot
. See Subscriptions for more information.account.liability.<liability_type>
) has been deprecated and removed in favor of an Update object and an expansion. See Account for more information.snapshot
update and a direct
update (when available).auth_session
have been migrated with an Update object pre-populated.name
. Migrating to card brand will provide accurate names across any Visa / Mastercard card regardless of issuing bank.payoff_amount
and payoff_amount_term
fields within the auto_loan
Account type response. See Updates for more information on the Account object changes.connect
element.
auth
element has been deprecated and removed in favor of the connect
element. See Connect Overview for more information./transactions
has been deprecated and removed in favor of account-scoped transactions. See Transactions for more information.transaction:stream
capability has been deprecated and removed in favor of the transactions
product. See Products for more information./accounts/{acc_id}/verification
has been deprecated and removed in favor of:
micro_deposits
, plaid
, mx
, or teller
.auto_verify
.trusted_provisioner
will be auto-provisioned. Contact your Method CSM for more information.standard
Account Verification Session. See Update a Standard Verification for more information.pre_auth
Account Verification Session. See Update a Pre-auth Verification for more information.GET /accounts/{acc_id}/sensitive
is deprecated and removed in favor of Create a Sensitive.Name | Use-Case | Supported Types | Resource Doc |
---|---|---|---|
update | On-Demand real-time account update (balance, due dates, etc.) from the account’s financial institution | All liabilities | Updates |
balance | On-Demand real-time balance from the account’s financial institution | All liabilities | Balances |
card_brand | On-Demand retrieval of credit card metadata (Product / Brand Name, Art, etc.) directly from the card issuer | Credit Cards | Card Brand |
payoff | On-Demand retrieval of auto loan payoff (amount, per diem, etc.) from the account’s financial institution | Auto Loans | Payoffs |
payment | Next day electronic push payments to the account’s financial institution | All liabilities | Payments |
sensitive | On-Demand retrieval of underlying sensitive account information (PAN, CVV, account number) | All liabilities | Sensitive |
capabilities
, available_capabilities
, and pending_capabilities
in the Account object to determine the capabilities an account has access to.
These fields have been deprecated from the Account object and removed in favor of:products
(products available for this Entity)restricted_products
(products not currently available, but can be made available)Name | Use-Case | Supported Types | Resource Doc |
---|---|---|---|
transactions | Real-time transaction (authorization, purchases, etc.) notifications for credit card accounts | Credit Cards | Transactions |
update | Near real-time account update (balance, due dates, etc.) from the account’s financial institution | All liabilities | Updates |
update.snapshot | Monthly snapshot update (balance, due dates, etc.) from the account’s financial institution | All liabilities | Updates |
/accounts/{acc_id}/sync_enrollment
for enrollment in auto syncs. This has been deprecated and replaced with an Updates subscription. See Updates and Create a Subscription for more information.data_sync_type
has been removed from the Account endpoint. See Updates and List all Subscriptions for more information.expand
query param. See Expanding Resources for more information.
latest_verification_session
update
balance
card_brand
payoff
products
restricted_products
subscriptions
available_subscriptions
restricted_subscriptions
liability.name
liability.fingerprint
account.liability.<liability_type>
property has been deprecated and removed in favor of Updates
updates
field returns the ID of the latest update and can be expanded to return liability account data in-line using the expand
query param. See Expanding Resources for more information./accounts/{acc_id}/syncs
has been deprecated and removed in favor of Updates
liability.data_status
, liability.data_sync_type
, liability.data_sync_type
, liability.data_last_successful_sync
, liability.data_source
,
liability.data_updated_at
, liability.data_updated_at
, liability.data_status_error
capabilities
, available_capabilities
, and pending_capabilities
have been deprecated and removed in favor of Products, Subscriptions, and Account Verification Sessions
products
array returns the products the account has access to, replacing capabilities
.restricted_products
array returns the products the account does not have access to, replacing pending_capabilities
.liability.payment_status
) has been deprecated and removed in favor of Products
clearing
) and liability hash (liability.hash
) has been deprecated and removed in 2024-04-04
Fields removed from Account
liability.payment_status
liability.data_status
liability.data_sync_type
liability.data_last_successful_sync
liability.data_source
liability.data_updated_at
liability.data_status_error
liability._liability_type_
- where liability_type
is any of the Account Liability Types.liability.hash
clearing
capabilities
available_capabilities
pending_capabilities
Fields added to Account
liability.name
liability.fingerprint
latest_verification_session
update
balance
card_brand
payoff
products
restricted_products
subscriptions
available_subscriptions
restricted_subscriptions
/accounts/{acc_id}/syncs
removed in favor of Updates/accounts/{acc_id}/sync_enrollment
removed in favor of Updates and Subscriptions/accounts/{acc_id}/verification
removed in favor of Account Verification Sessions/accounts/{acc_id}/sensitive
removed in favor of Sensitive/accounts/{acc_id}/card
removed in favor of Card Brand, Sensitive and Credit Card Account Verification Sessions/accounts/{acc_id}/payment_history
is no longer supported in 2024-04-04
/accounts/{acc_id}/details
is no longer supported in 2024-04-04
/accounts/{acc_id}/bulk_sensitive
is no longer supported in 2024-04-04
/accounts/{acc_id}/bulk_sync
is no longer supported in 2024-04-04
/accounts/{acc_id}/match_vehicle
is no longer supported in 2024-04-04
/routing_numbers
is no longer supported in 2024-04-04
/bins
is no longer supported in 2024-04-04
expand
query parameter for expanding certain properties from an ID to their respective objects in-line in the response body.
Applicable to both Entities and Accounts, allowing expansion of fields such as connect
, credit_score
, update
, balance
, payoff
, sensitive
, transactions
, card_brand
, and latest_verification_session
.
See Expanding Resources for more information.