Skip to content

Upload new document to processing

Request

All request headers beginning with x-idp-ingestion- will be collected into an exogenous metadata map. Content of this map is included in the final process result. Example:

  • x-idp-ingestion-user: "John"
  • x-idp-ingestion-request-id: "12345"
Security
bearerAuth
Headers
x-idp-ingestion-*any

Any header starting with x-idp-ingestion- is accepted. Values are aggregated into a map.

channel-referenceanyrequired
channel-nameanyrequired
customer-billing-codeany
comparisonIdany
ai-pipeline-codeanydeprecated
ai-preset-codeany
Bodymultipart/form-data
fileany, (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: {ai-pipeline-code}' \
  -H 'ai-preset-code: {ai-preset-code}' \
  -H 'channel-name: {channel-name}' \
  -H 'channel-reference: {channel-reference}' \
  -H 'comparisonId: {comparisonId}' \
  -H 'customer-billing-code: {customer-billing-code}' \
  -H 'x-idp-ingestion-*: {x-idp-ingestion-*}' \
  -F file=

Responses

OK

Bodyapplication/json
processIdany
Response
{
  "processId": null
}

Upload new document to processing

Request

All request headers beginning with x-idp-ingestion- will be collected into an exogenous metadata map. Content of this map is included in the final process result. Example:

  • x-idp-ingestion-user: "John"
  • x-idp-ingestion-request-id: "12345"
Security
bearerAuth
Headers
x-idp-ingestion-*any

Any header starting with x-idp-ingestion- is accepted. Values are aggregated into a map.

channel-referenceanyrequired
channel-nameanyrequired
customer-billing-codeany
comparisonIdany
ai-pipeline-codeanydeprecated
ai-preset-codeany
Bodymultipart/form-data
fileany, (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: {ai-pipeline-code}' \
  -H 'ai-preset-code: {ai-preset-code}' \
  -H 'channel-name: {channel-name}' \
  -H 'channel-reference: {channel-reference}' \
  -H 'comparisonId: {comparisonId}' \
  -H 'customer-billing-code: {customer-billing-code}' \
  -H 'x-idp-ingestion-*: {x-idp-ingestion-*}' \
  -F file=

Responses

OK

Bodyapplication/json
processIdany
Response
{
  "processId": null
}

Upload new document to processing

Request

All request headers beginning with x-idp-ingestion- will be collected into an exogenous metadata map. Content of this map is included in the final process result. Example:

  • x-idp-ingestion-user: "John"
  • x-idp-ingestion-request-id: "12345"
Security
bearerAuth
Headers
x-idp-ingestion-*any

Any header starting with x-idp-ingestion- is accepted. Values are aggregated into a map.

channel-referenceanyrequired
channel-nameanyrequired
customer-billing-codeany
comparisonIdany
ai-pipeline-codeanydeprecated
ai-preset-codeany
Bodymultipart/form-data
fileany, (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: {ai-pipeline-code}' \
  -H 'ai-preset-code: {ai-preset-code}' \
  -H 'channel-name: {channel-name}' \
  -H 'channel-reference: {channel-reference}' \
  -H 'comparisonId: {comparisonId}' \
  -H 'customer-billing-code: {customer-billing-code}' \
  -H 'x-idp-ingestion-*: {x-idp-ingestion-*}' \
  -F file=

Responses

OK

Bodyapplication/json
processIdany
Response
{
  "processId": null
}

Upload new document to processing

Request

All request headers beginning with x-idp-ingestion- will be collected into an exogenous metadata map. Content of this map is included in the final process result. Example:

  • x-idp-ingestion-user: "John"
  • x-idp-ingestion-request-id: "12345"
Security
bearerAuth
Headers
x-idp-ingestion-*any

Any header starting with x-idp-ingestion- is accepted. Values are aggregated into a map.

channel-referenceanyrequired
channel-nameanyrequired
customer-billing-codeany
comparisonIdany
ai-pipeline-codeanydeprecated
ai-preset-codeany
Bodymultipart/form-data
fileany, (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: {ai-pipeline-code}' \
  -H 'ai-preset-code: {ai-preset-code}' \
  -H 'channel-name: {channel-name}' \
  -H 'channel-reference: {channel-reference}' \
  -H 'comparisonId: {comparisonId}' \
  -H 'customer-billing-code: {customer-billing-code}' \
  -H 'x-idp-ingestion-*: {x-idp-ingestion-*}' \
  -F file=

Responses

OK

Bodyapplication/json
processIdany
Response
{
  "processId": null
}