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-file	`GET api/v2/idp/{id}/pdf`
Get recognition document contents as text	`GET api/v2/idp/{id}/text`
Get recognition data attachment	`GET api/v2/idp/{id}/recoData/{recoDataId}/file/{fileId}`

Common request parameters overview

Param	Type	Description	Sample values
`{id}`	Path param	Short id (stored in the _id_web property) or full id (24 hex-character value stored in the _id property) of the DocForm	F12, 59d4582e42a6273b107abcb0

URL & Method & Description

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

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

Request (sample)

GET https://eldoc.online/api/v2/idp/{id}/pdf

Response headers

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

URL & Method & Description

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

Retrieves recognition document contents as text.

Request (sample)

GET https://eldoc.online/api/v2/idp/{id}/text

Param	Type	Description	Sample values (comma separated)
`{page}`	Query param	(Optional) Page index (0-based)	?page=5

Response headers

Content-Type: text/plain;charset=UTF-8
X-Total-Count: 0

Response body (sample)

// Text contents

URL & Method & Description

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

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

Request (sample)

GET https://eldoc.online/api/v2/idp/{id}/recoData/{recoDataId}/file/{fileId}

Param	Type	Description	Sample values (comma separated)
`{recoDataId}`	Query param	Id of the recoData	59d4582e42a6273b107abcb0
`{fileId}`	Query param	Id of the file attachment	52d4582e42a6273b107cadd2

Response headers

Content-Type: application/octet-stream

Response body (sample)

// Binary content of the file attachment