Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
The Oz web console is used to administer analysis orders, simplify testing of sending analysis orders and view detailed analysis results.
Available languages: EN.
In this guide, you'll learn how to work with users and companies in Oz WebUI.
In the screenshot: button 1 – to edit a user, button 2 – to edit a company, 3 – to delete a user.
Click the Add Company button in the Users (or Companies) tab.
Enter the name of the company and click the Submit button in the window that appears.
Click the Add User button on the Users tab.
2. Fill in the fields:
Company – select from the dropdown menu. You can also add a company here by clicking the Add company button. You just need to fill in the Company name field in the new window and click Submit. Please note: ADMIN and OPERATOR can't belong to any company. If you choose a company for a user with one of these roles, it won't be saved.
Email – mailbox. It will be the user's login.
Password, Confirm password, or use automatic password generation by clicking the Generate password button. Next to it, the gear button opens the password generator settings window.
Last name and First name fields are mandatory to fill. Middle name is optional.
User type – select the user role from the dropdown menu. Please note: for CLIENT, CLIENT ADMIN, or CLIENT OPERATOR, you can also enable the Service account option. This option extends the authorization time. Please find the additional information on user roles here.
The Send credentials block of checkboxes allows you to choose where to send the credentials of this user: to you, to this user's email, or to another e-mail.
Can start analyses – you can disable any analysis for a user if needed. In this case, this user won't be able to make the appropriate requests.
Once you finish filling in the fields, click the Submit button.
You can edit the company in the Users or Companies tab by clicking on the company in the list or on the Edit company button.
In the Edit Company window, in addition to editing the name, you can add Report Templates.
To edit a user, proceed to the Users tab and find the one you want to edit. Use the Filter tool if needed.
To delete a user, click the trash bin button near the user's name. Please note: a user cannot be deleted if they have any orders.
Once found, click the user’s name or the Edit user button next to it. A new window will appear.
Here, you can:
change the user’s email;
change the user’s password – mark the Change password checkbox and fill in the form that appears;
switch the user off if they are not active anymore – unmark the User is active checkbox;
change first, middle, and last name in the appropriate fields;
switch on or off analyses the user can request.
The user account can be opened by clicking on your username in the top-right corner. Next to it, there is the logout button.
In the Language drop-down menu, you can change the Web UI language. Please note: your choice won't affect the report templates, as these templates are being uploaded separately.
To change your password, click the Change password button. Fill in a password changing form that opens.
Once you're done, click the Submit button.
Click the Create order button on the Orders tab.
2. Select media files to upload to the system or drag and drop them to the selected area.
3. After the download is complete, the analysis types become available for selection. By default, there are all possible checkboxes.
Document check – recognition and verification of the document fields.
Uncheck the (or not installed components) analysis types you don't need.
4. Next, select tags – the type of content for each uploaded file and at the end click the Submit analysis button.
Options for choosing the Document type (you can load several pages of one document at once):
Document with photo
Document without photo
if there is a face in the image, not a document, select the Selfie content type.
For videos, only Selfie is available along with qualifying tags:
orientation: Portrait or Landscape
Please note: if the tags are chosen incorrectly, the analysis results might be flawed.
5. Upon the analysis completion, you'll see the results for the previously selected analysis types:
analysis succeeded – everything went fine;
analysis failed – faces don't match, Liveness check failed, an error emerged during the processing, etc.;
operator required – this means the system requests for the additional check made by your employee.
To get the detailed result for a specific type of analysis, click on the mark near the analysis' name.
OPERATOR and CLIENT OPERATOR can change the analysis verdict. These roles have access to an additional button: Make decision.
To change the verdict, the user should select the decision from the drop-down menu and click Apply.
Once analyses are finished for a folder, this folder gets status according to the analyses' results:
SUCCESS– everything went fine, all analyses completed successfully;
OPERATOR_REQUIRED – there are no analyses with the DECLINED status, but one or more analyses have been completed with the OPERATOR_REQUIRED status;
DECLINED – one or more analyses have been completed with the DECLINED status.
The other two statuses that you might encounter are FAILED and INITIAL. FAILED means that one or more analyses are finished with an error. INITIAL stands for folders with no analyses applied.
A report on the study will be available in the PDF format by clicking the PDF list button (1) from the list of orders. For this option to become available, you should have a pre-configured report template for your company.
Any order can be deleted either by clicking the Trash bin button from the list of orders (2) or by clicking the Delete button from the order form.
Analysis orders can be filtered by several parameters. The scope of visibility is limited by the access rights of your user's role.
In the Orders tab, click the Filter button
you can use one or more fields for filtering:
Order number – enter the full alphanumeric order number or type the first few characters.
Date/time – the range of dates of orders' creation.
Company – the company that owns the orders.
Manager – the user who created the orders.
Consolidated folder status – the overall analyses' result for the folder.
Analysis type – the type of the analysis applied.
Analysis result – choose the result to display all orders where one or more of the analyses have been completed with this result.
Meta – you can filter orders by specific meta tags by adding their name and value using the Add button. A meta tag is any information that a programmer can transmit when submitting an order via API. Enter the name and range of values into the field manually.
After filling in the fields, click the Search button.
To reset the current filter, hit the Reset button.
The Settings tab contains settings for connecting to the Web API. Click the Edit or Add Server buttons to fix them or add a new server, respectively.
fill in all the fields to add a new server:
Server name – the name of the API server you are using
API URL – the address of the API server you are using
Access-token – the authorization token of a user with OZ API administrator rights
Login and Password – their login and password
once finished, click the Submit button.
About program shows the current version of the interface.
The blacklist check algorithm is designed to check the presence of a person in the database of pre-loaded photos. This base is called the BlackList.
Select your Company in the Users tab.
2. Click the Add button (1) in the Image collection section in the Edit company window. In the window that appears, enter any name for the blacklist base (2), for example, "BL" or "Blacklist 2022", etc. Click the Submit button (3) and Submit (4) again.
3. When the company is reopened from the list of users, you will see the created collection of images – BlackList. It can be opened by clicking on its name, synchronized, edited (with images added), and deleted if necessary. You can create any number of lists.
Select your Company in the Users tab.
In the window that appears, in the Image collection area, select the required blacklist and click the Edit button (or the name of the blacklist).
3. In the area that opens, click the Add button.
4. Click the Add button in the window that appears. Upload a photo from your computer. Next, specify the Content Type, for example, Selfie. The First Name, Middle Name, Last Name fields are optional. This data can be filled in later by choosing to edit the image from the Persons list. When finished, click the Submit button.
. In the Edit company window, click the Synchronize button (it will be highlighted in red) and then the Submit button.
Please note: the sync button will be grayed out and start spinning. You do not have to wait for it to stop, as it can take a long time (up to 10 minutes).
Select your Company in the Users tab.
In the window that appears, in the Image collection area, select the required blacklist and click the Edit button (or the name of the blacklist).
In the opened area in the Persons list, find the required image and click the Delete button next to it.
4. Confirm the deletion: in the window "Delete person?", click Delete.
– comparing multiple photos and assessing the level of similarity.
– compare the uploaded photo with the scammers' photos from the blacklist database.
– an algorithm for determining liveliness is designed to check the presence of a living person by a short video fragment. The checkbox is available for selection only when uploading a video.
type of action (what action was performed by the person in the video): scan, turn left, turn right, turn down, turn up, smile, close eyes. The video with a certain type of action is recorded via the and . For regular videos, use the Scan tag.
WebUI changes
Updated the report template to match the new Kazakhstan regulatory requirements.
Disabled the automatic new order checking functionality in the Orders section to reduce server load and database traffic.
You can now refresh the Oz Web UI page manually, while keeping the filters and graphs applied earlier. This is available for the Orders, Users, Companies, and Statistics sections: just click Refresh. In the paginated sections, it also redirects to the first page.
The company filter for the CLIENT ADMIN role is now being applied automatically.
Deleted the data format field from the account settings.
Fixed an issue where seconds were not displayed in the Date/Time column and header of the exported report.
Bug fixes and security updates.
Updated the default report template.
The time filter now works properly for reports.
The Analyses duration bar chart now works properly.
Fixed the displaying of the Amount of Orders by Company chart.
Fixed minor bugs related to the blacklist photo displaying.
Updated the chart list, now you can create a chart according to:
Amount of orders by summary status,
Amount of orders by source,
Amount of analyses by type,
Amount of analyses by result type,
Amount of orders by company,
Analyses duration.
You can now check the API version in Settings.
Added new filters to the Orders section: "Analysis Type" and "Analysis Result".
The useless synchronization collection button is deleted.
Company deletion and report creation now work properly.
You cannot now delete a user with an order associated with them.
A user can review the images in analyses’ results even if they don’t have API access.
Once open in an order, media doesn’t get downloaded automatically anymore.
Line chart hints when the chart has several rows are now easier to read.
Fixed the minor bugs related to analyses and filters.
Updated the filters and charts logic.
Improved the report form.
Improved the work of Companies and Orders sections.
Improved and optimized the Statistics module.
Reports are now available in English.
Renamed the Date field in filters to Date/time.
Updated the password change workflow.
Updated the report form.
Changed options in the list of Operator decisions.
Time filter on the Statistics page now works better.
Deleted the useless Add Company button in the user editing form.
The Statistics module now works better.
On the statistics page, the date filter now works properly.
If you choose to email credentials upon the user creation, and this email can't be delivered, the system won't create this user
Fixed a bunch of bugs.
Deleted the PhotoExpert/Image Forensics analysis which hasn't been supported for a long time.
On the Statistics page, added a company filter.
Administrators obtained the rights to switch users on and off. Requires API v 3.31.0.
Charts for meta fields are back.
Added the best shot view to the Quality and Liveness analysis.
Updated to Laravel 8 and PHP 8.
You can now see how much time it takes to analyze.
In statistics, company IDs are replaced by company names.
Added the folder ID to the report filename.
If you have several report templates, when creating a new report, you’ll be prompted to choose a report. The automatic selection is removed.
Changed the folder creation process: the API profile can_start_analyse_* now determines whether an analysis can be launched or not.
You can now manage the can_start_analyse_* user profile fields.
When managing user, Admin or Client Admin can’t change the fields of can_start_analyse_* without having the access to it.
Changed the authorization via API.
Added a chart for the number of folders.
Fixed the date/time folder in the folders list.
Added the date/time folder to the folders list.
The timezone has been moved to the user profile.
Added a bar chart.
Added the analyse.state filter.
Now you can export folders as .xls.
Saving a set of charts now works properly.
Added new client charts.
Added labels for the pie chart.
You can now search for users via search_text.
Removed the metadata charts.
Cleared the default charts list.
Added a new chart.
The Statistics link is now seen in the menu (with permissions and if the statistics exist).
0.6.27:
Charts now can be saved; once saved, they are displayed opened in statistics.
Localized charts.
Added new statistics.
Added a shot set support – media SHOTS_SET_FOLDER.
Added the statistics module.
Manual decisions now can be changed.
Added client libraries for date/time displaying and improved client timezone recognition.
Fixed date/time displaying.
Added text wrapping for long metadata.
Added the Client Operator role.
Added manual decisions – a human can check whether the algorithms were right or not, and change the analysis result.
Added manual decision displaying.
Added buttons to view and make a decision.
Only Admin и Client Admin can see an analysis deletion button.
Added the timezone offset – it is stored in cookies and is added to timestamps on the client side. The offset can be removed using js.
Fixed the server-side timezone offset.
Added a default report template (.rml).
Added a customizable password generator .
Added the password generation customization interface with testing.
You can now send the user data via email. For additional recipients, use mail.use_bcc.
Added a default company template.
You can now create a new company while adding new users.
Added video orientation tags.
The list of available analyses now changes dynamically depending on what files you upload.
Added a file list check on the server side. When the folder is created, we check what media are included in it, and upload only the appropriate analyses.
You can see the program version in the Settings section.
The Quality analysis result now displays only spoofing chances.
Added a customizable date formatting for documents analysis.
Removed the resolution status filter for the folder list.
Changed the analyses queue forming method upon the folder creation.
Added folder filters: ID, user, company, resolution. You can hide them if needed.
Added the Photo Expert analysis.
Added the backside document check.
Folder owner details are now displayed.
Regarding the user role, you might see an owner with their name, email address, and company.
The User role doesn’t have access to see the folder owner.
Only Admin and Operator can see the owner company.
When you do something with a collection, its status updates.
Fixed a bug related to filter fields deletion in the view folders section.
The synchronization button gets animated when synchronization is needed.
Changed the template and parser for the blacklist analysis.
In the collection person list, names are now displayed.
Users without company no longer see the company editing button.
You can now manage the collection rebuilding – status indication, errors, status check.
Changed the template management process.
You can now download the source files.
Fixed user management.
You can now manage templates and collections (add/delete).
You can now add, edit, delete persons to collections, and work with related images.
Updated the interface.
Editing a company also allows managing its templates and collections.
Now you can delete a folder while viewing it.
Added labels to the user management buttons.
Fixed content-length for new cURL versions.
Added the “Errors only” filter to the documents' analysis results.
Switched off the liveness result in the Quality analysis.
Fixed errors in user and company management.
Added resolution status.
Fixed reporting errors: from now on, to create a report a company should have at least one template.
Fixed image tags.
You can now see how many folders have appeared since you started to view the current folder list.
You can now select what analyses to launch.
Fixed errors in long keys.
Removed the temporary users.
Removed the unnecessary timestamps.
User links (especially companies) are fixed.
The Statistics module allows you to collect and analyze data on the use of the Oz Forensics system.
When you switch to the Statistics module, the charts area is empty unless you have the previously saved graphs. The area of charts is divided according to the purpose of the information on the tabs:
Common info
Performance
When created, the chart appears in the corresponding tab.
Click the New chart button to create a chart.
Select the type of chart from the dropdown list.
3. Click the Create button.
The chart will be displayed in the tab corresponding to its type. There are 1-3 display options for charts, depending on their type: Line, Donut, and Bar. By default, the charts are displayed with the All Results option, filtered by the current week.
The Line Chart
2. The Donut chart
3. The Bar chart
4. Click the cross button to remove the chart from the viewing area.
5. To download the graph image, click the button. The system will offer to save the image in the PNG format.
6. To change the options for displaying data on the chart, select them from the dropdown menu. The default is All Results. Options may vary depending on the type of chart.
7. Click the Save Charts button to save your favorite charts to the screen. The saved graphs will be loaded automatically the next time you enter Statistics.
The summary status of the order displays the worst result among the analysis results for this order. For instance, if one of the group of analyses has finished with the DECLINED status, the order status will be DECLINED as well.
The order result receives the status of the last group of analyses applied to the folder. A group of analyses contains analyses you've sent in a single order.
Chart options:
All Results – displays the sum of all results
Any result – showing all results on one chart separately, except for the All results option
Processing – results, where the analysis is in the "Processing" status
Failed – Analysis results with the error message "Failed"
Declined – the results of analyses, which indicate a low percentage of similarity with the reference image, or indicated inconsistencies in the fields of the document (depending on the modules)
Success – the results of analyses, which indicate a high percentage of similarity with the reference image, or indicate the full correspondence of the document fields (depending on the modules)
Operator Required – Analysis results, where the average percentage of coincidence is indicated and a decision by the operator is required
Available display options are Line, Donut, and Bar charts.
The amount of orders by source, where these orders came from.
Chart options:
All sources
Any source
Unknown
Mobile SDK
Web SDK
Available display options are Line, Donut, and Bar charts.
The chart shows the users of which companies, how many orders have created during the period. This chart is displayed on the User Activity tab.
Chart options:
All companies
Any company
ID of each company
Available display options are Line, Donut, and Bar charts.
The chart shows how many analyses and which type were generated during the period.
Chart options:
All analyses
Any analysis
Documents
Biometry
Liveness
Black list
Displays on the Common Info tab. Available display options are Line, Donut, and Bar charts.
The chart shows how many results by type of analysis were obtained during the period.
Analysis chart options:
All analyses
Any analysis
Biometry
Documents
Liveness
Black list
Chart options by analysis results:
All results
Any result
Processing
Failed
Declined
Success
Operator required
Displays on the Common Info tab. Available display options are Line, Donut, and Bar charts.
The chart shows the duration of analyses by their types, depending on the number of analyses performed. Together with the total number, the number of analyses execution time is displayed: minimum, arithmetic mean and maximum analysis execution time.
Chart options:
All analyses
Any analysis
Black list
Biometry
Liveness
Documents
Displays on the Performance tab. Available display options are Line and Donut charts.
You can filter your charts by the time period. Click the Filter button.
The period This week is selected by highlighting in color by default. You can select any other period from the standard Last month, This month, Last week, etc., or specify a custom period in the Date field.
Make sure that none of the standard periods is selected before setting a custom period. If a standard period is selected, click on it to deselect it.
Select the start date of the period, time (if you need), and the date and time of the end of the period. Click the Search button. The filter window will close, and the new result will be displayed on the chart.
Example. The period 04/20/2021 00:00 – 04/23/2021 00:00 will display the results for 3 days: April 20, 21 and 22.
Click the Clear button, then the Search button to reset the filter.
To view a report based on the analysis results, configure the required filter by the report period, then click the Make report button. The system creates the report in the XLS format and makes your browser download it.
Please note: the only filter applicable to this report is based on dates. If you require detailed order statistics, such as filtering only Liveness analyses or only DECLINED ones, consider one of the following options:
For overall information: create a chart of the required type.
For detailed information with order numbers: utilize Filters in the Orders tab.
Alternatively, filter the generated XLS report using Excel tools.
Name of the row
Description
Report for the period
A period of time of statistics, by default, it is the current week from Monday to Sunday (can be changed in Filter).
Orders per period
The number of orders created during this period.
No analyses applied
The number of orders with no analyses performed.
Processing
The number of orders with analyses that are being performed during the report creation.
Failed
The number of orders where one or more analyses have been finished with some kind of error.
Declined
The number of orders where one or more analyses have been finished with the DECLINED status (an attack spotted, the images haven't matched during the biometry check, etc.).
Operator required
The number of orders where the system was uncertain about the analysis result and requires an additional check from the human operator.
Success
The number of orders where every single analysis has been finished successfully.
Name of the column
Description
Date / time
The date and time when the order has been created.
Consolidated folder status
The overall order (folder) status.
Video count
The number of videos in this order.
Image count
The number of images in this order.
Analyses
What analyses have been applied to the media in this order.
Reason of rejection
Folder
The folder (order) ID.
IIN
What analyses have been finished with the FAILED or DECLINED .
A client ID if it has been passed in the folder (order) (the client_iin field).
