POST /cra/check_report/lend_score/get
This endpoint allows you to retrieve the Lend Score report for your user. You should call this endpoint after you've received the 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 insights, 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.
If you did not initialize Link with the cra_lend_score product or call /cra/check_report/create with the cra_lend_score product, we will generate the insights when you call this endpoint. In this case, you may optionally provide parameters under options to configure which insights you want to receive.
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 |
options |
Object | No |
Defines configuration options to generate the Lend Score |
options.lend_score_version |
String | No |
The version of the Lend Score Valid values:
|
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.