Get Report by Consumer and ID
GET {{baseUrl}}/decisioning/v3/consumers/{{consumerId}}/reports/{{reportId}}?purpose=99&onBehalfOf=Some entity
Get a report that has been generated by a previous call to one of the Generate Report services.
The report's status field contains inProgress
, failure
, or success
. If the status shows inProgress
, the client app should wait 20 seconds and then call this API again.
Supported regions: 
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
purpose | number | 2-digit code from Permissible Purpose Codes, specifying the reason for retrieving this report. Required for retrieving some reports. | |
onBehalfOf | string | (Required) The name of the entity you are retrieving the report on behalf of |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Finicity-App-Key | string | ||
Accept | string | ||
Finicity-App-Token | string |
RESPONSES
status: OK
{}