POST /sandbox/fdx/consent/seed

/sandbox/fdx/consent/seed creates a test FDX consent grant (and a backing Item) for a data provider's customer in Sandbox, so the FDX Consent API endpoints can be exercised end-to-end without a live data provider connection.

customer_id is the data provider's identifier for the end user and application_id identifies the data recipient application the consent is granted to; both are required. Optionally provide consent_id (a UUIDv4) to control the seeded grant's identifier; one is generated when omitted. The seeded grant is returned by /fdx/consents and /fdx/consents/{consentId}, and can be revoked via /fdx/consents/{consentId}/revocation.

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
`customer_id`	String	Yes	The data provider's identifier for the end user to associate the seeded consent grant with.
`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.
`application_id`	String	Yes	This field will map to the application ID that is returned from `/item/application/list`, or provided to the institution in an oauth redirect.
`consent_id`	String	No	Optional UUIDv4 identifier for the seeded consent grant. If omitted, one is generated. Seeding fails if a grant with this identifier already exists.
`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.