Get Reports by Consumer
GET {{baseUrl}}/decisioning/v1/consumers/{{consumerId}}/reports
Get a report that has been generated by calling one of the Generate Report
services.
The report's status field will contain inProgress
, failure
, or success
. If the status shows inProgress
, the client app should wait 20 seconds and then call this endpoint again.
Supported regions:
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
purpose | number |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Finicity-App-Key | string | ||
Accept | string | ||
Finicity-App-Token | string |
RESPONSES
status: OK
{"reports":[{"id":"u4hstnnak45g","consumerId":"0bf46322c167b562e6cbed9d40e19a4c","consumerSsn":"9999","requesterName":"Finicity Test API","requestId":"cjqm4wtdcn","constraints":{"accountIds":["5011648377","5011648378","5011648379"],"reportCustomFields":[{"label":"loanID","value":"123456","shown":true}],"showNsf":false,"fromDate":1607450357,"incomeStreamConfidenceMinimum":50},"type":"voi","status":"inProgress","createdDate":1607450357}]}