POST /cra/check_report/pdf/get
/cra/check_report/pdf/get
retrieves the most recent Consumer Report in PDF format. By default, the most recent Base Report (if it exists) for the user will be returned. To request that the most recent Income Insights report be included in the PDF as well, use the add-ons
field.
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. |
add_ons[] |
Array | No |
Use this field to include other reports in the PDF. |
client_id |
String | No |
Your Plaid API |
third_party_user_token |
String | No |
The third-party user token associated with the requested User data. |
secret |
String | No |
Your Plaid API |
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.