back  Back to APIs

Bank Statement Analyser - USA

{{el |capitalize:true}}

{{username ? 'subscribe' : 'start free trial'}}

Remaining API Counts:

{{(token.limit-token.counter) || '0' }}
Remaining API Count : {{(token.limit-token.counter) || '0' }}

API Overview

Any scenario of lending and financial assessment involves several months of bank statement records to be captured and analysed. Experts and underwriters rely on these nitty gritty analysis to ascertain the financial profile of any person or entity. Arya’s Bank Statement Analyser effectively reads transactions from almost any bank statement and converts that raw data into a comprehensive analytical report. Be it showcasing of important trends or rare anomalies, our analytical tool gives all the metrics important to support the provided bank statement.

try it out

( Click on the image to enlarge )

More than just the API

Explore the top features of Bank Statement Analyser

Categorization of credits and debits enhanced detection of transaction type

Anomaly detection
and
rules violations check

Supports different formats from major banks across multiple regions

Supports multiple
output type -
PDF, Excel or JSON

Top use cases of Bank Statement Analyzer API

Bank statement analyzer APIs provide a snapshot of a person's liabilities, recurring transactions, and monthly dues, which aids banks and financial institutions in determining how much money they may lend to borrowers. Bank statement analysis provides lenders with a clear image of how well the borrower is capable of repaying the amount borrowed, whether it is a corporation or an individual.

Read More

Try the API

Please drag and drop files or click to browse.

Select Output Report Type:

Drag and Drop

or Click to browse files

Please wait...

Samples to try

Check out the API results using samples provided below.



  View PDF

Download Sample Output : Excel  |   PDF

Your document is extracted successfully.

Report generated and downloaded successfully!

Documentation

POST

{{url}}/api/v1/bank-statement-analyser-us

API Token

  Regenerate

{{tokenDisplay}}  

Usage and Code Samples

curl --location --request POST '{{url}}/api/v1/bank-statement-analyser-us' \
--header 'token: < your private token >' \
--header 'content-type: application/json' \
--data-raw '{
	"doc_type":'pdf',
	"report_type":'pdf',
	"doc_base64": '< base64 string of document >',
	"req_id": '< req id string >',

}'
																						
OkHttpClient client = new OkHttpClient().newBuilder().build();
  MediaType mediaType = MediaType.parse("application/javascript");
  RequestBody body = RequestBody.create(mediaType, "{ "doc_type":'pdf', "report_type":'pdf', "doc_base64": '< base64 string of document >',"req_id": '< req id string >' ,
  }");
  Request request = new Request.Builder()
	.url("{{url}}/api/v1/bank-statement-analyser-us")
	.method("POST", body)
	.addHeader("token", "< your private token >")
	.addHeader("content-type", "application/json")
	.build();
  Response response = client.newCall(request).execute();
require "uri"
require "net/http"
url = URI("{{url}}/api/v1/bank-statement-analyser-us")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Post.new(url)
request["token"] = "< your private token >"
request["content-type"] = "application/json"
request.body = "{"doc_type":'pdf', "report_type":'pdf', "doc_base64": '< base64 string of document >',"req_id": < req id string > }"
response = https.request(request)
puts response.read_body
CURL *curl;
CURLcode res;
curl = curl_easy_init();
if(curl) {
  curl_easy_setopt(curl, CURLOPT_CUSTOMREQUEST, "POST");
  curl_easy_setopt(curl, CURLOPT_URL, "{{url}}/api/v1/bank-statement-analyser-us");
  curl_easy_setopt(curl, CURLOPT_FOLLOWLOCATION, 1L);
  curl_easy_setopt(curl, CURLOPT_DEFAULT_PROTOCOL, "https");
  struct curl_slist *headers = NULL;
  headers = curl_slist_append(headers, "token: < your private token >");
  headers = curl_slist_append(headers, "content-type: application/json");
  curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);
  const char *data = "{"doc_type":'pdf', "doc_base64": '< base64 string of document >',"req_id": < req id string > }";
  curl_easy_setopt(curl, CURLOPT_POSTFIELDS, data);
  res = curl_easy_perform(curl);
}
curl_easy_cleanup(curl);
																					
var request = require('request');
var options = {
  'method': 'POST',
  'url': '{{url}}/api/v1/bank-statement-analyser-us',
  'headers': {
	'token': '< your private token >',
	'content-type':'application/json'
  },
  body: '{"doc_type":"pdf", "doc_base64": "< base64 string of document >","req_id": < req id string > }'
	};
	request(options, function (error, response) {
	if (error) throw new Error(error);
console.log(response.body);
});
var client = new RestClient("{{url}}/api/v1/bank-statement-analyser-us");
client.Timeout = -1;
var request = new RestRequest(Method.POST);
request.AddHeader("token", "< your private token >");
request.AddHeader("content-type", "application/json");
var body = @"{" + "" +
@"    "doc_type": 'pdf'," + "" +
@"    "report_type": 'pdf'," + "" +
@"    "doc_base64": '< base64 string of document >'," + "" +
@"    "req_id": < req id string >" + "" +
@"  }";
request.AddParameter("application/json", body,  ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);
<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('{{url}}/api/v1/bank-statement-analyser-us');
$request->setMethod(HTTP_Request2::METHOD_POST);
$request->setConfig(array(
'follow_redirects' => TRUE
));
$request->setHeader(array(
  'token' => '< your private token >',
  'content-type' => 'application/json'
));
$request->setBody('{"doc_type":"pdf", "report_type":'pdf', "doc_base64": "< base64 string of document >","req_id": < req id string > }');
try {
  $response = $request->send();
  if ($response->getStatus() == 200) {
	echo $response->getBody();
  }
  else {
	echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
	$response->getReasonPhrase();
  }
}
catch(HTTP_Request2_Exception $e) {
  echo 'Error: ' . $e->getMessage();
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;
my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $body = WWW::SwaggerClient::Object::V1_lengthofstayprediction_body->new(); # V1_lengthofstayprediction_body | 
my $token = token_example; # String | 
eval { 
	my $result = $api_instance->apiV1LengthOfStayPredictionPost(body => $body, token => $token, content-type=>'application/json');
	print Dumper($result);
};
if ($@) {
	warn "Exception when calling DefaultApi->apiV1LengthOfStayPredictionPost: $@";
}
																				
import requests
url = "{{url}}/api/v1/bank-statement-analyser-us"
payload = {"doc_type":"pdf", "report_type":'pdf', "doc_base64": "< base64 string of document >", "req_id": < req id string >}
headers = {
  'token': '< your private token >',
  'content-type':'application/json'
}
response = requests.request("POST", url, json=payload, headers=headers)
print(response.text)
	

Request Parameters

Header parameters

Name Description
token
String

Body parameters

Name Description
body {
  "doc_type" : < string >,
  "req_id" : < string >,
  "report_type" : < string >,
  "doc_base64": < base64 encoded string >,
}

Response Parameters

Status: 200 - API Request Successful

Body parameters

Name Description
body {
  "req_id" : < string >,
  "success" : < boolean >,
  "error_message" : < string >,
  "data" : < base64 string of analysed statement >,
}

Field Details

Request Field Details

Fields Values/Description
doc_type “pdf”
req_id Unique request ID used for processing requests
report_type Output preference ( accepts string 'pdf' or 'json' or 'excel')
doc_base64 Base64 encoded string of the document

Response Field Details

Fields Values/Description
req_id Corresponding request id
success Flag if the request is processed successfully
error_message If success is False then: Error message
data Base64 string of analysed statement