Plaid Developer Portal
Plaid
HomeSDKsAPI ReferenceContext Plugin
Sandbox

sandboxItemSetVerificationStatus

POST
/sandbox/item/set_verification_status

The /sandbox/item/set_verification_status endpoint can be used to change the verification status of an Item in in the Sandbox in order to simulate the Automated Micro-deposit flow.

Note that not all Plaid developer accounts are enabled for micro-deposit based verification by default. Your account must be enabled for this feature in order to test it in Sandbox. To enable this features or check your status, contact your account manager or submit a product access Support ticket.

For more information on testing Automated Micro-deposits in Sandbox, see Auth full coverage testing.

Authorization

PLAID-CLIENT-ID PLAID-SECRET Plaid-Version
PLAID-CLIENT-ID<token>

In: header

PLAID-SECRET<token>

In: header

Plaid-Version<token>

In: header

Request Body

application/json

SandboxItemSetVerificationStatusRequest defines the request schema for /sandbox/item/set_verification_status

client_id?string

Your Plaid API client_id. The client_id is required and may be provided either in the PLAID-CLIENT-ID header or as part of a request body.

secret?string

Your Plaid API secret. The secret is required and may be provided either in the PLAID-SECRET header or as part of a request body.

access_token*string

The access token associated with the Item data is being requested for.

account_id*string

The account_id of the account whose verification status is to be modified

verification_status*VerificationStatus1

The verification status to set the account to.

Value in

  • "automatically_verified"
  • "verification_expired"

Response Body

application/json

curl -X POST "https://example.com/sandbox/item/set_verification_status" \  -H "Content-Type: application/json" \  -d '{    "access_token": "string",    "account_id": "string",    "verification_status": "automatically_verified"  }'
{  "request_id": "1vwmF5TBQwiqfwP"}

paymentInitiationPaymentList POST

The `/payment_initiation/payment/list` endpoint can be used to retrieve all created payments. By default, the 10 most recent payments are returned. You can request more payments and paginate through the results using the optional `count` and `cursor` parameters.

sandboxPublicTokenCreate POST

Use the `/sandbox/public_token/create` endpoint to create a valid `public_token` for an arbitrary institution ID, initial products, and test credentials. The created `public_token` maps to a new Sandbox Item. You can then call `/item/public_token/exchange` to exchange the `public_token` for an `access_token` and perform all API actions. `/sandbox/public_token/create` can also be used with the [`user_custom` test username](https://plaid.com/docs/sandbox/user-custom) to generate a test account with custom data.