Folder [SINGLE] method (GET)

Folder [SINGLE] method is used to view a single folder by its “folder_id”.

Additional Request Parameters.

All parameters for this method are optional and can be added to the request headline, as necessary.

folder_id - unique identifier of the folder, mandatory parameter.

Output of additional information in the response:

with_analyses=true;
Enabling this optional parameter will display analysis results in the JSON response of the relevant method similarly to Folder Analyses [LIST];
with_user=true;
Enabling this optional parameter will display information on the user who created the folder in the JSON response;
with_company=true;
Enabling this optional parameter will display information on the company to which the user who created the folder belongs in the JSON response.

Request Examples.

Example of running the Folder [SINGLE] method in Postman:

Examples of GET request syntax using Folder [SINGLE] method with following parameters:

Folder ID “7e782ba3-be59-42bb-a1d4-cdd51b57a716”;
Display of user who created the folder;
Display of the company to which the user who created the folder belongs;
Display of analysis results in the folder.

HTTP

Bash

Python

php

Java


GET /api/folders/7e782ba3-be59-42bb-a1d4-cdd51b57a716/?with_analyses=true& with_user=true& with_company=true HTTP/1.1
Host: youradress.ru
X-Forensic-Access-Token: 0ccbdb4627c9d07c6c5b8f6e6cca44b5f8cb0c54ad7659098fa336240d494b0f9035e14bc42fc461224a9719f105e41026fed0f6f14188d9107b8c3d697a0cb1
User-Agent: PostmanRuntime/7.15.2
Accept: */*
Cache-Control: no-cache
Postman-Token: 5261841c-b05b-4f00-9b04-e9fa25efc9ba,c5373b7c-f19b-4357-be8a-e9c6ba8f1fbb
Host: youradress.ru
Accept-Encoding: gzip, deflate
Connection: keep-alive
cache-control: no-cache


curl -X GET \
  'https://youradress.ru/api/folders/7e782ba3-be59-42bb-a1d4-cdd51b57a716/?with_analyses=true&with_user=true&with_company=true' \
  -H 'Accept: */*' \
  -H 'Accept-Encoding: gzip, deflate' \
  -H 'Cache-Control: no-cache' \
  -H 'Connection: keep-alive' \
  -H 'Host: youradress.ru' \
  -H 'Postman-Token: 5261841c-b05b-4f00-9b04-e9fa25efc9ba,7d8a1f52-11be-4868-8f7d-df9cc951689b' \
  -H 'User-Agent: PostmanRuntime/7.15.2' \
  -H 'X-Forensic-Access-Token: 0ccbdb4627c9d07c6c5b8f6e6cca44b5f8cb0c54ad7659098fa336240d494b0f9035e14bc42fc461224a9719f105e41026fed0f6f14188d9107b8c3d697a0cb1' \
  -H 'cache-control: no-cache'


import requests

url = "https://youradress.ru/api/folders/7e782ba3-be59-42bb-a1d4-cdd51b57a716/"

querystring = {"with_analyses":"true","with_user":"true","with_company":"true"}

headers = {
    'X-Forensic-Access-Token': "0ccbdb4627c9d07c6c5b8f6e6cca44b5f8cb0c54ad7659098fa336240d494b0f9035e14bc42fc461224a9719f105e41026fed0f6f14188d9107b8c3d697a0cb1",
    'User-Agent': "PostmanRuntime/7.15.2",
    'Accept': "*/*",
    'Cache-Control': "no-cache",
    'Postman-Token': "5261841c-b05b-4f00-9b04-e9fa25efc9ba,eea4f0e6-15fa-4e38-9387-d6f3804efb00",
    'Host': "youradress.ru",
    'Accept-Encoding': "gzip, deflate",
    'Connection': "keep-alive",
    'cache-control': "no-cache"
    }

response = requests.request("GET", url, headers=headers, params=querystring)

print(response.text)


setUrl('https://youradress.ru/api/folders/7e782ba3-be59-42bb-a1d4-cdd51b57a716/');
$request->setMethod(HTTP_METH_GET);

$request->setQueryData(array(
  'with_analyses' => 'true',
  'with_user' => 'true',
  'with_company' => 'true'
));

$request->setHeaders(array(
  'cache-control' => 'no-cache',
  'Connection' => 'keep-alive',
  'Accept-Encoding' => 'gzip, deflate',
  'Host' => 'youradress.ru',
  'Postman-Token' => '5261841c-b05b-4f00-9b04-e9fa25efc9ba,b732eb8e-4c22-4844-8213-5512baafc79b',
  'Cache-Control' => 'no-cache',
  'Accept' => '*/*',
  'User-Agent' => 'PostmanRuntime/7.15.2',
  'X-Forensic-Access-Token' => '0ccbdb4627c9d07c6c5b8f6e6cca44b5f8cb0c54ad7659098fa336240d494b0f9035e14bc42fc461224a9719f105e41026fed0f6f14188d9107b8c3d697a0cb1'
));

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}


OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://youradress.ru/api/folders/7e782ba3-be59-42bb-a1d4-cdd51b57a716/?with_analyses=true&with_user=true&with_company=true")
  .get()
  .addHeader("X-Forensic-Access-Token", "0ccbdb4627c9d07c6c5b8f6e6cca44b5f8cb0c54ad7659098fa336240d494b0f9035e14bc42fc461224a9719f105e41026fed0f6f14188d9107b8c3d697a0cb1")
  .addHeader("User-Agent", "PostmanRuntime/7.15.2")
  .addHeader("Accept", "*/*")
  .addHeader("Cache-Control", "no-cache")
  .addHeader("Postman-Token", "5261841c-b05b-4f00-9b04-e9fa25efc9ba,63b65a74-1080-484c-b702-702410460ddf")
  .addHeader("Host", "youradress.ru")
  .addHeader("Accept-Encoding", "gzip, deflate")
  .addHeader("Connection", "keep-alive")
  .addHeader("cache-control", "no-cache")
  .build();

Response response = client.newCall(request).execute();

Example of JSON Response.

Example of the system's JSON response to calling Folder [LIST] method with similar parameters:

JSON


{
    "time_created": 1579688592,
    "time_updated": 1579688612,
    "meta_data": {
        "iin": "test11234567"
    },
    "folder_id": "7e782ba3-be59-42bb-a1d4-cdd51b57a716",
    "resolution_time": 1579688612,
    "resolution_status": "FINISHED",
    "resolution_endpoint": null,
    "resolution_state_hash": "dc54e29a0ab29624",
    "resolution_comment": "[]",
    "resolution_suggest": null,
    "resolution_author_id": null,
    "is_archive": false,
    "media": [
        {
            "time_created": 1579688592,
            "time_updated": 1579688592,
            "meta_data": {},
            "media_id": "2ab2e7a1-41f3-4f93-844e-4422f29bec57",
            "media_type": "IMAGE_FOLDER",
            "info": {
                "thumb": {
                    "md5": "933fa1f5dd44d2c43f75e8044d4fa7a1",
                    "size": 17070,
                    "width": 300,
                    "height": 280,
                    "mime-type": "image/jpeg"
                },
                "original": {
                    "md5": "54b5d75d01488817bf041a5273de4585",
                    "size": 50971,
                    "width": 445,
                    "height": 416,
                    "mime-type": "image/jpeg"
                }
            },
            "tags": [
                "photo_selfie"
            ],
            "original_name": "2.jpg",
            "image_id": "2ab2e7a1-41f3-4f93-844e-4422f29bec57",
            "original_url": "http://youradress.ru/static/7e782ba3-be59-42bb-a1d4-cdd51b57a716/2ab2e7a1-41f3-4f93-844e-4422f29bec57.jpeg",
            "thumb_url": "http://youradress.ru/static/7e782ba3-be59-42bb-a1d4-cdd51b57a716/2ab2e7a1-41f3-4f93-844e-4422f29bec57_thumb.jpeg"
        },
        {
            "time_created": 1579688592,
            "time_updated": 1579688592,
            "meta_data": {},
            "media_id": "271aa39a-1205-43dd-81d7-6f715e7eaf0e",
            "media_type": "IMAGE_FOLDER",
            "info": {
                "thumb": {
                    "md5": "1827f89da365f01a24deb0329d231f80",
                    "size": 18261,
                    "width": 300,
                    "height": 300,
                    "mime-type": "image/jpeg"
                },
                "original": {
                    "md5": "9b1393886e54d93e1303ff284ae4dedf",
                    "size": 147204,
                    "width": 492,
                    "height": 492,
                    "mime-type": "image/jpeg"
                }
            },
            "tags": [
                "photo_id"
            ],
            "original_name": "1.jpg",
            "image_id": "271aa39a-1205-43dd-81d7-6f715e7eaf0e",
            "original_url": "http://youradress.ru/static/7e782ba3-be59-42bb-a1d4-cdd51b57a716/271aa39a-1205-43dd-81d7-6f715e7eaf0e.jpeg",
            "thumb_url": "http://youradress.ru/static/7e782ba3-be59-42bb-a1d4-cdd51b57a716/271aa39a-1205-43dd-81d7-6f715e7eaf0e_thumb.jpeg"
        }
    ],
    "analyses": [
        {
            "time_created": 1579688611,
            "time_updated": 1579688612,
            "meta_data": {
                "some_key": "some_value"
            },
            "analyse_id": "ff60365a-d3a4-4965-aef1-60789168fec3",
            "folder_id": "7e782ba3-be59-42bb-a1d4-cdd51b57a716",
            "type": "BIOMETRY",
            "state": "FINISHED",
            "results_data": {
                "max_confidence": 1.0,
                "min_confidence": 1.0
            },
            "confs": {},
            "error_message": null,
            "error_code": null,
            "resolution_operator": null,
            "source_media": [
                {
                    "time_created": 1579688592,
                    "time_updated": 1579688592,
                    "meta_data": {},
                    "media_id": "2ab2e7a1-41f3-4f93-844e-4422f29bec57",
                    "media_type": "IMAGE_FOLDER",
                    "info": {
                        "thumb": {
                            "md5": "933fa1f5dd44d2c43f75e8044d4fa7a1",
                            "size": 17070,
                            "width": 300,
                            "height": 280,
                            "mime-type": "image/jpeg"
                        },
                        "original": {
                            "md5": "54b5d75d01488817bf041a5273de4585",
                            "size": 50971,
                            "width": 445,
                            "height": 416,
                            "mime-type": "image/jpeg"
                        }
                    },
                    "tags": [
                        "photo_selfie"
                    ],
                    "original_name": "2.jpg",
                    "image_id": "2ab2e7a1-41f3-4f93-844e-4422f29bec57",
                    "original_url": "http://youradress.ru/static/7e782ba3-be59-42bb-a1d4-cdd51b57a716/2ab2e7a1-41f3-4f93-844e-4422f29bec57.jpeg",
                    "thumb_url": "http://youradress.ru/static/7e782ba3-be59-42bb-a1d4-cdd51b57a716/2ab2e7a1-41f3-4f93-844e-4422f29bec57_thumb.jpeg"
                },
                {
                    "time_created": 1579688592,
                    "time_updated": 1579688592,
                    "meta_data": {},
                    "media_id": "271aa39a-1205-43dd-81d7-6f715e7eaf0e",
                    "media_type": "IMAGE_FOLDER",
                    "info": {
                        "thumb": {
                            "md5": "1827f89da365f01a24deb0329d231f80",
                            "size": 18261,
                            "width": 300,
                            "height": 300,
                            "mime-type": "image/jpeg"
                        },
                        "original": {
                            "md5": "9b1393886e54d93e1303ff284ae4dedf",
                            "size": 147204,
                            "width": 492,
                            "height": 492,
                            "mime-type": "image/jpeg"
                        }
                    },
                    "tags": [
                        "photo_id"
                    ],
                    "original_name": "1.jpg",
                    "image_id": "271aa39a-1205-43dd-81d7-6f715e7eaf0e",
                    "original_url": "http://youradress.ru/static/7e782ba3-be59-42bb-a1d4-cdd51b57a716/271aa39a-1205-43dd-81d7-6f715e7eaf0e.jpeg",
                    "thumb_url": "http://youradress.ru/static/7e782ba3-be59-42bb-a1d4-cdd51b57a716/271aa39a-1205-43dd-81d7-6f715e7eaf0e_thumb.jpeg"
                }
            ],
            "results_media": [
                {
                    "media_association_id": 439827,
                    "analyse_id": "ff60365a-d3a4-4965-aef1-60789168fec3",
                    "results_data": null,
                    "media_association_type": "IMAGE",
                    "source_image_id": "2ab2e7a1-41f3-4f93-844e-4422f29bec57",
                    "output_images": [
                        {
                            "time_created": 1579688612,
                            "time_updated": 1579688612,
                            "meta_data": {},
                            "media_id": "8f5114f3-4d68-4805-a7fc-4276ca9ce54c",
                            "media_type": "IMAGE_RESULT_ANALYSE_SINGLE",
                            "info": {
                                "thumb": {
                                    "md5": "703c227547e3672cc68b81d7f19332ba",
                                    "size": 4436,
                                    "width": 112,
                                    "height": 112,
                                    "mime-type": "image/jpeg"
                                },
                                "original": {
                                    "md5": "e8058d2c50c05772443dacc61ccb8f73",
                                    "size": 3278,
                                    "width": 112,
                                    "height": 112,
                                    "mime-type": "image/jpeg"
                                }
                            },
                            "tags": [],
                            "original_name": "",
                            "image_id": "8f5114f3-4d68-4805-a7fc-4276ca9ce54c",
                            "original_url": "http://youradress.ru/static/7e782ba3-be59-42bb-a1d4-cdd51b57a716/8f5114f3-4d68-4805-a7fc-4276ca9ce54c.jpeg",
                            "thumb_url": "http://youradress.ru/static/7e782ba3-be59-42bb-a1d4-cdd51b57a716/8f5114f3-4d68-4805-a7fc-4276ca9ce54c_thumb.jpeg",
                            "media_association_id": 439827
                        }
                    ],
                    "collection_persons": []
                },
                {
                    "media_association_id": 439828,
                    "analyse_id": "ff60365a-d3a4-4965-aef1-60789168fec3",
                    "results_data": null,
                    "media_association_type": "IMAGE",
                    "source_image_id": "271aa39a-1205-43dd-81d7-6f715e7eaf0e",
                    "output_images": [
                        {
                            "time_created": 1579688612,
                            "time_updated": 1579688612,
                            "meta_data": {},
                            "media_id": "bd32790b-b65a-4465-9302-0f577a8b1df5",
                            "media_type": "IMAGE_RESULT_ANALYSE_SINGLE",
                            "info": {
                                "thumb": {
                                    "md5": "2e54d60e947c27e29a51d57182b260ba",
                                    "size": 4896,
                                    "width": 112,
                                    "height": 112,
                                    "mime-type": "image/jpeg"
                                },
                                "original": {
                                    "md5": "f5b630a8364bd372296ca15ddb17f07c",
                                    "size": 3568,
                                    "width": 112,
                                    "height": 112,
                                    "mime-type": "image/jpeg"
                                }
                            },
                            "tags": [],
                            "original_name": "",
                            "image_id": "bd32790b-b65a-4465-9302-0f577a8b1df5",
                            "original_url": "http://youradress.ru/static/7e782ba3-be59-42bb-a1d4-cdd51b57a716/bd32790b-b65a-4465-9302-0f577a8b1df5.jpeg",
                            "thumb_url": "http://youradress.ru/static/7e782ba3-be59-42bb-a1d4-cdd51b57a716/bd32790b-b65a-4465-9302-0f577a8b1df5_thumb.jpeg",
                            "media_association_id": 439828
                        }
                    ],
                    "collection_persons": []
                }
            ],
            "results_group": [],
            "resolution_status": "SUCCESS",
            "resolution": "SUCCESS"
        }
    ],
    "user": {
        "user_id": "7b10dac0-e6ac-4138-a1af-c6cb2addcce1",
        "user_type": "CLIENT",
        "first_name": "FAQTest",
        "last_name": "FAQTest",
        "middle_name": "",
        "email": "manualtest@oz-services.ru",
        "can_start_analyse_biometry": true,
        "can_start_analyse_collection": true,
        "can_start_analyse_documents": true,
        "can_start_analyse_forensic": true,
        "can_start_analyse_kyc": true,
        "can_start_analyse_quality": true,
        "company_id": "d5b935aa-6745-47b6-a72d-20a418116a29",
        "is_admin": false,
        "is_service": true,
        "company": {
            "company_id": "d5b935aa-6745-47b6-a72d-20a418116a29",
            "name": "FAQTest"
        }
    },
    "company": {
        "company_id": "d5b935aa-6745-47b6-a72d-20a418116a29",
        "name": "FAQTest"
    }
}

Details of JSON Response.

First block of the response (strings 2–15) contains general information on the folder.

Block "media" (strings 21–77) contains information on files stored in the folder.

Block "analyses" (strings 78–243) contains information on files stored in the folder.

Block "user" (strings 244–264) includes information on the user who created the folder.

Block "company" (strings 265–268) contains information on the company to which the user who created the folder belongs.