Skip to main content
Before using the API, connect to a web service. A connection can be established by the Scanning Operator (ID=1) role on the User station (ID=10) workstation type.

​
Request interfaces

You can work with the Web Services API of the ABBYY FlexiCapture 12 Application Server through SOAP requests, JSON requests, or POST requests. The address of the web service determines the interface you access.

​
Authentication methods

In ABBYY FlexiCapture 12, you can connect to the Web Services API with either a Windows account or an ABBYY FlexiCapture account. For a Windows account, you have two options:
  • Windows authentication: NTLM or Negotiate
  • Basic authentication, passing your username and password as a Base64-encoded string username:password
For an ABBYY FlexiCapture account, add /FCAuth to the web service URL. Use Basic authentication first. After one successful call to the service, the response contains an AuthTicket header with an authorization token. Use that token for subsequent requests from the same machine with Bearer authentication.
To specify a tenant, add the suffix ?Tenant=MyTenantName to the end of the API connection address.

​
Example web service addresses