api/v2/idp

IDP REST API provides convenience wrapper calls around DocForm API in order to simplify usage of the IDP functionality available in the elDoc system.

API overview

Method

API endpoint

Get recognition document contents as PDF-fileGET api/v2/idp/{id}/pdf
Get recognition document contents as textGET api/v2/idp/{id}/text
Get recognition data attachmentGET api/v2/idp/{id}/recoData/{recoDataId}/file/{fileId}


Common request parameters overview

Param

Type

Description

Sample values

{id}Path paramShort id (stored in the _id_web property) or full id (24 hex-character value stored in the _id property) of the DocFormF12, 59d4582e42a6273b107abcb0



Get recognition document contents as PDF-file

URL & Method & Description

GET api/v2/idp/{id}/pdf

Retrieves recognition document contents as PDF file with text-layer.

Request:

Request (sample)
GET https://eldoc.online/api/v2/idp/{id}/pdf

Response:

Response headers
Content-Disposition: attachment; filename*=UTF-8''FILENAME.XXXXX.pdf
Content-Type: application/pdf


Get recognition document contents as text

URL & Method & Description

GET api/v2/idp/{id}/text

Retrieves recognition document contents as text.

Request:

Request (sample)
GET https://eldoc.online/api/v2/idp/{id}/text
ParamTypeDescriptionSample values (comma separated)
{page}Query param(Optional) Page index (0-based)?page=5

Response:

Response headers
Content-Type: text/plain;charset=UTF-8
X-Total-Count: 0
Response body (sample)
// Text contents



Get recognition data attachment

URL & Method & Description

GET api/v2/idp/{id}/recoData/{recoDataId}/file/{fileId}

Retrieves recognition data attachment (image of the extracted region, etc).

Request:

Request (sample)
GET https://eldoc.online/api/v2/idp/{id}/recoData/{recoDataId}/file/{fileId}
ParamTypeDescriptionSample values (comma separated)
{recoDataId}Query paramId of the recoData59d4582e42a6273b107abcb0
{fileId}Query paramId of the file attachment52d4582e42a6273b107cadd2

Response:

Response headers
Content-Type: application/octet-stream
Response body (sample)
// Binary content of the file attachment



Last modified: May 16, 2023