Get Auto Classification Result

Endpoint Name: URL/access/klearstack/getautoclassifyresult

Request type : POST

Authorization: Bearer token as header

Endpoint Details: The getautoclassifyresult endpoint will be used to fetch the results of auto classification for the document.

Method	URL
POST	URL/access/klearstack/getautoclassifyresult

Request Body

Params	Values	Required	Description
company_name	string	Yes	Name of the company for which the user is logging in
batch_id	string	Yes	Batch id received from 'autoclassify' api response

Shell (cURL)

• Request Body

curl --location "URL/access/klearstack/getautoclassifyresult" \
  --header "Authorization: Bearer your_token_here" \
  --form "company_name=Replace_Company_Name_Here" \
  --form "batch_id=Replace_batch_id_Here" \
  

Python

• Request Body

import requests

url = "URL/access/klearstack/getautoclassifyresult"

payload = {'company_name': 'Replace_Company_Name_Here',
'batch_id': 'Replace_batch_id_Here'}
files=[

]
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("batch_id","Replace_batch_id_Here")
  .build();
Request request = new Request.Builder()
  .url("URL/access/klearstack/getautoclassifyresult")
  .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');
let data = new FormData();
data.append('company_name', 'Replace_Company_Name_Here');
data.append('batch_id', 'Replace_batch_id_Here');

let config = {
  method: 'post',
  maxBodyLength: Infinity,
  url: 'URL/access/klearstack/getautoclassifyresult',
  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("batch_id", "Replace_batch_id_Here");

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/getautoclassifyresult");
xhr.setRequestHeader("Authorization", "Bearer your_token_here");

xhr.send(data);

API Response

Status code	Example Response
200	{ "_id": "6a2bc633acabc4ae71143", "status": "completed", "classification_result": { "pages": [ { "page_index": 1, "label": "Invoices" }, { "page_index": 2, "label": "PackingList" }, { "page_index": 3, "label": "PackingList" } ], "groups": [ { "label": "Invoices", "pages": [ 1 ], "_id": "6a2bc69632614c7c1c20b57c" }, { "label": "PackingList", "pages": [ 2, 3 ], "_id": "6a2bc6a532614c7c1c20b585" } ], "metadata": { "active_financial_classes": [], "from_company_metadata": [ "BolDocument", "PurchaseOrders", "Invoices", "Insurances", "PackingList", "BillofExchange", "IdCards", "DealerQuotation" ] } } }
400	{'status': 'fail', 'description': 'No results found for the provided batch_id'}
500	{'error': error}