Advance Notices - 1.0.16.5

The following are advance notice of changes that will be implement in upcoming releases that user should be aware of. The purpose of these notifications are to provide users time to plan any corresponding updates they may be required to make.

When the release version / date is known, the advance notice item will be updated.

Userdata API

Proposed Release: 1.0.16.6

A number of changes are being made to the GET User Data API response. There is a known issue with the API currently where different responses are returned based in the 'isOptimized' API parameter. The following changes will be made:

A new version of the GET User Data API will be introduced. At this time the previous version of the API will be deprecated and customers will be advised to move to the new version of the API before the API is removed. When the new API is introduced a migration guide for the new API will be provide. It is planned that the new API will be broadly similar with the following changes:

When the isOptimed flag is set to false or not set, the following data will be returned if present:
- watchlist
- review
- keyedAdditionalDocuments
The API will no longer return empty attributes at the root of the API such as cloudFunctions , faces etc.

This update will have an impact on any customers who consume the API and use 'review', 'watchlist' or 'additional document' capability and do not 'ignore unknown' attributes in the response. Customer who fit this criteria will need to update their response handling in advance of the release.

The Report Names

Proposed Release: 1.0.16.6

As part of the GET User Data API response a report structure is returned which includes a number of reports for the Face and Document. The reports include:

id: an identifier of the report.
name: a human readable name for display purposes.
description: a human readable description for display purpose.
outcome: an enumerated value corresponding to the outcome for the report.

For example:

Javascript
    
 
{   "acceptableDocumentIssuer": {    "id": "acceptableDocumentIssuer",    "name": "Acceptable Document Type - Document Issuer",    "description": "Check to ensure that the document issuer is in accordance with the user's selected country.",    "outcome": "APPROVE"    }}
Copy

The value of the name field will be updated in order to provide improved clarification for 'Acceptable Document Type' report. The change in name is being introduced in order to avoid confusion with naming.

Old Name	Updated Name
Acceptable Document - Document Age	Acceptable Document Type - Document Age
Acceptable Document - Document Issuer	Acceptable Document Type - Document Issuer
Acceptable Document - Document Expiry	Acceptable Document Type - Document Expiry
Acceptable Document - Document Classification	Acceptable Document Type - Document Classification
Acceptable Document - Overall	Acceptable Document Type - Overall

Session & Checks

Proposed release: TBC

The Checks resource as part of session data contains the following unused attributes:

ageCheck
soundexChecks
documentFormatChecks
documentNumberChecks
covivaChecks

The resources are now considered deprecated and will be removed in a future release.

If a customer is using these attributes they should update to remove reference to these attributes of session data. Areas of impact include variable substitution (custom data forms, webhooks, email etc) and cloud function

Last updated on