POST /cra/credit_profile/report/get
/cra/credit_profile/report/get retrieves a credit profile 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 |
|---|---|---|---|
report_type |
String | Yes |
The product type for the credit profile report request. Valid values:
|
client_id |
String | No |
Your Plaid API |
inquiry_type |
String | Yes |
The inquiry type of credit profile report. Valid values:
|
consumer_report_permissible_purpose |
String | Yes |
Describes the reason you are generating a Consumer Report for this user. When calling
Valid values:
|
version |
String | Yes |
The version of the credit profile report to retrieve. Valid values:
|
client_report_id |
String | Yes |
Client-generated identifier, which can be used by lenders to track loan applications. |
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.