Skip to main content
POST
/
v1
/
loans
/
{applicationId}
/
bank-statement
Request Bank Statement
curl --request POST \
  --url https://carbonapistagingsecure.getcarbon.co/baas/api/v1/loans/{applicationId}/bank-statement \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --header 'x-carbon-key: <x-carbon-key>' \
  --data '
{
  "account_number": "0123456789",
  "sort_code": "058",
  "num_months": 6
}
'
{
  "status": "success",
  "message": "Bank statement request initiated"
}

​
Overview

Requests a bank statement from the customer’s bank. For Carbon bank accounts use sort code 565 — no account number or phone required. For all other banks, provide the account number and customer phone.

​
Request

Method: POST
URL: /v1/loans/:applicationId/bank-statement

​
Parameters

NameInTypeRequiredDescription
x-carbon-keyHeaderstringYesAPI key for authentication.
applicationIdPathstringYesApplication ID.

​
Request Body — Carbon Bank

{
  "sort_code": "565"
}

​
Request Body — External Bank

{
  "sort_code": "058",
  "account_number": "0123456789",
  "phone": "08012345678"
}
FieldRequiredDescription
sort_codeYes3–6 digit bank sort code. Use 565 for Carbon.
account_numberYes (external bank)Exactly 10 digits.
phoneYes (external bank)Valid Nigerian phone number.

​
Response

​
200 OK

{
  "status": "success",
  "message": "Bank statement requested",
  "data": {
    "requestId": "stmt_abc123",
    "status": "PENDING"
  }
}

​
Error Responses

StatusMessageCause
400sort_code is requiredMissing sort code
400sort_code must be 3–6 digitsInvalid format
400account_number must be exactly 10 digitsNon-Carbon bank, missing or invalid account
400phone must be a valid Nigerian numberNon-Carbon bank, missing or invalid phone
400Application not foundInvalid applicationId
422Application has no loan IDApplication not yet registered

Authorizations

​
apikey
string
header
required

Provide your API key in the 'apikey' header.

Headers

​
x-carbon-key
string
required

Path Parameters

​
applicationId
string
required

Body

application/json

Provide the required values for the request body.

​
account_number
string
required
Example:

"0123456789"

​
sort_code
string
required
Example:

"058"

​
num_months
number
Example:

6

Response

200 - application/json

Successful response

The response is of type object.