Start a new user verification process

Each process of getting data and confirming the identity of the user should start by calling this method. The call initiates this process and returns information about the address to which the user should be redirected to gathering the information requested from him.

::note In order to use the API you need to obtain the login and password for a for a specific environment. You can generate a new API key in the API Keys section of the OmniPanel. The API is accessible via either HTTP Basic authentication or OAuth2 client credentials flow. Both methods accept the same API key.
When using OAuth2, the API key can be sent either via Authentication Bearer header or via HTTP POST body.
::

::note This is because all of these fields may have their default values set on the Authologic side when creating your account. If any value does not have a default setting you will get an error and you should either provide that value or report to Authologic to set the default one. ::

The query contains three groups of information:

• general information such as:
  • userKey: User ID on your system
  • strategy: information about the identity checking strategy (usually the default value is sufficient)
  • returnUrl: URL to which the user should be redirected after the process is completed
  • callbackUrl: information about the return address to which the system will send the acquired information. If this information is not provided, Authologic assumes that the information will be downloaded by the client
• query: query definition containing individual products provided by Authologic

::warning The test environment allows the use of an HTTP address for callbackUrl. A production environment always requires HTTPS. ::

::note For testing purposes, to check the callback request, you can use online tools that accept and present the outgoing requests. One such tool is, for example, Webhook. When creating a conversation, it is enough to provide the url generated by Webhook in the callbackUrl parameter. ::

The information contained in the query section is divided into specific products:

• identity - fetch user information. This section is always required
  • requireOneOf: User information to be specified by Authologic. This is represented as set of sets and Authologic will try to fetch one of these
  • optional: User information that may be specified by Authologic when the information is available
• aml - check user on AML lists
  • checks: lists where the user should be checked
• auth - user authentication product
• bankTransactions - the process of retrieving information about transactions.
  • type: type of transaction - credit, debit or all
  • flags: Additional information on what to return
• verify - confirmation of the compliance of user data
  • user: information about user that should be verified