Skip to main content

Veritran Docs

Innovatrics

This integration allows you enable the Innovatrics SDK in the platform and to access its functionalities.

Note

The integration described in this article may not be implemented in your environment or enabled for all your clients. Contact your admin for assistance.

Technical Details

API ID

508

API Code

INNOVATRICS

Call API version

2

SDK Version

iOS: [1.1.4] DotDocument, [3.3.1] DotFacePassiveLiveness - Last update: Sept 2020

Android: [2.3.0] DotDocument, [3.7.1] DotFacePassiveLiveness - Last update: Jul 2021

App Version

6.5.x

Objective

Access Innovatrics' functionalities

Available for

Android, iOS

Use the Innovatrics Integration in Studio

The following functions are available for use in your legacy processes, and you can also use them as blocks in Lambda processes. Click each function to see more details.

Get Status

Obtain the Call API's basic data.

Face Capture

Get a face capture to verify it.

Liveness Check 2

Perform a liveness check in mode 2, with a moving object on screen.

Face detector

Provide face detection for an image.

Template Verifier

Verify an image template against a mobile image taken by the user.

Face Image Verifier

Verify an image template against an image stored on an ID.

Document Autocapture

Capture an image.

Liveness Check

Perform a liveness check in mode 1, with a moving object on screen.

Get Status

This function obtains basic data about the Call API.

Parameter Configuration

This function doesn't require the configuration of any parameters.

Function ID

Register

Value

110

1

Output Registers

Register

Description

Value

112

Call Result

000

NO_ERROR

001

API_GENERIC_ERROR

003

API_SDK_NOT_INITIALIZED

290

API Version

Returns the Call API version.

291

SDK Version

Returns the SDK version.

292

License ID

Returns the SDK's licence ID.

293

Is Initialized

Returns true or false, whether the Call API is initialized or not.

Face Capture

This function obtains a face image that is suitable to be verified.

Parameter Configuration

This function doesn't require the configuration of any mandatory parameters. Read Input Registers to learn about any optional parameters you can configure.

Function ID

Register

Value

110

2

Input Registers

Register

Description

Mandatory

Value

390

Face Capture's Parameters

No

Parameters in JSON format. For example:

{ 
   'cameraFacing':'CAMERA_FACING_FRONT',
   'cameraPreviewScaleType':'CENTER_INSIDE'
}

Note

To learn more about the parameters you can use for this function, refer to the Innovatrics' developers documentation. Please note that this is a third-party documentation site.

391

Captured Image ID

No

ID where the captured image is stored. By default, the ID is "faceCapture".

392

Compression Percentage

No

Values go from 0 to 100, being 0 the maximum compression, and 100 being no compression. The default value is 70.

393

Quality Providers

No

List of quality providers separated by a comma. If you want to add new quality providers, you need to add POSITION, PROXIMITY, LIGHT, and FACE_CONFIDENCE.

Output Registers

Register

Description

Value

112

Call Result

000

NO_ERROR

001

API_GENERIC_ERROR

002

API_WRONG_PARAMETERS_ERROR

003

API_SDK_NOT_INITIALIZED

004

INTERRUPTED

005

CAMERA_INIT_FAILED

006

CAMERA_ACCESS_FAILED

007

NO_CAMERA_PERMISSION

014

COMPRESSION_PARAMETER_NOT_IN_RANGE. Only available for iOS.

Liveness Check 2

This function runs a liveness check in second mode, where there is a moving or disappearing object on screen.

Parameter Configuration

This function doesn't require the configuration of any mandatory parameters. Read Input Registers to learn about any optional parameters you can configure.

Function ID

Register

Value

110

3

Input Registers

Register

Description

Mandatory

Value

390

Liveness Check's Parameters

No

Parameters in JSON format. For example:

{ 
   'cameraFacing':'CAMERA_FACING_FRONT',
   'cameraPreviewScaleType':'CENTER_INSIDE'
}

Note

To learn more about the parameters you can use for this function, refer to the Innovatrics' developers documentation. Please note that this is a third-party documentation site.

391

Captured Image ID

No

ID where the captured image is stored. By default, the ID is "livenessCheck2".

392

ID list for every segment's captured images

No

This string contains the IDs where images for all segments are stored. IDs are separated with commas. By defect, the IDs that are used are: livenessCheck21, livenessCheck22, livenessCheck23, livenessCheck24, livenessCheck25, livenessCheck26, livenessCheck27.

393

Segments List

No

This string contains a list of segments that are used during the liveness check, separated with commas. Possible segments to be used are: TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT and BOTTOM_RIGHT.

394

Minimum Segments

No

Numeric value that ranges from 4 to 7 and determines the number of segments that need to be available after the liveness check to be considered valid. Default number is 4, which is the minimum value.

395

Compression Percentage

No

Values go from 0 to 100, being 0 the maximum compression, and 100 being no compression. The default value is 70.

Output Registers

Register

Description

Value

112

Call Result

000

NO_ERROR

001

API_GENERIC_ERROR

002

API_WRONG_PARAMETERS_ERROR

003

API_SDK_NOT_INITIALIZED

004

INTERRUPTED

005

CAMERA_INIT_FAILED

006

CAMERA_ACCESS_FAILED

007

NO_CAMERA_PERMISSION

008

NO_MORE_SEGMENTS

009

EYES_NOT_DETECTED

010

FACE_TRACKING_FAILED

013

LESS_SEGMENTS_THAN_REQUIRED

014

COMPRESSION_PARAMETER_NOT_IN_RANGE. Only available for iOS.

290

Liveness Score

Face Detector

This function provides face detection for an image.

Parameter Configuration

This function doesn't require the configuration of any mandatory parameters. Read Input Registers to learn about any optional parameters you can configure.

Function ID

Register

Value

110

4

Input Registers

Register

Description

Mandatory

Value

390

Max. number of faces to detect

No

The default number is 5, and the max. number is 10.

391

ID that stores the image to be analyzed

No

The default ID is "documentAutocapture".

Output Registers

Register

Description

Value

112

Call Result

000

NO_ERROR

001

API_GENERIC_ERROR

002

API_WRONG_PARAMETERS_ERROR

003

API_SDK_NOT_INITIALIZED

012

NO_FACES_DETECTED

290

Json that contains data from a face detected in an image

<<JSONObject>>. At the end of the json file, there is an "image identifier" field from where you can obtain the ID where the analyzed image is stored.

Note

If more faces are detected in the image, the results will be stored in an output parameter that ranges between 291 and 299. If no faces are detected, the result will be the 012 response, as shown in the table above.

Template Verifier

This function compares a template already stored in the device with an instantly captured image of the user for verification.

Parameter Configuration

This function doesn't require the configuration of any mandatory parameters. Read Input Registers to learn about any optional parameters you can configure.

Function ID

Register

Value

110

5

Input Registers

Register

Description

Mandatory

Value

390

Stored Template ID

By default, the ID is 'livenessCheck2Template'.

The value for the compression of images within this function is 70 by default and cannot be modified.

Output Registers

Register

Description

Value

112

Call Result

000

NO_ERROR

001

API_GENERIC_ERROR

002

API_WRONG_PARAMETERS_ERROR

003

API_SDK_NOT_INITIALIZED

004

INTERRUPTED

005

CAMERA_INIT_FAILED

006

CAMERA_ACCESS_FAILED

007

NO_CAMERA_PERMISSION

011

TEMPLATE_INCOMPATIBLE

290

Verification Score

The image captured to be compared with the template for verification will be saved in the app's 'templateVerifier' token.

Face Image Verifier

This function compares a template already stored in the device with an image stored in another ID of the app.

Parameter Configuration

This function doesn't require the configuration of any mandatory parameters. Read Input Registers to learn about any optional parameters you can configure.

Function ID

Register

Value

110

6

Input Registers

Register

Description

Mandatory

Value

390

Stored Template ID

By default, the ID is 'livenessCheck2Template'.

391

ID of the image to be compared with the Template ID

By default, the ID is 'faceImageVerifier'.

Output Registers

Register

Description

Value

112

Call Result

000

NO_ERROR

001

API_GENERIC_ERROR

002

API_WRONG_PARAMETERS_ERROR

003

API_SDK_NOT_INITIALIZED

004

INTERRUPTED

011

TEMPLATE_INCOMPATIBLE

290

Verification Score

Document Autocapture

This function is used to capture and store an image of a document.

Parameter Configuration

This function doesn't require the configuration of any mandatory parameters. Read Input Registers to learn about any optional parameters you can configure.

Function ID

Register

Value

110

7

Input Registers

Register

Description

Mandatory

Value

390

Captured Image ID

By default, the ID is 'documentAutocapture'.

391

Document Analysis Stage

The default value is 0.

Possible values:

0: No header.

1: Header with visual aid to help capture the front side of the document.

2: Header with visual aid to help capture the back side of the document.

392

Compression Percentage

Values go from 0 to 100, being 0 the maximum compression and 100 no compression. The default value is 70.

Output Registers

Register

Description

Value

112

Call Result

000

NO_ERROR

001

API_GENERIC_ERROR

002

API_WRONG_PARAMETERS_ERROR

003

API_SDK_NOT_INITIALIZED

004

INTERRUPTED

005

CAMERA_INIT_FAILED

006

CAMERA_ACCESS_FAILED

007

NO_CAMERA_PERMISSION

014

COMPRESSION_PARAMETER_NOT_IN_RANGE. Only available for iOS.

Liveness Check

This function runs a liveness check in mode 1, where there is a moving or disappearing object on screen.

Parameter Configuration

This function doesn't require the configuration of any mandatory parameters. Read Input Registers to learn about any optional parameters you can configure.

Function ID

Register

Value

110

8

Input Registers

Register

Description

Mandatory

Value

390

Liveness Check's Parameters

Parameters in JSON format. For example:

{ 
   'cameraFacing':'CAMERA_FACING_FRONT',
   'cameraPreviewScaleType':'CENTER_INSIDE'
}

Note

To learn more about the parameters you can use for this function, refer to the Innovatrics' developers documentation. Please note that this is a third-party documentation site.

391

ID list for every segment's captured images

This string contains the IDs where images for all segments are stored. IDs are separated with commas. By defect, the IDs that are used are: livenessCheck21, livenessCheck22, livenessCheck23, livenessCheck24, livenessCheck25, livenessCheck26, livenessCheck27.

392

Segments List

This string contains a list of segments that are used during the liveness check, separated with commas. Possible segments to be used are: TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT and BOTTOM_RIGHT.

393

Minimum Segments

Numeric value that ranges from 4 to 7 and determines the number of segments that need to be available after the liveness check to be considered valid. Default number is 4, which is the minimum value.

394

Compression Percentage

Values go from 0 to 100, being 0 the maximum compression and 100 no compression. The default value is 70.

Output Registers

Register

Description

Value

112

Call Result

000

NO_ERROR

001

API_GENERIC_ERROR

002

API_WRONG_PARAMETERS_ERROR

003

API_SDK_NOT_INITIALIZED

004

INTERRUPTED

005

CAMERA_INIT_FAILED

006

CAMERA_ACCESS_FAILED

007

NO_CAMERA_PERMISSION

008

NO_MORE_SEGMENTS

009

EYES_NOT_DETECTED

010

FACE_TRACKING_FAILED

013

LESS_SEGMENTS_THAN_REQUIRED

014

COMPRESSION_PARAMETER_NOT_IN_RANGE. Only available for iOS.

290

Liveness Score

In this section: