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://ninjafetch.com/api/v1/ibv/requests/{request id}

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

Header

Example

curl --location --request GET 'https://ninjafetch.com/api/v1/ibv/requests/IBV8781156D1C6256FADCEB' \
--header 'x-api-key: 3f8493dca05ffee1aa221fd93...'\
--header 'Accept: application/pdf'

Response

👍

Retrieve IBV Report - HTTP 200

The Client will receive the IBV Report.

Report Status

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": "IBV3B2BB0C30B0FB770E157",
 "ibv_report": "https://ninjafetch.com/api/v1/ibv/requests/IBV3B2BB0C30B0FB770E157",
 "ibv_report_status": "initiated",
 "message": "Check for results later",
 "ibv_connection_link": "https://ninjafetch.com/connect/438da2e3b1b321506c3cd4cbb4…"
}

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

Example

{
 "consumer_id": "12345",
 "product_request_id": "IBVCE90DDCCED4A0F0E5217",
 "ibv_report": "https://ninjafetch.com/api/v1/ibv/requests/IBVCE90DDCCED4A0F0E5217",
 "ibv_report_status": "complete",
 "event": "report_generated"
}

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

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