• As a description of the following paragraphs: a brief introduction of what each front-end process page does.
• On the right side next to the images: a brief description of every customizable element of the process.

Anything not mentioned below cannot be customized, such as the content of the texts.

Switch-to-mobile 

Two options for the user who starts from a desktop to switch to a mobile device equipped with a camera.

SMS or QR code.

The SMS sender name can be customized, but not the content of the message, as told before.

Process detection tips

Reminder for the user with two suggestions to facilitate further detections.

First document, how to scan

Description of the document and side to provide at the device camera in the next detection step.

First document acquisition

In this step, the user, guided by the tips at the top of the screen, can automatically detect and scan his main document without pressing any button.

Second document, how to scan

Description of the document and side to provide at the device camera in the next detection step.

Second document acquisition

In this step, the user, guided by the tips at the top of the screen, can automatically detect and scan his secondary document without pressing any button.

Switch-to-desktop

At this point, for the user who started the process from a desktop, is time to return there.

Otherwise, the user who started directly from mobile will continue on his device and won’t see this screen.

Greetings page

The Phyon Identification process is now completed.

The user resumes the experience on the customer’s informative system UI and the outcome of the back-end identification results and data are sent to the customer via callback.

Live Document acquisition

This mode foresees a front-end GUI.

The following diagram shows the sequence of interactions between Client and Phyon.

Document OCR

This mode does not include a front-end GUI but consists of a back-end only integration that includes the OCR service.

The following diagram shows the sequence of interactions between Client and Phyon.

In order to start a Phyon Identification process, you have to set correctly some payload fields of applications API

Context

CustomerApplicationId

Unique identifier for the application for the client. Uniquely identifies requests belonging to the same “logical” conversation.

Organization

Organization identifier. (This value will be provided to the client)

OrganizationUserId

This field allows requesting a custom front-end layout for the process. To use the default front-end layout, this field has a constant value equal to -1. (In case of a custom layout value will be provided to the client)

Scenario

Scenario code.

Domain values:

• STD_DOCUMENT_ACQUISITION (Live document acquisition scenario)
• STD_DOCUMENT_OCRIFICATION (Document OCR scenario)
• STD_EXPORT_DATA (Export data scenario)

Scenario version

Constant value.

Value: “1.0.0”

Process

Process code.

Domain values:

• STD_DOCUMENT_ACQUISITION_SELFID___IT

Process version

Constant value.

Value: “1.0.0”

SubjectDocumentType

DocumentTypeCode

Up to two documents from the lists below can be configured at design time for the detection to be performed by the users.

For instance, you can have: DE_ID_ECARD (German electronic identity card) + GENERIC_PP_CARD_CLASS (generic booklet).

Domain default values for the “Try it out” feature available on the API Reference page:

• ITA_ID_CARD (Italian identity card) + ITA_HEALTH_CARD (Italian health card)
• ITA_ID_ECARD (Italian electronic identity card) + ITA_HEALTH_CARD (Italian health card)
• ITA_ID_ECARD_OLD (Italian old electronic identity card) + ITA_HEALTH_CARD (Italian health card)
• ITA_PP_CARD (Italian passport) + ITA_HEALTH_CARD (Italian health card)
• ITA_DL_CARD (Italian driving license) + ITA_HEALTH_CARD (Italian health card)
• GENERIC_PP_CARD_CLASS (generic booklet)
• GENERIC_ID_CARD_CLASS (generic card)

Some examples of additional custom process domain values available after a dedicated process configuration:

• GENERIC_ID_ECARD (electronic identity card with mrz)
• GENERIC_PP_CARD (passport with mrz)
• AT_ID_ECARD (Austrian electronic identity card)
• AT_DL_CARD (Austrian driving license)
• AT_DL_CARD_OLD (Austrian old driving license)
• AT_PP_CARD (Austrian passport)
• DE_ID_ECARD (German electronic identity card)
• CZK_ID_ECARD (Czech electronic identity card)
• CZK_ID_ECARD_OLD (Czech old electronic identity card)
• SVK_ID_ECARD (Slovak electronic identity card)
• IRL_DL_ECARD (Ireland driving license)
• IRL_LP_ECARD (Ireland driving learner permit)
• IRL_PP_CARD (Ireland passport booklet)
• IRL_PP_ECARD (Ireland electronic passport card)
• CH_ID_ECARD (Swiss electronic identity card)
• CH_DL_ECARD (Swiss driving license)
• CH_PP_ECARD (Swiss electronic passport card)
• CH_RP_CARD (Swiss residence permit booklet)
• CH_RP_ECARD (Swiss residence permit card)

… these are only a few examples, Phyon currently supports 176 countries worldwide.

STD_DOCUMENT_ACQUISITION – Live document acquisition

Document Sample

STD_DOCUMENT_OCRIFICATION - Document OCR

Document Sample

STD_EXPORT_DATA – Export data

Document Sample

When a user completes a web session, Phyon process communicates to the client application in two ways:

• Through a callback on back-end side for the process result (Success or Failure)
• Through a post-message on front-end side for the process end in order to allow proceeding with client workflow

Back-End

There are two types of back-end callback

• Process result - A callback to notify the outcome at the end of the process
• Export Archive – A callback to upload the archive with all data collected at the end of the export

For both types, you have to expose an endpoint protected with basic authentication.

Process Result - Payload example

Document Sample

Process Result – Payload fields

Context

Refer to paragraph 3.1.

OcrDocumentResults

This field contains data read by the OCR service for each document.

The DocumentFields – FieldType could have these values:

• LastName
• FirstName
• DateOfBirth
• PlaceOfBirth
• ProvinceOfBirth
• DocumentNumber
• CountryOfBirth
• CountryOfBirthCodeCrif
• IssuingCountry
• IssuingPlace
• IssuingAuthority
• IssuingDate
• CardExpirationDate
• Gender
• TaxCode
• AddressLocality
• AddressStreet
• Nationality
• CardNumber
• AddressProvince
• AddressStreetAddressType
• AddressStreetStreetName
• AddressStreetStreetNumber
• AddressStreetPlace
• AddressStreetProvince
• AddressStreetZipcode
• DocumentClassCode
• IssuingState
• PersonalNumber
• DateOfEmission
• ExpiryDate
• Signed
• Warnings

AdditionalData - ACQUISITION_METHOD

The code could have these values:

• LIVE_DOCUMENT_ACQUISITION
• FILE_UPLOAD

Status

The code could have these values:

• COMPLETED
• COMPLETED_WITH_ERROR

Export Archive – Payload example

Document Sample

Export Archive - Files Naming Convention

There are the following naming conventions for files contained in the archive:

• Image filename
  • [SUBJECT_DOCUMENT_TYPE]_[CUSTOMER_APPLICATION_ID]_yyyyMMddHHmmssSSS.pdf
• Callback file name contained in an archive
  • CALLBACK_[CUSTOMER_APPLICATION_ID]_yyyyMMddHHmmssSSS.pdf

Front-End

After Phyon application initialization, the client has to embed in its application Phyon Front-End, typically using an iFrame.

In this scenario, the "urlToRedirect" present in the API application response has to be used as "src" (source attribute) in the iFrame definition.

iFrame Sample

Post-Message

At the end of the process, Phyon Front-End will communicate through post-message.

In order to handle this message, it can be defined as an event listener.

Hereby is reported the currently supported set of browsers and versions. The most recent older versions (and upward) are considered working as well, subject to the presence of a valid WebRTC protocol support. A newer version will be anyway verified and confirmed from time by time:

• Compatibility matrix download