SmartExtract JSON API

The SmartExtract JSON API can be used to extract data from financial documents in JSON format.

For Production environment:

Extract single data set from a document

POST https://api.clik.ai/smart-extract-api/api/account/v1/extraction/document

This API endpoint allows you to extract a single data set from a document. The endpoint uses basic authentication with api key and secret key as credentials. You can create an API key from the SmartExtract dashboard.

The authorization token used must be for an API Key with Data Extraction role applied to it.

Headers

Name	Type	Description
Authorization*	String	Basic <base64 encoded credentials>

Request Body

Name	Type	Description
assetType*	String	One of the Valid Asset Types
documentType*	String	One of the Valid Document Types
periodFrom	String	Date in YYYY-MM-DD fromat representing the start period for an operating statement. Required if documentType is a type of operating statement.
sheet	Number	Sheet number to extract data from ()valid for XLSX files). Sheet index starts from 1. Defaults to first sheet.
to	Number	Page number to which data should be extracted (valid for PADF files). Defaults to last page.
from	Number	Page number to start data extraction from (valid for PDF files). Page index starts from 1. Defaults to first page.
file*	String	File to extract data from encoded as a DataUrl
fileName*	String	Name of the file
periodTo	String	Date in YYYY-MM-DD fromat representing the end period for an operating statement. Required if documentType is a type of operating statement.

200: OK

{
    "taggingData": { /* Data passed in request */ },
    "data": { // Data extracted from the document
      "meta": { /* meta data object */ },
      "source" : { /* raw text data found parsed as a 2D data array */ },
      "extracted": { /* normalized extracted data */ } 
    }
}

401: Unauthorized

{
    "status": "error",
    "error": "Invalid credentials provided",
}

500: Internal Server Error

{
    "status": "error",
    "error": "Error: Data Extraction Failed",
    "message": "Oops! something went wrong."
}

Extract multiple data sets from a document

POST https://api.clik.ai/smart-extract-api/api/account/v1/extraction/document/multiple

This API endpoint allows you to extract a multiple data sets from a single document. The endpoint uses basic authentication with api key and secret key as credentials. You can create an API key from the SmartExtract dashboard.

The authorization token used must be for an API Key with Data Extraction role applied to it.

Request Body

Name	Type	Description
file*	String	File to extract data from encoded as a DataUrl
taggingData*	TaggingData[]	An array of tagging data objects representing each data set to extract
fileName*	String	Name of the file
taggingData[0]*	Object	Tagging data object representing a data set to extract
taggingData[0].periodTo	String	Date in YYYY-MM-DD fromat representing the end period for an operating statement. Required if documentType is a type of operating statement.
taggingData[0].periodFrom	String	Date in YYYY-MM-DD fromat representing the start period for an operating statement. Required if documentType is a type of operating statement.
taggingData[0].sheet	Number	Sheet number to extract data from ()valid for XLSX files). Sheet index starts from 1. Defaults to first sheet.
taggingData[0].to	Number	Page number to which data should be extracted (valid for PADF files). Defaults to last page.
taggingData[0].from	Number	Page number to start data extraction from (valid for PDF files). Page index starts from 1. Defaults to first page.
taggingData[0].documentType*	String	One of the Valid Document Types
taggingData[0].assetType*	String	One of the Valid Asset Types

200: OK

{
    "data": [
      {
        "taggingData": { /* Data passed in request */ },
        "data": { // Data extracted from the document
          "meta": { /* meta data object */ },
          "source" : { /* raw text data found parsed as a 2D data array */ },
          "extracted": { /* normalized extracted data */ } 
        }
      }
      // .. more datasets for each tagging data
    ]
}

401: Unauthorized

{
    "status": "error",
    "error": "Invalid credentials provided",
}

500: Internal Server Error

{
    "status": "error",
    "error": "Error: Data Extraction Failed",
    "message": "Oops! something went wrong."
}

For Staging environment:

Extract single data set from a document

POST https://api.clik.ai/smart-extract-stg-api/api/account/v1/extraction/document

This API endpoint allows you to extract a single data set from a document. The endpoint uses basic authentication with api key and secret key as credentials. You can create an API key from the SmartExtract dashboard.

The authorization token used must be for an API Key with Data Extraction role applied to it.

Headers

Name	Type	Description
Authorization*	String	Basic <base64 encoded credentials>

Request Body

Name	Type	Description
assetType*	String	One of the Valid Asset Types
documentType*	String	One of the Valid Document Types
periodFrom	String	Date in YYYY-MM-DD fromat representing the start period for an operating statement. Required if documentType is a type of operating statement.
sheet	Number	Sheet number to extract data from ()valid for XLSX files). Sheet index starts from 1. Defaults to first sheet.
to	Number	Page number to which data should be extracted (valid for PADF files). Defaults to last page.
from	Number	Page number to start data extraction from (valid for PDF files). Page index starts from 1. Defaults to first page.
file*	String	File to extract data from encoded as a DataUrl
fileName*	String	Name of the file
periodTo	String	Date in YYYY-MM-DD fromat representing the end period for an operating statement. Required if documentType is a type of operating statement.

200: OK

{
    "taggingData": { /* Data passed in request */ },
    "data": { // Data extracted from the document
      "meta": { /* meta data object */ },
      "source" : { /* raw text data found parsed as a 2D data array */ },
      "extracted": { /* normalized extracted data */ } 
    }
}

401: Unauthorized

{
    "status": "error",
    "error": "Invalid credentials provided",
}

500: Internal Server Error

{
    "status": "error",
    "error": "Error: Data Extraction Failed",
    "message": "Oops! something went wrong."
}

Extract multiple data sets from a document

POST https://api.clik.ai/smart-extract-stg-api/api/account/v1/extraction/document/multiple

This API endpoint allows you to extract a multiple data sets from a single document. The endpoint uses basic authentication with api key and secret key as credentials. You can create an API key from the SmartExtract dashboard.

The authorization token used must be for an API Key with Data Extraction role applied to it.

Request Body

Name	Type	Description
file*	String	File to extract data from encoded as a DataUrl
taggingData*	TaggingData[]	An array of tagging data objects representing each data set to extract
fileName*	String	Name of the file
taggingData[0]*	Object	Tagging data object representing a data set to extract
taggingData[0].periodTo	String	Date in YYYY-MM-DD fromat representing the end period for an operating statement. Required if documentType is a type of operating statement.
taggingData[0].periodFrom	String	Date in YYYY-MM-DD fromat representing the start period for an operating statement. Required if documentType is a type of operating statement.
taggingData[0].sheet	Number	Sheet number to extract data from ()valid for XLSX files). Sheet index starts from 1. Defaults to first sheet.
taggingData[0].to	Number	Page number to which data should be extracted (valid for PADF files). Defaults to last page.
taggingData[0].from	Number	Page number to start data extraction from (valid for PDF files). Page index starts from 1. Defaults to first page.
taggingData[0].documentType*	String	One of the Valid Document Types
taggingData[0].assetType*	String	One of the Valid Asset Types

200: OK

{
    "data": [
      {
        "taggingData": { /* Data passed in request */ },
        "data": { // Data extracted from the document
          "meta": { /* meta data object */ },
          "source" : { /* raw text data found parsed as a 2D data array */ },
          "extracted": { /* normalized extracted data */ } 
        }
      }
      // .. more datasets for each tagging data
    ]
}

401: Unauthorized

{
    "status": "error",
    "error": "Invalid credentials provided",
}

500: Internal Server Error

{
    "status": "error",
    "error": "Error: Data Extraction Failed",
    "message": "Oops! something went wrong."
}