The account verification sessions endpoint

{
  "id": "avf_DjkdemgTQfqRD",
  "account_id": "acc_yVf3mkzbhz9tj",
  "status": "pending",
  "error": null,
  "type": "pre_auth",
  "pre_auth": {
    "exp_year": "xxxx",
    "exp_month": "xx",
    "exp_check": null,
    "cvv": null,
    "cvv_check": null,
    "billing_zip_code": "xxxxx",
    "billing_zip_code_check": null,
    "number": "xxxxxxxxxxxxxxxx",
    "pre_auth_check": null
  },
  "created_at": "2024-03-14T02:02:24.862Z",
  "updated_at": "2024-03-14T02:02:24.862Z"
}

The account verification manages required verification to enable products for ACH or Liability accounts.

For example, ACH Accounts require a verified AccountVerificationSession before they can be used as a source for Payments.

AccountVerificationSession Objects

string

Unique identifier for the AccountVerificationSession.

account_id

string

The ID of the associated Account.

status

enum

Status of the AccountVerificationSession.

Possible enum values

pending

The AccountVerificationSession is pending. For micro_deposits type, this state indicates that the micro-deposit transactions have not yet been sent. For all other types, this means that the verification session has been created but not yet updated with any data.

in_progress

The AccountVerificationSession is in progress. For micro_deposits type, this state indicates that the micro-deposit transactions have been sent and the session can be updated with the amounts to complete verification. This state is irrelevant for all other types.

verified

The AccountVerificationSession has been successfully verified.

failed

The AccountVerificationSession has failed verification based on the provided data. See error for details.

type

enum

The type of the AccountVerificationSession. See Verification Types.

micro_deposits

object | null

This object will be populated if the AccountVerificationSession is of type micro_deposits

Show properties

micro_deposits.amounts

number[]

The latest amounts that this AccountVerificationSession was updated with.

plaid

object | null

This object will be populated if the AccountVerificationSession is of type plaid.

Show properties

plaid.balances

object[]

The raw balance data received from Plaid. See account balances.

plaid.transactions

object[]

The raw transaction data received from Plaid. See account transactions.

object | null

This object will be populated if the AccountVerificationSession is of type mx.

Show properties

mx.account

object

The raw account data received from MX. See account balances.

mx.transactions

object[]

The list of the raw transaction data received from MX. See account transactions.

teller

object | null

This object will be populated if the AccountVerificationSession is of type teller.

Show properties

teller.account

object

The raw balance data received from Teller. See account balances.

teller.transactions

object[]

The list of the raw transaction data received from MX. See account transactions.

auto_verify

object | null

This object will be populated if the AccountVerificationSession is of type auto_verify.

trusted_provisioner

object | null

This object will be populated if the AccountVerificationSession is of type trusted_provisioner.

standard

object | null

This object will be populated if the AccountVerificationSession is of type standard.

Show properties

standard.number

string | null

The masked card number. If this is null, that indicates that the number needs to be provided for completing verification.

pre_auth

object | null

This object will be populated if the AccountVerificationSession is of type pre_auth.

Show properties

pre_auth.number

string | null

The masked card number. If this is null, that indicates that the number needs to be provided for completing verification.

pre_auth.exp_month

string | null

The masked card expiration month. If this is null, that indicates that the expiration month needs to be provided for completing verification.

pre_auth.exp_year

string | null

The masked card expiration year. If this is null, that indicates that the expiration year needs to be provided for completing verification.

pre_auth.exp_check

enum

The card expiration verification check result. If this is fail, that indicates that the card could not be verified given the expiration data, and the AccountVerificationSession needs to be updated with the correct expiration data to complete verification.

Possible enum values

pass

The verification check passed.

fail

The verification check failed.

unavailable

The verification check is unavailable due to a restriction by the card networks.

pre_auth.cvv

string | null

The masked card cvv. If this is null, that indicates that the cvv needs to be provided for completing verification.

pre_auth.cvv_check

enum

The card cvv verification check result. If this is fail, that indicates that the card could not be verified given the cvv, and the AccountVerificationSession needs to be updated with the correct cvv to complete verification.

Possible enum values

pass

The verification check passed.

fail

The verification check failed.

unavailable

The verification check is unavailable due to a restriction by the card networks.

pre_auth.pre_auth_check

enum

The pre_auth verification check result.

Possible enum values

pass

The verification check passed.

fail

The verification check failed.

unavailable

The verification check is unavailable due to a restriction by the card networks.

network

object | null

This object will be populated if the AccountVerificationSession is of type network.

Show properties

network.number

string | null

The masked card number. If this is null, that indicates that the number needs to be provided for completing verification.

network.exp_month

string | null

The masked card expiration month. If this is null, that indicates that the expiration month needs to be provided for completing verification.

network.exp_year

string | null

The masked card expiration year. If this is null, that indicates that the expiration year needs to be provided for completing verification.

network.exp_check

enum

Possible enum values

pass

The verification check passed.

fail

The verification check failed.

unavailable

The verification check is unavailable due to a restriction by the card networks.

network.cvv

string | null

The masked card cvv. If this is null, that indicates that the cvv needs to be provided for completing verification.

network.cvv_check

enum

Possible enum values

pass

The verification check passed.

fail

The verification check failed.

unavailable

The verification check is unavailable due to a restriction by the card networks.

network.network_check

enum

The network verification check result.

Possible enum values

pass

The verification check passed.

fail

The verification check failed.

unavailable

The verification check is unavailable due to a restriction by the card networks.

error

object | null

An object representing an error that occurred while processing this AccountVerificationSession. See AccountVerificationSession errors.

created_at

string

Timestamp of when the AccountVerificationSession was created.

updated_at

string

Timestamp of when the AccountVerificationSession was last updated.

Verification Types

Type	Description
`micro_deposits`	To verify a checking or savings account, two small amounts between $0.20 - $0.99 of money will be deposited into the ACH account, once received (within 1 - 3 business days) the account holder will then verify the amounts (in cents) that were deposited.
`plaid`	The ACH Account is verified by providing balance and transaction data from Plaid.
`teller`	The ACH Account is verified by providing balance and transaction data from Teller.
`mx`	The ACH Account is verified by providing account and transaction data from MX.
`trusted_provisioner`	The ACH Account is auto verified based on whitelisted routing numbers for the team.
`auto_verify`	The ACH account is verified automatically upon creation, if this configuration is enabled for the team.
`standard`	The Liability Account is verified in real-time by the isuser by providing the full account/card number.
`pre_auth`	The Credit Card Account is verified in real-time by the issuer and card networks by providing the full card number, expiration date, and cvv.
`network`	The Credit Card Account is verified in real-time by the issuer and card networks by providing the full card number, expiration date, and cvv.

Webhook Payload

The Webhook payload will contain the following information:

{
  "id": "string",
  "type": "account_verification_session.create" | "account_verification_session.update",
  "path": "/accounts/<acc_id>/verification_sessions/<avf_id>",
}

{
  "id": "avf_DjkdemgTQfqRD",
  "account_id": "acc_yVf3mkzbhz9tj",
  "status": "pending",
  "error": null,
  "type": "pre_auth",
  "pre_auth": {
    "exp_year": "xxxx",
    "exp_month": "xx",
    "exp_check": null,
    "cvv": null,
    "cvv_check": null,
    "billing_zip_code": "xxxxx",
    "billing_zip_code_check": null,
    "number": "xxxxxxxxxxxxxxxx",
    "pre_auth_check": null
  },
  "created_at": "2024-03-14T02:02:24.862Z",
  "updated_at": "2024-03-14T02:02:24.862Z"
}

Delete a Subscription Create a Verification

{
  "id": "avf_DjkdemgTQfqRD",
  "account_id": "acc_yVf3mkzbhz9tj",
  "status": "pending",
  "error": null,
  "type": "pre_auth",
  "pre_auth": {
    "exp_year": "xxxx",
    "exp_month": "xx",
    "exp_check": null,
    "cvv": null,
    "cvv_check": null,
    "billing_zip_code": "xxxxx",
    "billing_zip_code_check": null,
    "number": "xxxxxxxxxxxxxxxx",
    "pre_auth_check": null
  },
  "created_at": "2024-03-14T02:02:24.862Z",
  "updated_at": "2024-03-14T02:02:24.862Z"
}

API Reference

Entities

Accounts

Payments

Elements

Events

Supporting Endpoints

The account verification sessions endpoint

AccountVerificationSession Objects

Verification Types

Webhook Payload

API Reference

Entities

Accounts

Payments

Elements

Events

Supporting Endpoints

​AccountVerificationSession Objects

​Verification Types

​Webhook Payload

AccountVerificationSession Objects

Verification Types

Webhook Payload