Au10tix v1.1

This package provides capabilities that extend the Avoka Transact platform for users wishing to provides real-time identity verification using the Au10tix service.

Licensing

Clients must ensure they are appropriately licenses in order to use this package. Organisations who wish to use this package are required to establish a commercial relationship with the 3rd party directly.

Compatibility

This package has the following compatibility requirements:

Module Compatibility Notes
Transact Manager 5.1.3 or above
Transact Maestro 5.0.25 or above

Installation Instructions

To install this package please walk through the following proceedure:

  1. Unzip the package to a directory on your computer
  2. Import each zip archive found in the services folder to Transact Manager under the Services >> All Services menu item.
  3. Review the Help Doc tab for each of the imported services and make any required adjustments to service parameters.
  4. Review the Service Connection requirements under the same Help Doc tab for each of the imported services and make any required configurations to the Service Connection. Service Connections can be configured in Transact Manager under the Services >> Service Connections menu item. Note also the client certificate requirements mentioned below.
  5. Import each archive found in the libraries folder to Maestro. Importing these into the Organisation level libraries folder is recommended as this will make the components available to all projects, however they can be imported at the Project level if required.

Configuring the Client Certificate

The Au10tix APIs are secured by certificate-based authentication. Au10tix will provide a unique client certificate to each calling party. Along with the certificate file(s), you should also receive from Au10tix an instructions document on Installing BOS Certificates. Ensure you follow these instructions carefully to configure your environment correctly, particularly the section relating to Java client applications.

The supplied PFX file will need to be converted to JKS and this JKS file is what is uploaded to the Au10tix Service Connection.

Where modifications to the truststore are required to be performed on an Avoka hosted server, you will need to engage the Avoka Cloud Hosting team to make these changes for you.

Usage Instructions

This package provides 2 Maestro components, one to initiate a document verification event and return a unique session id attribute, and the other to query the results of the verification, passing this same id. The process is split into 2 steps because the document image processing is computationally intensive and can take some time to perform.

With this approach, the form designer can choose to capture the document image data early in the application and initiate the verification process, then make a call later to retrieve the results. This second step includes a 3 second retry facility to continue polling for a conclusive response from Au10tix up to a maximum of 30 seconds (configurable).

Au10tix Verify

This component provides ability to initiate Au10tix identity verification service.

  1. Drag the Au10tix Verify block onto your form in the desired location.
  2. This component contains an attachment field for uploading identity photos and a Verify button. By default it will allow users to upload a maximum of two photos however most document types will only require one so you may want to change this from 2 to 1 by selecting the attachment field and editing the Max Attachments In Queue property.
  3. It is recommended that you provide the user clear instructions for the type of identity document(s) you are asking them to provide.

Clicking the Verify button triggers a call to Au10tix passing the document image(s) and initiating the document processing. The results of this call will include an documentId attribute which can be used in the Get Verify Result component to retrieve the verification status.

NOTE : If you have multiple instances of this block in the form, please make sure each attachment field has a unique "Attachment Name" as well as XML path for submission data. Otherwise the attachments will interfere with each other and may not work properly.

Au10tix Get Verify Result

This component provides ability to check the status of certain identity verification result based on documentId returned by the first component above.

  1. Drag the Au10tix Get Verify Result block onto your form in the desired location.
  2. Configure the Au10tix Document ID Data Field under Input Data on the Properties tab to point to the documentId field in the Au10tix Verify component result data.
  3. In the Result Data section configure the field references for where you want the identity information to be put.

Release Notes

Version 1.1 Sep 28, 2017

  • Preserving returned images in between pages.
  • Fixed getting document ID sometimes doesn't work.

Version 1.0 Jun 1, 2017

  • Baseline release.

Maestro Assets

Au10tix Get Verify Result Library: exchange.au10tix Category: Au10tix

Requests the status and result of a Au10tix ID verification session

Service Calls

Rule Templates

You may add your own logic to handle the following rule types triggered by this component:

  • On Verified : Gets executed when the identity verification is successful and complete
  • On Verify Review : Gets executed when the identity verification needs manually reviewed
  • On Verify Pending : Gets executed when the identity verification is submitted and yet to be processed
  • On Verify Failed : Gets executed upon identity verification terminal failure where the individual could not complete the verification requirements
  • On Data Error : Gets executed upon data error
  • On System Error : Gets executed upon system error

Properties

Property Category Description Type Default
Au10tix Document ID Data Field Input Data

This should be pointing at "documentId" data field in "Au10tix Verify" widget

fieldRef
ID Info Fields Result Data

You can use this property to map extracted ID information to your form fields

Field Refs:

  • firstName : First Name
  • lastName : Last Name
  • middleName : Middle Name
  • dob : Date Of Birth
  • birthPlace : Birth Place
  • address : Address
  • dateOfExpiry : Date Of Expiry
  • documentNumber : Document Number
  • extendedData : Extended Data
  • gender : Gender
  • mrz : Machine Readable Zone
  • nationality : Nationality
  • optionalData : Optional Data
  • ssn : Social Security Number
  • verifiedAddress : Verified Address
  • dateOfIssue : Date Of Issue
  • documentCountryISO3 : Document Country (ISO3)
  • documentType : Document Type
  • documentState : Document State
 fieldRefMap
Au10tix Verify Library: exchange.au10tix Category: Au10tix

Captures ID photos and initiates a new verification call to the Au10tix service

Service Calls

Services

Au10tix - Initiate Verify v2
Provides Au10tix Identity Verification service.

Prevent Multiple Verification Attempt

When service parameter preventMultiAttempt set to true, it will prevent following verification request if any previous verification is FAILED in the same transaction. If this is the case, it will not make another call to the Au10tix web service, but instead will return the FAILED response immediately. It will also write a submission property Au10tix.multipleVerifyAfterFail with value true against the current transaction.

Service Connection

Compatibility

Module Compatibility
Manager 5.1.3

Service Parameters

Name Description Required Default
preventMultiAttempt Prevent multiple verification attempt. If true, will send failed response directly if failed before in same txn. No false
recordResponse Record response text as submission properties. No false
maxAttemptNumber Max number that allowed to initiate Au10tix ID verification in a single session for each applicant. -1 means no limit. Yes -1

Inputs

Name Description Required
attachmentName The attachment name for id photo(s). Yes

Outputs

Name Description
documentId The unique document id for ID verification which will be used to check verify result later
attemptsLeft The number of attempts left for calling this service in the same session (Only available when maxAttemptNumber is configured on server). If this value returns as 0, the server will reject any additional requests and give it a SYSTEM_ERROR with errorCode: EXCEEDED_NUMBER_OF_ATTEMPTS.

Please also note that the attempts number counts separately for each applicant as long as the Attachment Name for each attachment field inside Au10tix Verify Block is unique.
verifyStatus The status of the ID verification for this individual with possible values: [ PENDING | FAILED ]

executionStatus The status of the service execution [ SUCCESS | DATA_ERROR | SYSTEM_ERROR ].

Successful execution will be denoted by a SUCCESS value. DATA_ERROR will indicate that there was an issue identified with the input data that may be resolved and potentially retried by the user. SYSTEM_ERROR indicates that there was an unrecoverable system fault and the form should fall-back gracefully to an alternative path.
errorMessage When a DATA_ERROR is experienced, this value may provide more detail on the nature of the error.
errorCode Error code for some specific error case. Not always available. In this service, EXCEEDED_NUMBER_OF_ATTEMPTS gets returned if current attempt number exceeds maxAttemptNumber defined in the service; REQUEST_REJECTED if server status is "Rejected"
Au10tix - Get Verify Result v2
Provides Au10tix Identity Verification result check service.

Service Connection

Compatibility

Module Compatibility
Manager 5.1.3

Service Parameters

Name Description Required Default
au10tixMaxWaitingSeconds Max waiting time in seconds checking the verify result Yes 30
au10tixDataErrorMap A set of error codes that belong to data error and related error messages. No 0:The converted file too big,4:The converted file too small,5:The converted file contains image which is too big,6:The converted file contains image which is too small,20:The image too big,40:The image too small,100:File extension is not supported,140:Input file size is bigger than allowed maximum size,160:Input file size is smaller than allowed minimum size
recordResponse Record response text as submission properties. No false

Inputs

Name Description Required
documentId documentId from previous Au10tix check Yes
attachmentName attachmentName from previous Au10tix check Yes

Outputs

Name Description
verifyStatus The status of the ID verification for this individual with possible values: [ VERIFIED | FAILED | REVIEW ]
idInfo Identity information extracted from the ID image
executionStatus The status of the service execution [ SUCCESS | DATA_ERROR | SYSTEM_ERROR ]. Successful execution will be denoted by a SUCCESS value. DATA_ERROR will indicate that there was an issue identified with the input data that may be resolved and potentially retried by the user. SYSTEM_ERROR indicates that there was an unrecoverable system fault and the form should fall-back gracefully to an alternative path.
errorMessage When a DATA_ERROR is experienced, this value may provide more detail on the nature of the error.

Service Connections

The following service connections are used by this package.

Au10tix
Property Name Description Required
Type HTTP Endpoint Yes
Endpoint The Au10tix service base endpoint - e.g.:
  • Europe: https://euxbos.cloudapp.net/Au10tixBos2/
  • USA: https://usxbos.cloudapp.net/Au10tixBos2/
 Yes
Username Not used No
Password Enter the password used to access the JKS file Yes
Data File Au10tix will provide the client certificate files required to access their service. These certificates should be used to generate a JKS file containing both public and private keys and this JKS file should be uploaded here. Yes