POST /cra/check_report/verification/pdf/get
The /cra/check_report/verification/pdf/get endpoint retrieves the most recent Consumer Report in PDF format, specifically formatted for Home Lending verification use cases. Before calling this endpoint, ensure that you've created a VOA report through Link or the /cra/check_report/create endpoint, and have received a CHECK_REPORT_READY or a USER_CHECK_REPORT_READY webhook.
The response to /cra/check_report/verification/pdf/get is the PDF binary data. The request_id is returned in the Plaid-Request-ID header.
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. This field is used only by customers with pre-existing integrations that already use the |
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 |
user_id |
String | No |
A unique user identifier, created by |
report_requested |
String | Yes |
The type of verification PDF report to fetch. Valid values:
|
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.