Upload A Single Document And Get Batch ID

EndPoint Name: processdocument

Request type : POST

Authorization: Bearer token as header

EndPoint Details: This API is used to get the batch id for a single invoice (image/pdf) uploaded by the user.

Request Type

Method	URL
POST	URL/access/klearstack/processdocument

Request Body

Parameters	Values	Required	Description
company_name	string	Yes	Name of the company.
username	string	Yes	Username for a particular user of a company.
password	string	Yes	Password for a particular user of a company.
processing_pref	string	Yes	Either “Speed” or “Accuracy” (It’s not case sensitive)
invoice_type	string	Yes	“B2B” for invoices commissioned by a business to another business directly. “B2C” for invoices commissioned by a business to a consumer. “B2C” for Insurances.
file	binary	Yes	Single image (pdf/jpeg/png) or native pdf file.
source_name	string	No	API
priority_flag	string	No	true or false
userid	string	No	User ID of the user.
user_role	string	No	role of the user.
document_type	string	No	Type of document to be processed - “Invoices”,“Receipts”,“PurchaseOrders”,“NACH”,“LoanAgreement” or “Insurances”.
application_no	string	No	An identifier for correlating multiple documents. Example : Nach and FacilityAgreement should have same application_no.
additional_params	string	No	For LoanAgreement : { "borrower_name":"xyz", "co_borrower":"abc", "loan_amount_in_figures":250000, "tenure":5, "rate_of_interest":8.5, "partner_name":"abc limited" } For Nach : { "account_number":200382193 }
account_id	string	No	Account_id number
set_reference_number	string	No	For adding document in Existing Set
set_name	string	No	For assigning Name to document set, it cannot be updated after set is created
create_new_set	string	No	Flag needs to be True for creating new set, the param if set to True will create a new set with the given set_name and assign new set_reference_number to the document.

Shell

• Request Body

curl --location "URL/access/klearstack/processdocument" \
  -H "Authorization: Bearer your_token_here" \
  --form "company_name=Replace_Company_Name_Here" \
  --form "username=Replace_User_Name_Here" \
  --form "password=Replace_Password_Here" \
  --form "user_id=Replace_User_ID_Here" \
  --form "user_role=Your_Role" \
  --form "processing_pref=Speed" \
  --form "document_type=Invoices" \
  --form "invoice_type=B2B" \
  --form "application_no=12345" \
  --form "additional_params={\"borrower_name\":\"xyz\"}" \
  --form "source_name=API" \
  --form "priority_flag=true" \
  --form "account_id=123456" \
  --form "set_reference_number=Ref123" \
  --form "set_name=MySet" \
  --form "create_new_set=true" \
  --form "file=@\"C:/Users/user/Downloads/xyz.pdf\""

Python (Requests)

• Request Body

import requests

url = "URL/access/klearstack/processdocument"

payload = {'company_name': 'Replace_Company_Name_Here',
'username': 'Replace_User_Name_Here',
'password': 'Replace_Password_Here',
'user_id': 'Replace_User_ID_Here',
'user_role': 'Your_Role',
'processing_pref': 'Speed',
'document_type': 'Invoices',
'invoice_type': 'B2B',
'application_no': '12345',
'additional_params': '{"borrower_name":"xyz"}',
'source_name': 'API',
'priority_flag': 'true',
'account_id': '123456',
'set_reference_number': 'Ref123',
'set_name': 'MySet',
'create_new_set': 'true'}
files=[
  ('file',('xyz.pdf',open('C:/Users/user/Downloads/xyz.pdf','rb'),'application/pdf'))
]
headers = {
  'Authorization': 'Bearer your_token_here'
}

response = requests.request("POST", url, headers=headers, data=payload, files=files)

print(response.text)
  

Java (OkHttp)

• Request Body

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();

MediaType mediaType = MediaType.parse("text/plain");

RequestBody body = new MultipartBody.Builder().setType(MultipartBody.FORM)
  .addFormDataPart("company_name", "Replace_Company_Name_Here")
  .addFormDataPart("username", "Replace_User_Name_Here")
  .addFormDataPart("password", "Replace_Password_Here")
  .addFormDataPart("user_id", "Replace_User_ID_Here")
  .addFormDataPart("user_role", "Your_Role")
  .addFormDataPart("processing_pref", "Speed")
  .addFormDataPart("document_type", "Invoices")
  .addFormDataPart("invoice_type", "B2B")
  .addFormDataPart("application_no", "12345")
  .addFormDataPart("additional_params", "{\"borrower_name\":\"xyz\"}")
  .addFormDataPart("source_name", "API")
  .addFormDataPart("priority_flag", "true")
  .addFormDataPart("account_id", "123456")
  .addFormDataPart("set_reference_number", "Ref123")
  .addFormDataPart("set_name", "MySet")
  .addFormDataPart("create_new_set", "true")
  .addFormDataPart("file", "C:/Users/user/Downloads/xyz.pdf",
    RequestBody.create(MediaType.parse("application/octet-stream"),
      new File("C:/Users/user/Downloads/xyz.pdf")))
  .build();

Request request = new Request.Builder()
  .url("URL/access/klearstack/processdocument")
  .method("POST", body)
  .addHeader("Authorization", "Bearer your_token_here")
  .build();

Response response = client.newCall(request).execute();

Node.js (Axios)

• Request Body

const axios = require('axios');
const FormData = require('form-data');
const fs = require('fs');

let data = new FormData();
data.append('company_name', 'Replace_Company_Name_Here');
data.append('username', 'Replace_User_Name_Here');
data.append('password', 'Replace_Password_Here');
data.append('user_id', 'Replace_User_ID_Here');
data.append('user_role', 'Your_Role');
data.append('processing_pref', 'Speed');
data.append('document_type', 'Invoices');
data.append('invoice_type', 'B2B');
data.append('application_no', '12345');
data.append('additional_params', '{"borrower_name":"xyz"}');
data.append('source_name', 'API');
data.append('priority_flag', 'true');
data.append('account_id', '123456');
data.append('set_reference_number', 'Ref123');
data.append('set_name', 'MySet');
data.append('create_new_set', 'true');
data.append('file', fs.createReadStream('C:/Users/user/Downloads/xyz.pdf'));

let config = {
  method: 'post',
  maxBodyLength: Infinity,
  url: 'URL/access/klearstack/processdocument',
  headers: {
    'Authorization': 'Bearer your_token_here',
    ...data.getHeaders()
  },
  data: data
};

axios.request(config)
  .then((response) => {
    console.log(JSON.stringify(response.data));
  })
  .catch((error) => {
    console.log(error);
  });

JavaScript (XHR)

• Request Body

// WARNING: For POST requests, body is set to null by browsers.

var data = new FormData();
data.append("company_name", "Replace_Company_Name_Here");
data.append("username", "Replace_User_Name_Here");
data.append("password", "Replace_Password_Here");
data.append("user_id", "Replace_User_ID_Here");
data.append("user_role", "Your_Role");
data.append("processing_pref", "Speed");
data.append("document_type", "Invoices");
data.append("invoice_type", "B2B");
data.append("application_no", "12345");
data.append("additional_params", "{\"borrower_name\":\"xyz\"}");
data.append("source_name", "API");
data.append("priority_flag", "true");
data.append("account_id", "123456");
data.append("set_reference_number", "Ref123");
data.append("set_name", "MySet");
data.append("create_new_set", "true");
data.append("file", fileInput.files[0], "C:/Users/user/Downloads/xyz.pdf");

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function() {
  if(this.readyState === 4) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "URL/access/klearstack/processdocument");
xhr.setRequestHeader("Authorization", "Bearer your_token_here");

xhr.send(data);

API Response

Status	Example Response
200	{ "OCR_ref_no": "faaf38a9-2cc7-4b2b-89f2-182252d1638c", "status": "pass", "description": "", "application_no": "", "release_version": “7.8.9”, "set_reference_number":"12345" }
400	{"error": "Please provide username."}
400	{"error": "Please provide password."}