Creates a transaction document that will be used to group some files in single processing unit

Non-process skills allow only one document

POST /api/publicapi/v1/transactions/{transactionId}/documents

Creates a transaction document that will be used to group some files in single processing unit

cURL

curl --request POST \
  --url https://vantage-us.abbyy.com/api/publicapi/v1/transactions/{transactionId}/documents \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json-patch+json' \
  --data '
{
  "index": "<string>",
  "imageProcessingOptions": {}
}
'

201

{
  "documentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

Authorization · string · header · required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

transactionId · string<uuid> · required

Transaction identifier. You receive it in the response after the transaction has been successfully created.

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

index · string | null

Documents in transaction will be ordered by this parameter

imageProcessingOptions · object

Image preprocessing settings for import

Show child attributes

Response

201

text/plain

Transaction document successfully added

documentId · string<uuid> · required

Document Id