QES System URLs
Types
The relevant systemUrl types for QES are "callback" and "redirect." The callback URL is invoked after the process is completed and includes the extID of the corresponding process in the request body. Once the process is finished, the user is redirected to the provided redirect URL.
Please note that the "review-callback" type mentioned in the fidentity documentation is not applicable for QES.
Statuses
Created
This state occurs as soon as a process was set up (successful call).
Started
This state occurs as soon as the user clicks on the link for identification and initiates the process.
*Review-pending
This state occurs when the identification is completed, and the data enters the review phase. Here, the information provided by the user is checked for accuracy.
Reviewed
This state is reached when the review of the provided information is completed, and a final decision (OK or NOK) has been made.
Success
This state is triggered when the document has been successfully signed.
Session-expired
This status indicates processes where the session duration has expired. It occurs four hours after the process was initiated (while in the 'Started' status) or after the third click on the URL (one time token).
Abort
This state occurs when the user prematurely ends the identification process by closing the process (by clicking "abort" (X)).
Error
This state arises when a user is underage, hails from a non-supported country, or if fraud is identified by a review agent. Blocking occurs either after agent review or before the user completes the sign-up process. The verification status is labeled as 'blocked,' and the specific reason for the cancellation is displayed under 'cancelReason.
The review-pending redirect URLs (inside and outside operation hours can be hard coded, please specify accordingly to fidentity).
The "warn" state mentioned in the fidentity documentation is not applicable for QES Hybrid and Review only.
Subtypes
insideOperatingHours
Configures a redirect during agent review within operation hours. Only applied to type 'redirect' with the state 'review-pending'.
outsideOperatingHours
Configures a redirect during agent review outside operation hours. Only applied to type 'redirect' with the state 'review-pending'.
Verification states
The relevant verification states for QES come into play when retrieving processes via GET, and are as follows.
Created
This indicates that the process was created (POST occurred). No further activities have taken place.
Started
This state occurs as soon as the user clicks on the link for identification and initiates the process.
Review-pending
This state occurs when the identification is completed, and the data enters the review phase. Here, the information provided by the user is checked for accuracy.
Reviewed
This state is reached when the review of the provided information is completed, and a final decision (ok or nok) has been made.
Processed
At this state, the process has been successfully completed.
Aborted
This state occurs when the user prematurely ends the identification process by closing the process (by clicking "abort" [X]).
Blocked
This status is the counterpart of the Error SystemUrl, which can be set at POST. This state arises when a user is underage, hails from a non-supported country, or if fraud is identified by a review agent. Blocking occurs either after agent review or before the user completes the sign-up process. The verification status is labeled as 'blocked,' and the specific reason for the cancellation is displayed under 'cancelReason.
Expired
This status indicates processes where the session duration has expired. It occurs four hours after the process was initiated (while in the 'Started' status) or after the third click on the URL (one time token).
Please note that the statuses Processed, Aborted, Blocked, and Expired represent final processes, meaning they cannot be altered anymore. On the other hand, processes in the Created, Started, Review-Pending, and Reviewed statuses can still undergo changes.
Last updated
