Description of primary system objects in JSON responses
Typical data structure describing a system object is used in JSON responses to requests submitted to the system. Below you will find a detailed explanation of information in such descriptions.
Object USER
- "user_id": "" - unique identifier of the user in the system
- "user_type": "" - user's role in the system
- "first_name": "" - name of the user
- "last_name": "" - name of the user
- "middle_name": "" - name of the user
- "email": "" - email address of the user
- "can_start_analyse_****": true\false - user’s rights to use system modules (to run analyses of different types)
- "company_id": "" - unique identifier of the user's company in the system
- "is_admin": true\false -this parameter defines administrator access rights within one company (CLIENT ADMIN role)
- "is_service": true\false - this parameter defines service accounts
Object COMPANY
- "company_id": "" - unique identifier of the company in the system
- "name": "" - unique identifier of the folder in the system
Object FOLDER
- "time_created"\"time_updated" – time of creation/update of the folder
- "meta_data" – folder metadata
- "folder_id" – unique identifier of the folder in the system
- "resolution_status" – folder status
Object MEDIA
- "time_created"\"time_updated" – time of creation/update of the file
- block "tags" – tags of the file
- "original_name" – original name of the file (in the client's file system)
- "image_id" – unique identifier of the file in the system
- "original_url" - HTTP link to the file in the API server
Object ANALYSE
- "time_created"\"time_updated" – time of creation/update of the analysis;
- "analyse_id" – unique identifier of the analysis in the system;
- "folder_id" – unique identifier of the folder with analysis data in the system;
- "type" – type of the analysis (BIOMETRY/QUALITY/DOCUMENTS);
- block "results_data" – details pertaining to the analysis result; values depend on the type of the analysis:
- BIOMETRY - minimal and maximal hit rate for faces in photos in the folder, value within the range 0–1. If a folder includes three or more different images, the minimal and maximal hit rates will not be equal.
- QUALITY – probability that a face on the photo belongs to a “living” person (not taken from digital/paper media), value within the range 0–1.
- DOCUMENTS – results of document recognition.
- "error_message" – error message
- "error_code" – error code
- block "source_media" – this block contains information on original images submitted for analysis.
- block " results_media" – this block contains information on images processed during analysis.
- "resolution" – resolution for the analysis. Available options
- SUCCESS - A positive resolution is taken for the analysis
- DECLINED - A negative resolution is taken for the analysis
- OPERATOR_REQUIRED - An operator should take resolution
- PROCESSING – Analysis in progress.
- FAILED – Technical errors occurred during the analysis