Transaction Tracking and Charging

Transaction reporting is implemented in the Digital Identity Service to provide data for invoicing with Transaction-based model. Customers are contractually obliged to provide reporting to Innovatrics, unless agreed otherwise. The transactions performed by the DIS can be tracked online via Innovatrics server or with a locally deployed service on-prem.

Reporting Transactions in DIS

Online Reporting with Transaction Counting System (TCS)

Prerequisite: The Digital Identity Service deployed in production must have a connection to Innovatrics' tracking service at tcs.innovatrics.com via a secure connection, as described in technical documentation of DIS.

The transactions are tagged with customer’s individual API key assigned in the product license and used for the API calls.

No manual action is needed on customer’s side in case of online reporting.

Offline Reporting with TCS for Disconnected Instances of DIS

In case the environment, where the DIS is hosted, cannot communicate with outside network in any way, it is necessary to use on-prem instance of TCS. The TCS is a simple app that can collect usage report from all the instances of DIS in the local network, store them in a local DB and provide a method to export data for reporting. There is a guide how to install the TCS locally. TCS installation package can be downloaded in Cutomer Portal.

The TCS comes with an UI for exporting data of a finished month. These are put into a file that has to be uploaded via Customer Portal. It is recommended to do the upload every month to keep the local database small.

TCS installed on prem

Transaction Types Being Charged

Innovatrics is tracking and billing following transactions:

  • OCR extraction of data from ID document including visual and MRZ zone (both sides of document count as one transaction)
  • Liveness detection (Passive, MagnifEye or Smile type of liveness, each evaluation counts as one transaction)
  • Face matching This transaction is charged only if it is the only transaction used, otherwise it’s free if used together with other transactions (face vs document or face vs face, each matching counts as one transaction)
  • Face image evaluation (ICAO quality evaluation, cropping, background removal, age and gender estimation; any combination of these functions counts as one transaction)
  • Document NFC readout (reading and authenticity checks performed on the device)
  • Document authenticity (any combination of screen and print attack detection, BW photocopy detection and document data cross-check counts as one transaction)

Data Security

Transaction logs do not contain any private or sensitive information about clients, nor about the demography of clients. Only failure statistics and data on transaction quantity and quality are collected by Innovatrics in order to optimize server configuration. These same events are also recorded in the service logs, which are fully open for customer audit. All monitored events are listed below.

Customer Onboarding API Events

EventAPI callParameters
dis-customers-selfiePOST /api/v1/customers/{id}/selfieserver-version
image-resolution
result
dis-customers-liveness-selfiesPOST /api/v1/customers/{id}/liveness/selfiesserver-version
assertion (liveness type)
image-resolution
result
dis-customers-liveness-evaluationPOST /api/v1/customers/{id}/liveness/evaluationserver-version
type (liveness type)
score (rounded)
result
dis-customers-document-pagesPUT /api/v1/customers/{id}/document/pagesserver-version
document-type
page (front/back)
recognized (level of recognition)
duration
image-resolution
image-size-kb
image-format
ocr-confidence (average rounded)
result
dis-customers-get-dataevery GET operationserver-version
operation (name of GET call)
dis-customers-getGET /api/v1/customers/{id}server-version
provided-selfie (true/false)
provided-document (true/false)
document-face-found (true/false)
dis-customers-inspectPOST /api/v1/customers/{id}/inspectserver-version
similarity-selfie-document (true/false)
similarity-selfie-liveness (true/false)
face-mask (true/false)
aspect-age (difference between estimation and date of birth)
aspect-gender (match between estimation and document)
dis-customers-document-inspectPOST /api/v1/customers/{id}/document/inspectserver-version
pages (count)
expired (true/false)
mrz-check (true/false)
text-consistency (true/false)
color-profile-change-detected (true/false)
looks-like-screenshot (true/false)
dis-customers-storePOST /api/v1/customers/{id}/storeserver-version
status
dis-metadata-getGET /api/v1/metadataserver-version

Mapping the Charged Transactions to the API Calls

OCR Extraction

Counted for each /customer entity created in DIS API that had the API GET /api/v1/customers/{id} called at least once with an image classified as front page.

Liveness Detection

Counted for each /customer entity created in DIS API that had the API POST /api/v1/customers/{id}/liveness/evaluation called at least once.

Face Matching

Counted for each /customer entity created in DIS API that had the API POST /api/v1/customers/{id}/inspect called, or for each /face entity created in DIS API that had the API POST /api/v1/faces/{probe_face_id}/similarity called. The customers/inspect is matching the face between document and selfie. The similarity is matching any pair of faces provided.

Face Evaluation

Counted for each /customer entity created in DIS entity:

  • Where API GET /api/v1/customers/{id} is called, and a face was uploaded while no document page loaded. Counted for each /face entity created in DIS entity:
  • Where API GET /api/v1/faces/{id}/aspects is called
  • Where API GET /api/v1/faces/{id}/crop is called

Document Authenticity Check

Counted for each /customer entity created in DIS API that had the API POST /api/v1/customers/{id}/document/inspect called at least once.

Reporting of Usage with Web Auto Capture Components

The mobile SDK libraries (Android, iOS) collect events for performed actions like autocapture. These are sent to Innovatrics' Transaction Counting Service (TCS) to enable precise tracking of transactions for invoicing as the license requires it.

Usage logs do not contain any private or sensitive information about clients, nor any device fingerprinting, nor anything about the demography of clients.

Web Component Transaction Reporting Events

TransactionComponent
web-capture-faceWeb Face Auto Capture
web-capture-documentWeb Document Auto Capture
web-capture-smileWeb Smile Liveness
web-capture-magnifeyeWeb MagnifEye Liveness
web-capture-eyegazeWeb EyeGaze Liveness
web-capture-palmWeb Palm Auto Capture

Reporting of Usage with Mobile Libraries

The mobile SDK libraries (Android, iOS) collect events for performed actions like autocapture. These are sent to Innovatrics' Transaction Counting Service (TCS) to enable precise tracking of transactions for invoicing, in case the license requires it.

Usage logs do not contain any private or sensitive information about clients, nor any device fingerprinting, nor anything about the demography of clients.

Mobile Libraries (Android, iOS) Transaction Reporting Events

TransactionComponentLibrary
mobile-capture-faceFace Auto CaptureAndroid Face library
Android Face Lite library
iOS Face library
iOS Face Lite library
mobile-capture-documentDocument AutoAndroid Document library
iOS Document library
mobile-capture-smileSmile LivenessAndroid Face library
iOS Face library
mobile-capture-magnifeyeMagnifEye LivenessAndroid Face library
Android Face Lite library
iOS Face library
iOS Face Lite library
mobile-capture-eyegazeEyeGaze LivenessAndroid Face library
iOS Face library
mobile-capture-palmPalm Auto CaptureAndroid Palm library
iOS Palm library
mobile-chip-readingNFC Travel DocumentReaderAndroid NFC library
iOS NFC library
mobile-face-livenessPassive LivenessAndroid Face library
iOS Face library
mobile-face-matchingFace Matcher
Template Matcher
Android Face library
iOS Face library

Analytics reporting of Web Auto Capture Components and mobile libraries

The Web Auto Capture Components, as well as mobile libraries for Android and iOS are sending analytics usage data for statistical and debugging purposes. The statistics are also used for further user experience improvement.

Usage analytics do not collect any private or sensitive information about your clients. The data do not assign any tracking or advertising ID to the user. The collected analytics usage data contain, among others, information about:

  • Auto capture components quality data
  • Auto capture components performance data
  • Device data
  • SDK data
  • Geo IP

You will need to declare “anonymous usage statistics” for your app in the Google Play console and the Apple App Store if not already declared.