Skip to main content
POST
Request Bank Statement

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

Request Body — Carbon Bank

Request Body — External Bank

Response

200 OK

Error Responses

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.