POST /sandbox/public_token/create

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 to generate a test account with custom data, or with Plaid's pre-populated Sandbox test accounts.

Servers

https://production.plaid.com
https://sandbox.plaid.com

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`user_token`	String	No	The user token associated with the User data is being requested for.
`client_id`	String	No	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.
`options`	Object	No	An optional set of options to be used when configuring the Item. If specified, must not be `null`.
`options.override_username`	String	No	Test username to use for the creation of the Sandbox Item. Default value is `user_good`. Default value: "user_good"
`options.transactions`	Object	No	An optional set of parameters corresponding to transactions options.
`options.transactions.days_requested`	Integer	No	The maximum number of days of transaction history to request for the Transactions product. Default value: 90
`options.transactions.start_date`	String	No	The earliest date for which to fetch transaction history. Dates should be formatted as YYYY-MM-DD.
`options.transactions.end_date`	String	No	The most recent date for which to fetch transaction history. Dates should be formatted as YYYY-MM-DD.
`options.income_verification`	Object	No	A set of parameters for income verification options. This field is required if `income_verification` is included in the `initial_products` array.
`options.income_verification.bank_income`	Object	No	Specifies options for Bank Income. This field is required if `income_verification` is included in the `initial_products` array and `bank` is specified in `income_source_types`.
`options.income_verification.bank_income.days_requested`	Integer	No	The number of days of data to request for the Bank Income product
`options.income_verification.income_source_types[]`	Array	No	The types of source income data that users will be permitted to share. Options include `bank` and `payroll`. Currently you can only specify one of these options.
`options.statements`	Object	No	An optional set of parameters corresponding to statements options.
`options.statements.start_date`	String	Yes	The earliest date for which to fetch statements history. Dates should be formatted as YYYY-MM-DD.
`options.statements.end_date`	String	Yes	The most recent date for which to fetch statements history. Dates should be formatted as YYYY-MM-DD.
`options.webhook`	String	No	Specify a webhook to associate with the new Item.
`options.override_password`	String	No	Test password to use for the creation of the Sandbox Item. Default value is `pass_good`. Default value: "pass_good"
`initial_products[]`	Array	Yes	The products to initially pull for the Item. May be any products that the specified `institution_id` supports. This array may not be empty.
`institution_id`	String	Yes	The ID of the institution the Item will be associated with
`secret`	String	No	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.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.