Creates a processing transaction

Creates a transaction that will be used to process some files.

POST /api/publicapi/v1/transactions

Creates a processing transaction

cURL

curl --request POST \
  --url https://vantage-us.abbyy.com/api/publicapi/v1/transactions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json-patch+json' \
  --data '
{
  "skillId": "<string>",
  "generateMobileInputLink": false,
  "registrationParameters": [
    {
      "key": "<string>",
      "value": "<string>"
    }
  ],
  "skillParameters": [
    {
      "key": "<string>",
      "value": "<string>"
    }
  ]
}
'

201

{
  "transactionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "mobileInputLink": "<string>",
  "isShortLink": true
}

Authorizations

Authorization · string · header · required

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

Body

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

Transaction creation parameters

skillId · string · required

Id of the skill to be applied to the files

Minimum string length: 1

generateMobileInputLink · boolean · default: false

Generate URL to run mobile input with one time auth token to inject image to specific transaction

registrationParameters · object[] | null

Additional registration parameters for transaction

Maximum array length: 10

Show child attributes

skillParameters · object[] | null

Skill parameters for transaction

Maximum array length: 10

Show child attributes

Response

201

text/plain

Transaction successfully created

transactionId · string<uuid> · required

mobileInputLink · string | null

Mobile input link which contains one time authorization token for current transaction. Parameter is returned if generateMobileInputLink=true

isShortLink · boolean

Is the mobile input link a short link referencing the origin mobile input link.