POST /cra/report/get
/cra/report/get retrieves a CRA Report for a user.
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 |
|---|---|---|---|
products[] |
Array | Yes |
The requested products and their versions, e.g. |
products[].version |
String | Yes |
The version of the product that was generated. |
products[].product |
String | Yes |
A list of products that an institution can support. All Items must be initialized with at least one product. The Balance product is always available and does not need to be specified during initialization. Valid values:
|
client_id |
String | No |
Your Plaid API |
consumer_report_permissible_purpose |
String | Yes |
Describes the reason you are generating a Consumer Report for this user. When calling
Valid values:
|
scope |
String | No |
Determines whose items are used. Valid values:
|
decision_stage |
String | Yes |
The stage in the lending lifecycle for which the report is being retrieved. Valid values:
|
secret |
String | No |
Your Plaid API |
user_id |
String | Yes |
A unique user identifier, created by |
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.