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 except the following:
     -   US Government (GCC)
PowerApps Standard All PowerApps regions except the following:
     -   US Government (GCC)

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.

Creating a connection

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

Name Type Description
License ID securestring

License ID

App ID securestring

App ID

Throttling Limits

Name Calls Renewal Period
API calls per connection10060 seconds

Actions

Complete a job

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

Create a job with a file

Create an ElasticOCR job for a supplied binary file.

Create a job without a file

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

Delete a job

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

Download a job

Downloads an available job's processed file.

Get all jobs

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

Retrieve a job

Retrieve a specific job.

Retrieve a license

Validate a license and identify the associated processing region.

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.

Complete a job

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

Parameters

Name Key Required Type Description
Job Id
jobId True uuid

Unique Id of an ElasticOCR job

Returns

Create a job with a file

Create an ElasticOCR job for a supplied binary file.

Parameters

Name Key Required Type Description
Filename
filename True string

Filename of the file supplied for an ElasticOCR job

Metadata
metadata string

Job specific metadata to be stored with the ElasticOCR job

File Data (binary)
filedata True binary

Content of the file supplied for an 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}.

Parameters

Name Key Required Type Description
Metadata
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.

Parameters

Name Key Required Type Description
Job Id
jobId True uuid

Unique Id of an ElasticOCR job

Download a job

Downloads an available job's processed file.

Parameters

Name Key Required Type Description
Job Id
jobId True uuid

Unique Id of an ElasticOCR job

Returns

The content of the file

File Content
binary

Get all jobs

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

Returns

Retrieve a job

Retrieve a specific job.

Parameters

Name Key Required Type Description
Job Id
jobId True uuid

Unique Id of an ElasticOCR job

Returns

Retrieve a license

Validate a license and identify the associated processing region.

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.

Parameters

Name Key Required Type Description
Filename
filename True string

Filename of the file supplied for an ElasticOCR job

Job Id
jobId True uuid

Unique Id of an ElasticOCR job

Metadata
metadata string

Job specific metadata to be stored with the ElasticOCR job

File Data (binary)
filedata True binary

Content of the file supplied for an ElasticOCR job

Returns

Definitions

JobResponse

Name Path Type Description
Job Id
id uuid

The unique Id of the ElasticOCR job.

License Id
licenseId uuid

The License Id associated with the ElasticOCR job.

App Id
appId uuid

The App Id associated with the ElasticOCR job.

Status
status string

The current status of the ElasticOCR job.

Filename
filename string

The name of the file associated with the ElasticOCR job.

Created Date
createdDate date-time

The date & time the ElasticOCR job was created.

Available Date
availableDate date-time

The date & time the ElasticOCR job became available for retrieval.

Download URL
downloadUrl string

The unique URL to retrieve the processed document.

Download URL Expires
downloadUrlExpires date-time

The date & time that the temporary download URL expires.

Metadata
metadata object

Custom JSON metadata supplied for the job.

LicenseResponse

Name Path Type Description
License Id
id uuid

The License Id of the associated ElasticOCR subscription.

App Id
appId uuid

The Id of a valid app within the ElasticOCR subscription.

Processing Region
processingRegion string

The country prefix configured for the associated ElasticOCR subscription.