ABBYY Authenticate an Element Instance

You can authenticate with ABBYY to create your own instance of the ABBYY element through the UI or through APIs. Once authenticated, you can use the element instance to access the different functionality offered by the ABBYY platform.

Authenticate Through the UI

Use the UI to authenticate with ABBYY and create an element instance. You will need your Application Name and Application Password that you identified in API Provider Setup.

To authenticate an element instance, complete the steps described in Authenticate an Element Instance (UI). In addition to the base authentication parameters, you must also include:

Authenticate Through API

Step 1. Call the /instances API

  • HTTP Headers: Authorization- User , Organization
  • HTTP Verb: POST
  • Request URL: /instances
  • Request Body: Required – see below
  • Query Parameters: none

Description: We return an element token upon successful execution of this API. This token needs to be retained by the application for all subsequent requests involving this element instance.

A sample request illustrating the /instances API is shown below.

HTTP Headers:


This instance.json file must be included with your instance request. Please fill your information to provision. The “key” into Cloud Elements ABBYY is "abbyy". This will need to be entered in the “key” field below depending on which element you wish to instantiate.

  "element" : {
      "key" : "abbyy"
    "configuration" : {
      "username": "<INSERT_ABBYY_APPLICATION_NAME>",
  "tags": [

Here is an example cURL command to create an instance using /instances API.

Example Request:

curl -X POST
-H 'Authorization: User <INSERT_USER_SECRET>, Organization <INSERT_ORGANIZATION_SECRET>'
-H 'Content-Type: application/json'
-d @instance.json

If the user does not specify a required config entry, an error will result notifying her of which entries she is missing.

Below is a successful JSON response:

  "id": 12,
  "name": "Test",
  "token": "cuED0/DezalhhzK2OtO6kMP7NvPnMyNcRDZc=",
  "element": {
    "id": 260,
    "name": "ABBYY",
    "key": "abbyy",
    "description": "Add ABBYY instance to generate OCR text for your files. You will need your ABBYY account details to create an instance",
    "image": "",
    "active": false,
    "deleted": false,
    "typeOauth": false,
    "trialAccount": false,
    "resources": []
  "provisionInteractions": [],
  "valid": true,
  "disabled": false,
  "maxCacheSize": 0,
  "cacheTimeToLive": 0,
  "configuration": {
    "base.url": "",
    "": null,
    "bulk.query.field_name": "",
    "pagination.max": "100",
    "event.vendor.type": "webhooks",
    "bulk.query.operator": ">=",
    "bulk.query.date_mask": "key",
    "password": "ABBYY_PASSWORD",
    "event.notification.instance.finder": null,
    "event.poller.refresh_interval": "15",
    "pagination.type": null,
    "event.notification.callback.url": null,
    "event.poller.configuration": "{}",
    "username": "ABBYY_APP_NAME",
    "event.notification.enabled": "false"
  "eventsEnabled": false,
  "traceLoggingEnabled": false,
  "cachingEnabled": false

Note: Make sure you have straight quotes in your JSON files and cURL commands. Please use plain text formatting in your code. Make sure you do not have spaces after the in the cURL command.

Instance Configuration

The content in the configuration section or nested object in the body posted to the POST /instances or PUT /instances/{id} APIs varies depending on which element is being instantiated. However, some configuration properties are common to all elements and available to be configured for all elements. These properties are -

  • event.notification.enabled: This property is a boolean property, and determines if event reception (via webhook or polling) is enabled for the element instance. This property defaults to false.
  • event.vendor.type: When event.notification.enabled property is set to true, this property determines the mechanism to use to receive or fetch changed events from the service endpoint. The supported values are webhook and polling. Most elements support one mechanism or the other, but some like support both mechanisms. This property is optional.
  • event.notification.type: This property can be used to determine how an event notification should be sent to the consumer of the element instance, in most cases your application. Currently, webhook is the only supported value for this property. This means that when an event is received by the element instance, it will get forwarded to the provided event.notification.callback.url via a webhook to you. This property is optional.
  • event.notification.callback.url: As mentioned above, the value of this property is an http or https URL to which we will post the event for consumption by your application. This property is optional.
  • filter.response.nulls: This property defaults to true, i.e., it's boolean property, and determines if null values in the response JSON should or should not be filtered from the response returned to the consuming application. By default, all null values are filtered from the response before sending the response to the consuming application.