Skip to content

IDP Integration API (v1.0.0)

Download OpenAPI description
integration-gateway-openapi.json
integration-gateway-openapi.yaml
Languages
Servers
Mock server

https://developers.retarus.com/_mock/idp/integration-gateway-openapi/

Local

https://integration.idp.de2.retarus.com/

process-content-controller

Operations

process-search-controller

Operations

process-administration-controller

Operations

common-upload-controller

Operations

Upload new document to processing

Request

Security
bearerAuth
Headers
channel-referencestringrequired
channel-namestringrequired
customer-billing-codestring
comparisonIdstring
ai-preset-codestring
ai-pipeline-codestringDeprecated
Bodymultipart/form-data
filestring(binary)required
curl -i -X POST \
  https://developers.retarus.com/_mock/idp/integration-gateway-openapi/upload-pdf \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: multipart/form-data' \
  -H 'ai-pipeline-code: ' \
  -H 'ai-preset-code: ' \
  -H 'channel-name: ' \
  -H 'channel-reference: ' \
  -H 'comparisonId: ' \
  -H 'customer-billing-code: ' \
  -F file=string

Responses

OK

Bodyapplication/json
processIdstring
Response
application/json
{
  "processId": "string"
}

Upload new document to processing

Request

Security
bearerAuth
Headers
channel-referencestringrequired
channel-namestringrequired
customer-billing-codestring
comparisonIdstring
ai-preset-codestring
ai-pipeline-codestringDeprecated
Bodymultipart/form-data
filestring(binary)required
curl -i -X POST \
  https://developers.retarus.com/_mock/idp/integration-gateway-openapi/upload-jpeg \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: multipart/form-data' \
  -H 'ai-pipeline-code: ' \
  -H 'ai-preset-code: ' \
  -H 'channel-name: ' \
  -H 'channel-reference: ' \
  -H 'comparisonId: ' \
  -H 'customer-billing-code: ' \
  -F file=string

Responses

OK

Bodyapplication/json
processIdstring
Response
application/json
{
  "processId": "string"
}

Upload new document to processing

Request

Security
bearerAuth
Headers
channel-referencestringrequired
channel-namestringrequired
customer-billing-codestring
comparisonIdstring
ai-preset-codestring
ai-pipeline-codestringDeprecated
Bodymultipart/form-data
filestring(binary)required
curl -i -X POST \
  https://developers.retarus.com/_mock/idp/integration-gateway-openapi/upload-png \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: multipart/form-data' \
  -H 'ai-pipeline-code: ' \
  -H 'ai-preset-code: ' \
  -H 'channel-name: ' \
  -H 'channel-reference: ' \
  -H 'comparisonId: ' \
  -H 'customer-billing-code: ' \
  -F file=string

Responses

OK

Bodyapplication/json
processIdstring
Response
application/json
{
  "processId": "string"
}

Upload new document to processing

Request

Security
bearerAuth
Headers
channel-referencestringrequired
channel-namestringrequired
customer-billing-codestring
comparisonIdstring
ai-preset-codestring
ai-pipeline-codestringDeprecated
Bodymultipart/form-data
filestring(binary)required
curl -i -X POST \
  https://developers.retarus.com/_mock/idp/integration-gateway-openapi/upload-tiff \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: multipart/form-data' \
  -H 'ai-pipeline-code: ' \
  -H 'ai-preset-code: ' \
  -H 'channel-name: ' \
  -H 'channel-reference: ' \
  -H 'comparisonId: ' \
  -H 'customer-billing-code: ' \
  -F file=string

Responses

OK

Bodyapplication/json
processIdstring
Response
application/json
{
  "processId": "string"
}

import-api-controller

Operations

validation-api-controller

Operations