Authologic allows you to execute a simple and effective verification of the user’s identity. The use of the API consists of initiating the process by an external system, redirecting the user to the appropriate page, and then receiving the verification results.

Organization of documentation

Documentation is structured to take you from the simpler to the more advanced options. Our API is also built in such a way that you don’t have to make all the decisions related to integration right away. Each element is only a supplement to the previous ones. This allows you to quickly build a basic integration, then add new features, products, and enhancements when needed.

Basic Information

The following information is necessary to build a basic, but in most cases sufficient, Authologic integration.

Overview

Understand communicating with Authologic services and how to verify identity.

Integration in 5 minutes:Basic information

API in practice, which is a description of the basics of integration on the basis of a few commands that can be tested from the command line.

Conversation statuses

Description of the conversation lifecycle, conversation status and individual products.

Using change notifications with callbacks

How Authologic notifies you of the result of a verification.

Implementation Notes

What you should pay attention to while developing and how we will make changes to the API in the future.

Strategy testing

Information on testing the strategy

Production launch

How to make the integration available to your users.

What’s next?

The basic information should be sufficient to do basic integration. However, depending on your needs, integration can be expanded in various directions. Below you will find chapters that should cover specific topics.

Strategies

Verification strategies

In case you want to use several verification methods, e.g. depending on how sensitive the operation your user wants to perform.

Products

In addition to the basic and always available information about the verified user, Authologic provides additional elements called products. They are described below.

Transactions

Retrieving information about a user’s transactions and statistics related to those transactions.

Data Verification

Compare the verification data with the submitted data.

User authentication

A product that allows you to build mechanisms for logging into your system.

AML Verification

User verification for presence on AML lists. You may also be interested in AML change monitoring.

Additional options and extensions

Embedding the process within your website

How to embed the verification process on your own website.

Downloading captured photos and other verification data

How to access original scans of a document and user’s photos.

Additional information about the verification process

How to check which method was selected by the user.

Additional information about verification failure reasons

How to check the reason for refusal to verify and detailed information about its progress.

Additional validations of the verification process

How to check the additional validations performed on the user data.

Possibility to disable unfinished conversations

How to block the ability to pass ID verification for a specific conversation.

FAQ: Frequently Asked Questions

Foreign Translation and Support

How to handle the multilingual interface

Use of mandatory and optional fields

When to use query.requireOneOf and query.optional

Use hint

Define hints fields

Change appearance

Options available for customizing the user interface

Development

Versions and unsupported features

Information about functionalities that will be removed and may require updating your system.

Detailed API description

For people who prefer to have an encyclopedic overview of API capabilities in one place.

Additional conversations’ data

Advanced methods

Advanced personalization


Despite our sincere intentions, it is difficult to create perfect technical documentation. If you have an idea on how to improve this documentation, or you have trouble understanding any section, please email us at tech-support@authologic.com