KlearStack API Documentation
  • 👋Welcome to KlearStack's API Documentation
  • Authentication and User Details
    • Get Access Token
    • Get Access Token From UserID
    • Get New Access Token Using Existing Refresh Token
    • Get User ID
  • Upload Documents
    • Upload A Single Document And Get Batch ID
    • Upload Multiple Documents In A Zip Folder And Get Batch Id
  • Fetch Documents
    • Get Extracted Results For Invoices In a Batch Id
    • Get Extracted Results For Invoices In Between Date Range
    • Get Extracted Results For Invoices In a Set
    • Get Results of Invoices Accessible By A Specific User
    • Get Results of Modified Invoices since the last pull
    • Get Results of Approved Invoices Using Date Filter
    • Get details of a Document
  • UPDATE DOCUMENTS
    • Update Document
    • Update Results of Approved Invoices with QuickBooks Enterprise Response
    • Approve or Reject a Document
    • Push Annotated Text for a Document to KlearStack
  • DOCUMENT IMAGES
    • Get Image of Document
  • PUSH API
    • PUSH API Structure
    • Retry Push API
  • DataSources
    • Create New Datasource
    • List of all Datasources
    • Get data of a Datasource
    • Append in Datasource
    • Update Record of a Datasource
    • Delete Record of a Datasource
    • Delete Datasource
  • Documents Set
    • Get Documents of a Set
    • Get Uploaded Status of Documents in a Document Set
    • Get Set Reference Numbers List
  • FIELDS SETTING
    • Update Field Mapping
Powered by GitBook
On this page

Welcome to KlearStack's API Documentation

KlearStack is a leading Document Intelligence SaaS platform. It leverages Artificial Intelligence to interpret, capture, validate, transform, and reconcile data from unstructured documents. This docum

In this documentation you can find the following,

  • Authentication

  • Supported API methods

  • Request types and URLs

  • Input parameters for each method

  • Responses for each method

API Endpoints Security: All API endpoints are protected and require an access token for access. To obtain an access token, perform a POST request to get_access_token, which returns an access_token and a refresh_token. The access token is valid for a short duration (15 minutes) and expires after this period. The refresh token, however, is valid for at least a day. To obtain a new access token, perform a POST request to getaccesstokenfromrefreshtoken, which will return a new access token with a reset expiration time.

POST Request Parameters: All API POST request parameters should be sent as "Form Data".

Request Through Postman: To access a secured endpoint through Postman, copy and paste the access token into the Authorization tab of the request as a Bearer Token.

Request in Python: Below is an example request format in Python: token = "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiYW"

token = "Bearer " + str(token) # mind the space

headers = {"Authorization": token}

requests.post(url, data=data, headers=headers)

Please note that the SSL verification must be turned off. For example,

  • In Python, disable SSL verification by passing the verify=False parameter.

  • In Postman, turn off SSL Certificate Verification.

NextGet Access Token

Last updated 10 months ago

👋