Backend - Integrations¶

Definitions¶

Terms used in this document:

Term	Description
Mobile Application	The client-specific mobile application that will host EnQualify's mobile features.
Integration Services	Third-party applications that access EnQualify's integration methods or provide integration services for EnQualify.

Integration Points¶

EnQualify offers three integration points for Mobile Applications and Integration Services:

Integration Point	Used by	Description
Mobile SDK	Mobile Applications	Used for mobile application integrations.
Web API (specific methods)	Integration Services	Specific Web API methods are called by Integration Services for integration tasks.
Integration API (customized for the client)	EnQualify → Integration Services	The API developed specifically for the client that EnQualify uses to access Integration Services.

📌 The components involved in integration are marked in red in the diagram: EnQualify Mobile SDK, EnQualify Web API, EnQualify Integration API, and Integration Services.

Mobile SDK¶

Mobile application integrations are conducted through the EnQualify Mobile SDK.

The Mobile SDK includes all functions and components necessary to access EnQualify servers and implement authentication flows and UI elements in mobile applications.
The SDK does not include implementation-specific features; however, it offers customization options.
It is available on the iOS and Android platforms.

ℹ️ Detailed information about the Mobile SDK is not included in this document. For details, see the EnQualify Mobile SDK documents.

Web API¶

For integration tasks, Integration Services call specific methods of the EnQualify Web API. These methods and tasks are explained in detail in the following sections.

Swagger Open API¶

There is a Swagger Open API page and JSON file for EnQualify Web API applications.

The latest Web API methods and data models can be accessed at the following URLs:
https://enqualifyapi-test.enqura.com/swagger/index.html
https://enqualifyapi-test.enqura.com/swagger/v1.0/swagger.json
To access the Swagger page on a different API, make sure that the OpenAPI setting is enabled.
If the Production setting is activated, the Swagger page will not be displayed.
The Swagger page can be used for testing purposes.
The Swagger Open API JSON file provided for easy integration can be used.

Integration API¶

Some integration features require EnQualify to make calls to Integration Services. For these situations, Enqura develops a customized Integration API application for the client.

All Integration APIs provide common API methods that will be used by EnQualify APIs.
Common Integration API methods used by EnQualify APIs are not called directly by Integration Services.
There may be additional features or extra API methods in the Integration API.
Common Integration API methods must be implemented with the methods provided by Integration Services.

Sequences¶

The following diagram shows the general flow order of integration functions. The diagram is simplified with some components and details omitted. Integration functions are indicated in bold in the diagram.

Flow Summary:

Step	Actor	Main Functions
Send Integration Data Before Call	Integration Services → Web API	`GetToken()`, `AddIntegration(Type, Reference, Identity, Data)`, `IDCheck()`
Before Call	Mobile → Mobile API	`Start()`, `GetToken()`, `SetSession(Type, Identity, Reference, Data)`, `DoControls()` → `AddFace()`, `AddIDDoc()`, `AddIDChip()`
Start Call	Mobile → Mobile API → Web API → Integration API	`StartCall()`, `GetUserMap()`, `AssignUser()`, `CheckCall()`, `Ask()`, `Start()`, `GetForm()`, `Notify()`
Call	Mobile ↔ Web API ↔ Web UI	`Communicate()`, `ShowForm()`, `Live()`, `Log()`
Mobile Ends Call	Mobile → Mobile API → Web API → Integration API	`End()`, `Hangup()`, `Notify()`, `Finish()`, `Finished()`, `Send()`, `GetSession()`