POST /cra/check_report/verification/get
This endpoint allows you to retrieve verification reports for a user. To obtain a VoA or Employment Refresh report, you need to make sure that cra_base_report is included in the products parameter when calling /link/token/create or /cra/check_report/create.
You should call this endpoint after you've received a CHECK_REPORT_READY webhook, either after the Link session for the user or after calling /cra/check_report/create.
If the most recent consumer report for the user doesn’t have sufficient data to generate the report, or the consumer report has expired, you will receive an error indicating that you should create a new consumer report by calling /cra/check_report/create."
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 |
|---|---|---|---|
employment_refresh_options |
Object | No |
Defines configuration options for the Employment Refresh Report. |
employment_refresh_options.days_requested |
Integer | Yes |
The number of days of data to request for the report. This field is required if an Employment Refresh Report is requested. Maximum is 731. |
user_token |
String | No |
The user token associated with the User data is being requested for. |
client_id |
String | No |
Your Plaid API |
secret |
String | No |
Your Plaid API |
user_id |
String | No |
A unique ID generated by Plaid representing the end user. Typically this ID will come from the |
reports_requested[] |
Array | Yes |
Specifies which types of verification reports are expected in the response |
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.