Qodex.ai

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 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

KeyDatatypeRequiredDescription
purposenumber2-digit code from Permissible Purpose Codes, specifying the reason for retrieving this report.
onBehalfOfstring(Required) The name of the entity you are retrieving the report on behalf of

HEADERS

KeyDatatypeRequiredDescription
Finicity-App-Keystring
Acceptstring
Finicity-App-Tokenstring

RESPONSES

status: OK

{"id":"u4hstnnak45g","customerId":1005061234,"consumerId":"0bf46322c167b562e6cbed9d40e19a4c","consumerSsn":"9999","requesterName":"Finicity Test API","requestId":"cjqm4wtdcn","type":"voi","status":"inProgress","createdDate":1607450357,"constraints":{"accountIds":["5011648377","5011648378","5011648379"],"reportCustomFields":[{"label":"loanID","value":"123456","shown":true}],"showNsf":false,"fromDate":1607450357,"incomeStreamConfidenceMinimum":50},"customerType":"active","title":"Finicity Asset Ready Report (CRA)","startDate":1607450357,"endDate":1607450357,"days":230,"seasoned":true,"portfolioId":"y4zsgccj4xpw-6-port","consolidatedAvailableBalance":1929.57,"institutions":[{"id":4222,"name":"FinBank","urlHomeApp":"https://finbank.prod.fini.city/CCBankImageMFA/login.jsp","accounts":[{"id":"5011648377","number":"1111","ownerName":"JOHN DOE","ownerAddress":"924 GAINSVILLE HIGHWAY SUITE 130 BUFORD, GA 30518","name":"Checking","type":"checking","currency":"USD","availableBalance":501.24,"aggregationStatusCode":0,"balance":501.24,"balanceDate":1607450357,"averageMonthlyBalance":501.02,"transactions":[{"id":21284820852,"amount":22.21,"postedDate":1607450357,"description":"FINICITY INC PAYROLL","memo":"Finicity amount credit","normalizedPayee":"Finicity","institutionTransactionId":"100000000","category":"ATM Fee","type":"atm","payStatementMatchTypes":["DATE"],"bestRepresentation":"FINICITY INC PAYROLL","securityType":"Cash","symbol":"JPM","commission":0}],"asset":{"type":"checking","availableBalance":1000,"currentBalance":1000,"twoMonthAverage":-1865.96,"sixMonthAverage":-7616.01,"beginningBalance":-17795.6},"details":{"interestMarginBalance":-50000,"availableCashBalance":1500,"vestedBalance":300000,"currentLoanBalance":0,"availableBalanceAmount":1000},"incomeStream":{"id":"dens28i3vsch-voi1","name":"none","status":"ACTIVE","estimateInclusion":"HIGH","confidence":85,"cadence":{"startDate":1607450357,"stopDate":1607450357,"days":14},"netMonthly":[{"month":1607450357,"net":2004.77}],"netAnnual":110475.7,"projectedNetAnnual":0,"estimatedGrossAnnual":100000,"projectedGrossAnnual":151609,"averageMonthlyIncomeNet":9206.31,"transactions":[{"id":21284820852,"amount":22.21,"postedDate":1607450357,"description":"FINICITY INC PAYROLL","memo":"Finicity amount credit","normalizedPayee":"Finicity","institutionTransactionId":"100000000","category":"ATM Fee","type":"atm","payStatementMatchTypes":["DATE"],"bestRepresentation":"FINICITY INC PAYROLL","securityType":"Cash","symbol":"JPM","commission":0}]},"incomeStreams":[{"id":"dens28i3vsch-voi1","name":"none","status":"ACTIVE","estimateInclusion":"HIGH","confidence":85,"cadence":{"startDate":1607450357,"stopDate":1607450357,"days":14},"netMonthly":[{"month":1607450357,"net":2004.77}],"netAnnual":110475.7,"projectedNetAnnual":0,"estimatedGrossAnnual":100000,"projectedGrossAnnual":151609,"averageMonthlyIncomeNet":9206.31,"transactions":[{"id":21284820852,"amount":22.21,"postedDate":1607450357,"description":"FINICITY INC PAYROLL","memo":"Finicity amount credit","normalizedPayee":"Finicity","institutionTransactionId":"100000000","category":"ATM Fee","type":"atm","payStatementMatchTypes":["DATE"],"bestRepresentation":"FINICITY INC PAYROLL","securityType":"Cash","symbol":"JPM","commission":0}]}],"totNumberInsufficientFundsFeeDebitTxAccount":0,"totNumberInsufficientFundsFeeDebitTxOver2MonthsAccount":0,"totNumberInsufficientFundsFeeDebitTxOver6MonthsAccount":0,"totNumberDaysSinceMostRecentInsufficientFundsFeeDebitTxAccount":120}]}],"errors":[{"code":10001,"status":"401","title":"Connecting accounts error","level":"error","message":"Invalid authorization credentials","user_message":"The session has expired or is invalid","assetId":"097545c5-1c2a-4f20-a5ef-77f0820344c9-2018601178","accountId":"5011648377"}]}