Guides
Start typing to search…

Retrieve IBV Report

When the platform has processed the request the API will return the IBV report. If the IBV report request is still in progress the API will return the current status of the process.

GET

Request

Clients may retrieve IBV reports with a GET to:
https://api.edgescore.com/api/v2/ibv/requests/{product_request_id}

Clients may request IBV reports in PDF format. Only IBV reports in the ‘complete’ status have the PDF version available.

Header

NameDescriptionExampleRequired
x-api-keyA unique API Key for the environment19YYgyZecTaSs2N0gjlq32Vh6DYes
AcceptIBV reports formatapplication/pdfYes
curl --location --request GET 'https://api.edgescore.com/api/v2/ibv/requests/IBV32892389' \
--header 'x-api-key: 19YYgyZecTaSs2N0gjlq32Vh6D'\
--header 'Accept: application/pdf'

Responses

👍

Retrieve IBV Report - HTTP 200

The Client will receive the IBV Report.


Report Status

StatusDescription
initiatedRequest has been received.
reconnect_requiredThe bank connection did not work due to incorrect credentials or incomplete MFA process. The EDGE platform will not take further actions until the consumer reconnects the bank.
ibv_data_acquire_failedFailed to pull data from the data aggregator. This may happen after the user successfully connects the bank account. The EDGE platform will not take further actions.
ibv_data_acquiredSuccessfully downloaded the IBV data. The EDGE platform is generating features and scores. This is a temporary state. The status will eventually change to “complete” or “generation_failed”.
generation_failedFailed to create features and scores. The EDGE platform will not take further actions.
completeReport was created successfully. The EDGE platform will not take further actions.
Example
{
 "product_request_id": "IBV32892389",
 "client_id": "3011",
 "consumer_id": "CN328923498",
 "reference_date": "2021-08-15",
 "created_at": "2021-09-01 15:21:53",
 "ibv_report_status": "complete",
   "accounts": [
     {
       "provider_name": "PNC Bank",
       "account_name": "TOTAL CHECKING-1234",
       "account_type": "CHECKING",
       "routing_number": "071921891",
       "account_number": "32892348943",
       "owner_name": "John Smith",
       "balance": 123.45,
       ... # other custom fields
       "items":[
         {
           "item_code": "ibv_validate_metrics",
           "item_name": "Validate 2",
           "item_version": "3.0.1",
           "data": {
             "ne_income_feature_1": ...,
             ... # multiple features
           },
           ... # multiple items
         },
       ]
     },
     ... # multiple accounts       
   ]
 }
}

🚧

IBV Report Pending - HTTP 202

The Client will receive the processing status when the requested IBV report is not yet ready.

Example
{
 "product_request_id": "IBV23328923489",
 "ibv_report": "https://api.edgescore.com/api/v2/ibv/requests/IBV23328923489",
 "ibv_report_status": "initiated",
 "message": "Check for results later",
 "ibv_connection_link": "https://c2.edgescore.com/9a3db0b97e"
}

Handling Timeouts

When the Client recognizes a timeout it may make any number of retry attempts, which should eventually lead to one of the following responses:

  • IBV Report - HTTP 200
  • IBV Report Pending - HTTP 202

Webhooks

The EDGE platform can initiate a Webhooks callback when the requested report is generated and ready for retrieval, or when the report generation fails. Two events, “report_generated” and “report_generation_failed” are supported. The response payload includes the following fields:

Field NameDescription
consumer_idA unique identifier provided by the client for each consumer
product_request_idA unique identifier of the IBV report
ibv_reportURL for retrieval of the IBV report
ibv_report_status“complete” or “generation_failed”
eventName of the system event that triggered the Webhooks. Supported events are “report_generated” and “report_generation_failed”
Example
{
 "consumer_id": "12345",
 "product_request_id": "IBVCE90DDCCED4A0F0E5217",
 "ibv_report": "https://api.edgescore.com/api/v2/ibv/requests/IBVCE90DDCCED4A0F0E5217",
 "ibv_report_status": "complete",
 "event": "report_generated"
}

{
 "consumer_id": "67890",
 "product_request_id": "IBV2529C60A40F2B651639B",
 "ibv_report": "https://api.edgescore.com/api/v2/ibv/requests/IBV2529C60A40F2B651639B",
 "ibv_report_status": "generation_failed",
 "event": "report_generation_failed"
}

Please provide your Webhooks endpoint to the EDGE Customer Success Team if you would like to use this feature.

Updated 19 days ago