Skip to main content
Each HTTP request to the service should include an authorization header that ABBYY Vantage will use to confirm your identity. Contact ABBYY to request a tenant in ABBYY Vantage service. Once you have a tenant’s account, you can create user accounts. The user account’s email and password can be used to get an access token for API authorization. The OAuth 2.0 protocol is used in ABBYY Vantage for authentication. OAuth 2.0 authentication is carried out over two stages: getting an access token and then the authorization itself. Access tokens can be obtained using two standard authentication schemes: Resource Owner Password Credentials and Authorization Code Flow.

OpenID Connect Discovery Document

You can set up your application using OpenID Connect (OIDC) Discovery Document located at https://vantage-us.abbyy.com/auth2/{tenantId}/.well-known/openid-configuration. For information about obtaining a tenant identifier, see the Getting a Tenant Identifier section of the Administrator’s guide. Sample request:
https://vantage-us.abbyy.com/auth2/TestTenant/.well-known/openid-configuration
We also recommend using URLs found in the discovery document for ROPC and Authorization Code flows.

Authentication Flow

1

Get an Access Token

Choose one of the two authentication methods to obtain an access token:
  • Resource Owner Password Credentials (ROPC) - Direct username/password authentication
  • Authorization Code Flow - OAuth redirect-based authentication
2

Include Token in Requests

Add the access token to the Authorization header of all API requests:
Authorization: Bearer {your_access_token}

Next Steps