ElasticOCR (Preview)

ElasticOCR (Preview)

The new, modern way to OCR your documents.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
Flow Standard All Flow regions
PowerApps Standard All PowerApps regions

Optical Character Recognition (OCR) converts image-based documents, such as those from a document scanner, into editable and/or searchable formats. Documents that have been through an OCR process are easier to find, more accurately discoverable, and more usable in business and process automation. ElasticOCR's cloud-based, on-demand document OCR service scales with your needs, and supports your organization's compliance strategy (such as GDPR) by offering guraranteed processing regions, all backed by our industry-leading processing SLA. Learn more about ElasticOCR today at https://elasticocr.com.

To use this integration, you'll need an active ElasticOCR subscription or free trial.

Locating your License ID & App ID

  • Current subscribers may obtain their License ID and App ID via the ElasticOCR Portal.
  • New users may sign up for a 30-day/500 page free trial and obtain their License ID and App ID from their welcome email.

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Creating a connection

To connect your account, you will need the following information:

License ID
securestring
License ID
App ID
securestring
App ID

Actions

Complete a job

Marks a job as complete after successful retrieval of the processed file.

Required Parameters

Job Id
uuid
Unique Id of an ElasticOCR job

Returns

Create a job with a file

Create an ElasticOCR job for a supplied binary file.

Required Parameters

Filename
string
Filename of the file supplied for an ElasticOCR job
File Data (binary)
binary
Content of the file supplied for an ElasticOCR job

Optional Parameters

Metadata
string
Job specific metadata to be stored with the ElasticOCR job

Returns

Create a job without a file

Create an ElasticOCR job without supplying a file; supply a file later using [PUT] /v{version}/jobs/{jobId}.

Optional Parameters

Metadata
string
Job specific metadata to be stored with the ElasticOCR job

Returns

Delete a job

Delete an ElasticOCR job before it begins processing. Only jobs with a status of Pending or Uploaded may be deleted.

Required Parameters

Job Id
uuid
Unique Id of an ElasticOCR job

Returns

Download a job

Downloads an available job's processed file.

Required Parameters

Job Id
uuid
Unique Id of an ElasticOCR job

Returns

File Content
binary

The content of the file

Get all jobs

Retrieve all jobs and their current statuses. By default, a maximum of 1,000 jobs are returned.

Required Parameters

Job Id
uuid
Unique Id of an ElasticOCR job

Returns

array of JobResponse

Retrieve a job

Retrieve a specific job.

Required Parameters

Job Id
uuid
Unique Id of an ElasticOCR job

Returns

Retrieve a license

Validate a license and identify the associated processing region.

Required Parameters

Job Id
uuid
Unique Id of an ElasticOCR job

Returns

Update an existing job with a file

Add a file to an existing ElasticOCR job. Only jobs with a status of Pending may be updated.

Required Parameters

Filename
string
Filename of the file supplied for an ElasticOCR job
Job Id
uuid
Unique Id of an ElasticOCR job
File Data (binary)
binary
Content of the file supplied for an ElasticOCR job

Optional Parameters

Metadata
string
Job specific metadata to be stored with the ElasticOCR job

Returns

Definitions

JobResponse

App Id
uuid
The App Id associated with the ElasticOCR job.
Available Date
date-time
The date & time the ElasticOCR job became available for retrieval.
Created Date
date-time
The date & time the ElasticOCR job was created.
Download URL
string
The unique URL to retrieve the processed document.
Download URL Expires
date-time
The date & time that the temporary download URL expires.
Filename
string
The name of the file associated with the ElasticOCR job.
Job Id
uuid
The unique Id of the ElasticOCR job.
License Id
uuid
The License Id associated with the ElasticOCR job.
Metadata
object
Custom JSON metadata supplied for the job.
Status
string
The current status of the ElasticOCR job.

LicenseResponse

App Id
uuid
The Id of a valid app within the ElasticOCR subscription.
License Id
uuid
The License Id of the associated ElasticOCR subscription.
Processing Region
string
The country prefix configured for the associated ElasticOCR subscription.