Using registration parameters

Transaction and file registration parameters are parameters consisting of key-value string pairs designed to provide additional user information (client name, document type, file source information, etc.). They are passed for processing along the transaction or the transaction documents. These parameters are available to all workers and can be used in various production scenarios:

  • A program that uses ABBYY Vantage signs every transaction using an end-client attribute for the purposes of compiling reports and creating custom processing procedures (e.g. filtering counterparty data catalogs by client).
  • A Scanning Station client (or a different origin for transactions) can pass the registration parameters of a document batch (e.g. an external correlation ID).

Registration parameters can be set using the Vantage API:

  1. When creating an empty transaction or when initializing a transaction using the launch method. To do so, send a POST request to the transactions resource like in the example below:

POST https://vantage-eu.abbyy.com/api/publicapi/v1/transactions for users in Western Europe,

POST https://vantage-us.abbyy.com/api/publicapi/v1/transactions for users in North America and

POST https://vantage-au.abbyy.com/api/publicapi/v1/transactions for users in Australia

or

POST https://vantage-eu.abbyy.com/api/publicapi/v1/transactions/launch?skillId=skill-id for users in Western Europe,

POST https://vantage-us.abbyy.com/api/publicapi/v1/transactions/launch?skillId=skill-id for users in North America and

POST https://vantage-au.abbyy.com/api/publicapi/v1/transactions/launch?skillId=skill-id for users in Australia

In the request body, specify the registration parameters and run the following command:

For Windows

For Linux

  1. When uploading files. To do so, send a POST request to the transactions/<transaction-id>/files/ resource as follows:

POST https://vantage-eu.abbyy.com/api/publicapi/v1/transactions/transaction-id/files/ for users in Western Europe,

POST https://vantage-us.abbyy.com/api/publicapi/v1/transactions/transaction-id/files/ for users in North Americaand

POST https://vantage-au.abbyy.com/api/publicapi/v1/transactions/transaction-id/files/ for users in Australia

In the request body, specify the registration parameters and run the following command:

For Windows

For Linux

There can be a maximum of 10 key-value type parameters, with the key parameter containing up to 128 characters and the value parameter containing up to 256 characters. The values of these parameters cannot be changed once they have been set.

  • in Custom activity scripts,
  • in External Export scripts in Output activity,
  • in business rules.

You can get registration parameter values using the Vantage API as follows:

  1. By calling the registrationParameters method for the transactions/<transaction-id>/registrationParameters resource:

POST https://vantage-eu.abbyy.com/api/publicapi/v1/transactions/transaction-id/registrationParameters/ for users in Western Europe,

POST https://vantage-us.abbyy.com/api/publicapi/v1/transactions/transaction-id/registrationParameters/ for users in North America and

POST https://vantage-au.abbyy.com/api/publicapi/v1/transactions/transaction-id/registrationParameters/ for users in Australia

The response will look like the following

Response

  1. By using a download method call for the transactions/<transaction-id>/files/<file-id>/download resource to get the values in JSON format alongside the file being uploaded:

GET https://vantage-eu.abbyy.com/api/publicapi/v1/transactions/transaction-id/files/file-id/download for users in Western Europe,

GET https://vantage-us.abbyy.com/api/publicapi/v1/transactions/transaction-id/files/file-id/download for users in North America and

GET https://vantage-au.abbyy.com/api/publicapi/v1/transactions/transaction-id/files/file-id/download for users in Australia

22.12.2023 12:36:42

Usage of Cookies. In order to optimize the website functionality and improve your online experience ABBYY uses cookies. You agree to the usage of cookies when you continue using this site. Further details can be found in our Privacy Notice.