Get Bank Statement Status - Carbon Business API

Overview

Returns the status of the most recent bank statement request. Poll this after POST /v1/loans/:applicationId/bank-statement until the status is COMPLETED.

Request

Method: GET
URL: /v1/loans/:applicationId/bank-statement/status

Parameters

Name	In	Type	Required	Description
`x-carbon-key`	Header	`string`	Yes	API key for authentication.
`applicationId`	Path	`string`	Yes	Application ID.

Response

200 OK

{
  "status": "success",
  "message": "Bank statement status retrieved",
  "data": {
    "requestId": "stmt_abc123",
    "status": "COMPLETED"
  }
}

Error Responses

Status	Message	Cause
400	`Application not found`	Invalid `applicationId`
422	`Application has no loan ID`	Application not yet registered

Request Bank Statement Upload Loan Document

​Overview

​Request

​Parameters

​Response

​200 OK

​Error Responses