Get report status API
This endpoint fetches some basic info for a given report or basic info for all reports for a given borrower. The info returned includes the real-time report status.
#
Get report status Request
URL : GET /report?report_id={report_id} OR GET /report?borrower_id={borrower_id}
Name | Type | Required | Allowed Values | Length | Description |
---|---|---|---|---|---|
report_id | String | No | 64 | Report ID to be queried | |
borrower_id | String | No | 64 | Borrower ID whose reports are to be fetched |
#
Get report status ResponseReturns array of reports matching the condition
Name | Type | Required | Allowed Values | Length | Description |
---|---|---|---|---|---|
borrower_id | String | Yes | 64 | Unique ID for each borrower | |
borrower_url | String | Yes | 64 | Borrower portal link for bank login | |
created_date | String | Yes | 64 | Report created date | |
report_id | String | Yes | 64 | Report id | |
report_status | String | Yes | See enumerations section of documentation | 64 | Status of the report |
#
Example JSON Request
Request Header:
{ "x-api-key": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", "Content-Type": "application/json"}
#
Example JSON Response
[ { "borrower_id": "738315", "borrower_url": "https://dev-banklogin.app/X5RAZO", "created_date": "2021-10-07 14:22:38.507042", "report_id": "X5RAZO", "report_status": "EMPTY" }]