From e4bed81ce720bca7c2063e2338f990d2244faa1f Mon Sep 17 00:00:00 2001
From: GitHub Action <action@github.com>
Date: Tue, 5 Dec 2023 08:51:31 +0000
Subject: [PATCH] update pages

---
 index.html | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/index.html b/index.html
index d35a4d4..59cc7cf 100644
--- a/index.html
+++ b/index.html
@@ -2516,7 +2516,7 @@
 </span></button><div class="sc-cbeScs jDggOG"><h5 class="sc-iqAclL eONCmm">Response Schema: <span class="sc-cBoqAE eKyrDP">application/json</span></h5><table class="sc-hHEiqL VCQHZ"><tbody><tr class="last "><td class="sc-hBMUJo sc-fFSPTT fxcgjS cAqMTE" kind="additionalProperties" title="property name*"><span class="sc-iemWCZ kJGiHW"></span><span class="property-name">property name*</span><div class="sc-oeezt sc-hhIiOg sc-eirqVv dLCGMn hIkHYw bwDbiF">additional property</div></td><td class="sc-bkbkJK eFvsim"><div><div><span class="sc-laZMeE sc-iNiQyp jWaWWE jrLlAa"></span><span class="sc-laZMeE sc-jffHpj jWaWWE cThoNa">any</span></div> <div><div class="sc-iJCRrE sc-ciSkZP jCdxGr gurIWx"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/api/readiness</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr gurIWx"><p>Local on-premise installation</p>
 </div><div tabindex="0" role="button"><div class="sc-dTSzeu ezJCuG"><span>http://localhost:41101</span>/api/readiness</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-108" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-109" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-110" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-111" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-109" aria-labelledby="react-tabs-108"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><span class="token punctuation">{ }</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-111" aria-labelledby="react-tabs-110"></div></div></div></div></div></div></div><div class="sc-ellfGf bgakXB"></div></div></div>
     <script>
-    const __redoc_state = {"menu":{"activeItemIdx":-1},"spec":{"data":{"openapi":"3.0.3","info":{"version":"5.2.0","title":"Regula FaceSDK Web API","x-logo":{"url":"https://static-content.regulaforensics.com/Icons/Logos/Regula-logo.svg","href":"https://mobile.regulaforensics.com/"},"description":"Regula FaceSDK Web API\n# Clients\n* [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios\n* [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android\n* [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client\n* [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core\n","x-tagGroups":{"name":"liveness","tags":["liveness","match"]}},"servers":[{"url":"http://localhost:41101/","description":"Local on-premise installation"}],"paths":{"/api/match":{"parameters":[{"$ref":"#/components/parameters/x-request"}],"post":{"tags":["matching"],"summary":"Compare faces in all combinations","operationId":"match","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MatchRequest"}}}},"responses":{"200":{"description":"Successful operation; the compare results are returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MatchResponse"}}}},"403":{"$ref":"#/components/responses/BadLicense"}}}},"/api/match_and_search":{"parameters":[{"$ref":"#/components/parameters/x-request"}],"post":{"tags":["matching"],"summary":"Match and Search in one request","operationId":"match_and_search","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MatchAndSearchRequest"}}}},"responses":{"200":{"description":"Successful operation; the compare results are returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MatchAndSearchResponse"}}}},"403":{"$ref":"#/components/responses/BadLicense"}}}},"/api/detect":{"parameters":[{"$ref":"#/components/parameters/x-request"}],"post":{"tags":["matching"],"summary":"Detect face, evaluate attributes, assess the portrait quality","operationId":"detect","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DetectRequest"}}}},"responses":{"200":{"description":"Successful operation; the coordinates of the detected faces are returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DetectResponse"}}}},"403":{"$ref":"#/components/responses/BadLicense"}}}},"/api/persons":{"parameters":[{"$ref":"#/components/parameters/x-request"}],"post":{"tags":["person"],"summary":"Create person","operationId":"create_person","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonFields"}}}},"responses":{"201":{"$ref":"#/components/responses/SuccessPerson"},"400":{"$ref":"#/components/responses/BadRequest"}}}},"/api/persons/{personId}":{"parameters":[{"$ref":"#/components/parameters/personId"},{"$ref":"#/components/parameters/x-request"}],"get":{"tags":["person"],"summary":"Get person","operationId":"get_person","responses":{"200":{"$ref":"#/components/responses/SuccessPerson"},"400":{"$ref":"#/components/responses/BadRequest"},"404":{"$ref":"#/components/responses/PersonNotFound"}}},"put":{"tags":["person"],"summary":"Update person","operationId":"update_person","requestBody":{"description":"Request body for the Person to update.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonFields"}}}},"responses":{"204":{"$ref":"#/components/responses/SuccessEmpty"},"400":{"$ref":"#/components/responses/BadRequest"},"404":{"$ref":"#/components/responses/PersonNotFound"}}},"delete":{"tags":["person"],"summary":"Delete person","operationId":"delete_person","responses":{"204":{"$ref":"#/components/responses/SuccessEmpty"},"400":{"$ref":"#/components/responses/BadRequest"},"404":{"$ref":"#/components/responses/PersonNotFound"}}}},"/api/persons/{personId}/images":{"parameters":[{"$ref":"#/components/parameters/personId"},{"$ref":"#/components/parameters/x-request"}],"get":{"tags":["person"],"summary":"Get person images","operationId":"get_all_images_by_person_id","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/size"}],"responses":{"200":{"description":"Successful operation; return all person images.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImagePage"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"404":{"$ref":"#/components/responses/PersonNotFound"}}},"post":{"tags":["person"],"summary":"Add person image","operationId":"add_image_to_person","requestBody":{"description":"Image to add.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageFields"}}}},"responses":{"200":{"description":"Successful operation; return image ID.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Image"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"404":{"$ref":"#/components/responses/PersonNotFound"}}}},"/api/persons/{personId}/images/{imageId}":{"parameters":[{"$ref":"#/components/parameters/personId"},{"$ref":"#/components/parameters/x-request"}],"get":{"tags":["person"],"summary":"Get person image by id","operationId":"get_image_of_person","parameters":[{"$ref":"#/components/parameters/imageId"}],"responses":{"200":{"description":"Successful operation, return image.","content":{"image/*":{"schema":{"type":"string","format":"binary"}}}},"400":{"$ref":"#/components/responses/BadRequest","description":"Person does not have such an image."},"404":{"$ref":"#/components/responses/PersonNotFound","description":"Such an image does not exists."}}},"delete":{"tags":["person"],"summary":"Delete image of person","operationId":"delete_image_of_person","parameters":[{"$ref":"#/components/parameters/imageId"}],"responses":{"204":{"$ref":"#/components/responses/SuccessEmpty"},"400":{"$ref":"#/components/responses/BadRequest"},"404":{"description":"Person with the personId or image with the imageId is not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationLog"}}}}}}},"/api/persons/{personId}/groups":{"parameters":[{"$ref":"#/components/parameters/personId"},{"$ref":"#/components/parameters/x-request"}],"get":{"tags":["person"],"summary":"Get person groups","operationId":"get_all_groups_by_person_id","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/size"}],"responses":{"200":{"description":"Successful operation; return all groups.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupPage"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"404":{"$ref":"#/components/responses/PersonNotFound"}}}},"/api/groups":{"parameters":[{"$ref":"#/components/parameters/x-request"}],"get":{"tags":["group"],"summary":"Get groups","operationId":"get_all_groups","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/size"}],"responses":{"200":{"description":"Successful operation, return all groups.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupPage"}}}},"400":{"$ref":"#/components/responses/BadRequest"}}},"post":{"tags":["group"],"summary":"Create group","operationId":"create_group","requestBody":{"description":"Request body for the group to create.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupToCreate"}}}},"responses":{"201":{"$ref":"#/components/responses/SuccessGroup"},"400":{"$ref":"#/components/responses/BadRequest"}}}},"/api/groups/{groupId}":{"parameters":[{"$ref":"#/components/parameters/groupId"},{"$ref":"#/components/parameters/x-request"}],"get":{"tags":["group"],"summary":"Get group","operationId":"get_group","responses":{"200":{"$ref":"#/components/responses/SuccessGroup"},"400":{"$ref":"#/components/responses/BadRequest"},"404":{"$ref":"#/components/responses/GroupNotFound"}}},"put":{"tags":["group"],"summary":"Update group","operationId":"update_group","requestBody":{"description":"Request body for the group to update.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupToCreate"}}}},"responses":{"204":{"$ref":"#/components/responses/SuccessEmpty"},"400":{"$ref":"#/components/responses/BadRequest"},"404":{"$ref":"#/components/responses/GroupNotFound"}}},"delete":{"tags":["group"],"summary":"Delete group","operationId":"delete_group","responses":{"204":{"$ref":"#/components/responses/SuccessEmpty"},"404":{"$ref":"#/components/responses/GroupNotFound"}}}},"/api/groups/{groupId}/persons":{"parameters":[{"$ref":"#/components/parameters/groupId"},{"$ref":"#/components/parameters/x-request"}],"get":{"tags":["group"],"summary":"Get group persons","operationId":"get_all_persons_by_group_id","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/size"}],"responses":{"200":{"description":"Successful operation, return all persons.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonsPage"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"404":{"description":"Group with the groupId or persons with the personIds are not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationLog"}}}}}},"put":{"tags":["group"],"summary":"Add/remove persons to group","operationId":"update_persons_in_group","requestBody":{"description":"Request body for person IDs to add or remove.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateGroup"}}}},"responses":{"204":{"$ref":"#/components/responses/SuccessEmpty"},"400":{"$ref":"#/components/responses/BadRequest"},"404":{"$ref":"#/components/responses/GroupNotFound"}}}},"/api/search":{"parameters":[{"$ref":"#/components/parameters/x-request"}],"post":{"tags":["search"],"summary":"Find person by image in groups","operationId":"search","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchRequest"}}}},"responses":{"200":{"description":"Successful operation; the search result is returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchResult"}}}},"201":{"description":"New person created with the search photo and the data specified.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonCreatedResponse"}}}},"400":{"$ref":"#/components/responses/SearchBadParamsException"}}}},"/api/v2/liveness":{"parameters":[{"$ref":"#/components/parameters/transactionId"}],"get":{"tags":["liveness 2.0"],"summary":"Liveness assessment","operationId":"get_liveness_transaction_info","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionInfo"}}}}}}},"/api/readiness":{"parameters":[{"$ref":"#/components/parameters/x-request"}],"get":{"tags":["diagnostics"],"summary":"Checking the license status","operationId":"readiness","responses":{"200":{"$ref":"#/components/responses/ReadinessOK"},"400":{"$ref":"#/components/responses/ReadinessBad"}}}}},"components":{"parameters":{"x-request":{"in":"header","name":"X-RequestID","description":"Request header label.","schema":{"type":"string"}},"personId":{"name":"personId","in":"path","description":"Person ID.","required":true,"schema":{"format":"uuid","type":"string"}},"page":{"name":"page","in":"query","required":true,"description":"The page number to get a list of persons or groups.","schema":{"type":"integer","default":1}},"size":{"name":"size","in":"query","required":true,"description":"The page size with a list of persons or groups, items.","schema":{"type":"integer","default":1000}},"imageId":{"name":"imageId","in":"path","description":"Image ID.","required":true,"schema":{"string":"uuid","type":"string"}},"groupId":{"name":"groupId","in":"path","description":"Group ID.","required":true,"schema":{"type":"string","format":"uuid"}},"transactionId":{"in":"query","name":"transactionId","required":true,"description":"ID of the current liveness transaction.","schema":{"type":"string","format":"uuid"}}},"schemas":{"MatchImageIndex":{"type":"integer","description":"The image index number. Can be given; if not given, the index numbers are set automatically starting from 0. All index numbers must be whole and unique—not repeated."},"ImageSource":{"description":"The type of the image, defines the way the comparison is performed. See the enum: https://docs.regulaforensics.com/develop/face-sdk/web-service/development/enums/image-source/","type":"integer","enum":[1,2,3,4,5,6],"x-enum-varnames":["DOCUMENT_PRINTED","DOCUMENT_RFID","LIVE","DOCUMENT_WITH_LIVE","EXTERNAL","GHOST"]},"ImageData":{"description":"Base64 encoded image.","type":"string","format":"byte"},"detectAll":{"type":"boolean","description":"Whether to detect all faces in the image. If set to false, only the most central face is detected.","default":false},"MatchImage":{"type":"object","required":["data"],"properties":{"index":{"$ref":"#/components/schemas/MatchImageIndex"},"type":{"$ref":"#/components/schemas/ImageSource"},"data":{"$ref":"#/components/schemas/ImageData"},"detectAll":{"$ref":"#/components/schemas/detectAll"}}},"MatchRequest":{"type":"object","required":["images"],"properties":{"tag":{"type":"string","description":"Session identificator."},"thumbnails":{"type":"boolean","description":"Whether to return thumbnails: Base64 cropped images that contain vertically aligned faces.","default":false},"images":{"type":"array","description":"The array of all images included in the comparison.","items":{"$ref":"#/components/schemas/MatchImage"}}}},"FaceSDKResultCode":{"type":"integer","description":"The result code, see enum: https://docs.regulaforensics.com/develop/face-sdk/web-service/development/enums/face-sdk-result-code/","enum":[0,1,2,3,4,5,6,7,199,200,201,202,203,224,227,228,229,230,231,232,233,234,235,236,237,238,239,240,242,243,244,245,246,247,248,249,250,251,252],"x-enum-varnames":["FACER_OK","FR_IMAGE_EMPTY","FR_FACE_NOT_DETECTED","FR_LANDMARKS_NOT_DETECTED","FR_FACE_ALIGHNER_FAILED","FR_DESCRIPTOR_EXTRACTOR_ERROR","FR_IMAGE_DECODE_ERROR","FR_INTERNAL_ERROR","FACER_CONFIG_ERROR","FACER_NO_LICENSE","FACER_IS_NOT_INITIALIZED","FACER_COMMAND_IS_NOT_SUPPORTED","FACER_COMMAND_PARAMS_READ_ERROR","FACER_LESS_THAN_TWO_IMAGES_IN_REQUEST","FACER_VIDEO_DECODE_ERROR","FACER_NOT_ENOUGH_FRAMES","FACER_OUTPUT_IS_NOT_DEFINED","FACER_CLOSED_EYES_DETECTED","FACER_LOW_QUALITY","FACER_HIGH_ASYMMETRY","FACER_FACE_OVER_EMOTIONAL","FACER_SUNGLASSES_DETECTED","FACER_SMALL_AGE","FACER_HEADDRESS_DETECTED","FACER_FACES_NOT_MATCHED","FACER_IMAGES_COUNT_LIMIT_EXCEEDED","FACER_MEDICINE_MASK_DETECTED","FACER_OCCLUSION_DETECTED","FACER_FOREHEAD_GLASSES_DETECTED","FACER_MOUTH_OPENED","FACER_ART_MASK_DETECTED","FACER_ELECTRONIC_DEVICE_DETECTED","FACER_TRACK_BREAK","FACER_WRONG_GEO","FACER_WRONG_OF","FACER_WRONG_VIEW","FACER_TIMEOUT_LIVENESS_TRANSACTION","FACER_FAILED_LIVENESS_TRANSACTION","FACER_ABORTED_LIVENESS_TRANSACTION"]},"FaceSDKResult":{"type":"object","required":["code"],"properties":{"code":{"$ref":"#/components/schemas/FaceSDKResultCode"}}},"MatchFaceIndex":{"type":"number","description":"The detected face index number."},"FaceRectangular":{"description":"The rectangular area of a detected face that is represented by a set of four elements: the X and Y coordinates of the top-left point, and the width and height dimensions of the rectangle.","type":"array","items":{"type":"number"},"example":["x","y","width","height"]},"Thumbnail":{"description":"Base64 of the cropped portrait.","type":"string","format":"byte"},"DetectionFace":{"type":"object","properties":{"faceIndex":{"$ref":"#/components/schemas/MatchFaceIndex"},"landmarks":{"description":"Absolute coordinates (x,y) of five points of each detected face: left eye, right eye, nose, left point of lips, right point of lips.","type":"array","items":{"description":"Cartesian points. First element - X-axis coordinate. Second element - Y-axis coordinate.","type":"array","items":{"type":"number","example":["x","y"]}},"example":[["x","y"]]},"rotationAngle":{"description":"Angle of rotation of the face from the vertical axis, degrees.","type":"float"},"roi":{"$ref":"#/components/schemas/FaceRectangular"},"thumbnail":{"$ref":"#/components/schemas/Thumbnail"}}},"MatchImageDetection":{"type":"object","required":["imageIndex","status"],"properties":{"faces":{"type":"array","description":"The array of detected faces.","items":{"$ref":"#/components/schemas/DetectionFace"}},"imageIndex":{"$ref":"#/components/schemas/MatchImageIndex"},"status":{"$ref":"#/components/schemas/FaceSDKResultCode"}}},"MatchImageResult":{"type":"object","required":["firstIndex","secondIndex"],"properties":{"firstIndex":{"$ref":"#/components/schemas/MatchImageIndex"},"firstFaceIndex":{"$ref":"#/components/schemas/MatchFaceIndex"},"first":{"$ref":"#/components/schemas/ImageSource"},"secondIndex":{"$ref":"#/components/schemas/MatchImageIndex"},"secondFaceIndex":{"$ref":"#/components/schemas/MatchFaceIndex"},"second":{"$ref":"#/components/schemas/ImageSource"},"score":{"type":"number","description":"A dimensionless number that shows how similar the compared faces are. 0—absolutely identical faces."},"similarity":{"type":"number","description":"The detected faces similarity, %. 100%—absolutely identical faces, 0%—absolutely not identical."}}},"MatchResponse":{"allOf":[{"$ref":"#/components/schemas/FaceSDKResult"},{"type":"object","properties":{"detections":{"type":"array","description":"The array of detected faces.","items":{"$ref":"#/components/schemas/MatchImageDetection"}},"results":{"type":"array","description":"The array of matching results.","items":{"$ref":"#/components/schemas/MatchImageResult"}}}}]},"SearchParameters":{"type":"object","description":"Request search data.","properties":{"createPerson":{"type":"object","description":"If a person is not found, a new person entry is created using the descriptor calculated while searching.","properties":{"name":{"type":"string","description":"Person's name."},"metadata":{"type":"object","additionalProperties":true,"description":"A free-form object containing person's extended attributes."}}},"groupIds":{"type":"array","description":"IDs of the groups in which the search is performed.","items":{"type":"integer"}}}},"MatchAndSearchRequest":{"allOf":[{"type":"object","properties":{"tag":{"type":"string","description":"Session identificator."},"images":{"type":"array","description":"Array of Person images.","items":{"type":"object","properties":{"content":{"$ref":"#/components/schemas/ImageData"},"type":{"$ref":"#/components/schemas/ImageSource"}}}}}},{"$ref":"#/components/schemas/SearchParameters"}]},"Image":{"type":"object","description":"Image in the response.","properties":{"id":{"type":"string","description":"Response image ID. The list is sorted by decreasing ID value."},"contentType":{"type":"string","description":"Original media type of the returned image."},"createdAt":{"type":"string","description":"Returned image creation date."},"updatedAt":{"type":"string","description":"Returned image update date."},"path":{"type":"string","description":"Returned image path."},"url":{"type":"string","description":"Returned image URL."},"metadata":{"type":"object","additionalProperties":true,"description":"A free-form object containing person's extended attributes."}}},"RecognizeImage":{"allOf":[{"$ref":"#/components/schemas/Image"},{"type":"object","properties":{"similarity":{"type":"number","format":"float","description":"Similarity score."},"distance":{"type":"number","format":"float","description":"Similarity distance score: the lower the distance, the higher the face's similarity."}}}]},"PersonFields":{"type":"object","description":"Person Request body: name and metadata.","properties":{"tag":{"type":"string","description":"Session identificator."},"name":{"type":"string","description":"Person name."},"metadata":{"type":"object","additionalProperties":true,"description":"A free-form object containing person's extended attributes."},"groups":{"type":"array","description":"Groups a person should be placed to. If no group is specified in request, a Default group is created and the person is placed to it.","items":{"type":"string","format":"uuid"}}}},"Person":{"description":"Person response body: person ID, creation date, update date if any.","allOf":[{"$ref":"#/components/schemas/PersonFields"},{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Person ID. The list of persons is sorted by decreasing ID value."},"createdAt":{"type":"string","description":"Person creation date."},"updatedAt":{"type":"string","description":"Person update date."},"groups":{"type":"array","description":"List of groups this person belongs to.","items":{"type":"string","format":"uuid"}}}}]},"PersonWithImages":{"allOf":[{"type":"object","properties":{"images":{"type":"array","items":{"$ref":"#/components/schemas/RecognizeImage"}}}},{"$ref":"#/components/schemas/Person"}]},"FacesResponse":{"allOf":[{"$ref":"#/components/schemas/DetectionFace"},{"type":"object","properties":{"persons":{"type":"array","items":{"$ref":"#/components/schemas/PersonWithImages"}},"rotationAngle":{"type":"float","example":2.1272900104522705}}}]},"MatchAndSearchResponse":{"allOf":[{"$ref":"#/components/schemas/FaceSDKResult"},{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/MatchImageResult"}},"elapsedTime":{"type":"float","example":1.317137987},"metadata":{"type":"object","additionalProperties":true,"description":"A free-form object containing person's extended attributes."},"detections":{"type":"array","items":{"type":"object","properties":{"faces":{"type":"array","items":{"$ref":"#/components/schemas/FacesResponse"}},"imageIndex":{"$ref":"#/components/schemas/MatchImageIndex"},"status":{"$ref":"#/components/schemas/FaceSDKResultCode"}}}}}}]},"FaceQualityScenarios":{"type":"string","description":"Face detection scenario.","enum":["OldMode","QualityFull","QualityICAO","QualityVisaSchengen","QualityVisaUSA","CropCentralFace","CropAllFaces","Thumbnail"],"x-enum-varnames":["OLD_MODE","QUALITY_FULL","QUALITY_ICAO","QUALITY_VISA_SCHENGEN","QUALITY_VISA_USA","CROP_CENTRAL_FACE","CROP_ALL_FACES","THUMBNAIL"]},"RGB":{"type":"array","description":"The RGB value of a color for filling background behind a person's silhouette and for aligning the image.","items":{"type":"integer"},"minItems":3,"maxItems":3,"example":[128,128,128]},"FaceImageQualityAlignType":{"type":"integer","description":"The aspect ratio according to which face alignment is performed during face detection.","enum":[0,1,2,3,4],"x-enum-varnames":["ALIGN_3x4","ALIGN_4x5","ALIGN_2x3","ALIGN_1x1","ALIGN_7x9"]},"Crop":{"type":"object","description":"Whether to return the Base64 of an aligned and cropped portrait in the crop field.","properties":{"type":{"$ref":"#/components/schemas/FaceImageQualityAlignType","description":"The dimensions ratio to the height of the required pattern.","example":1},"padColor":{"$ref":"#/components/schemas/RGB","description":"The RGB value for the color that will complement the image if this is needed for alignment."},"size":{"type":"array","items":{"type":"integer"},"minItems":2,"maxItems":2,"description":"The resize value in case type matches this value. If it doesn't, no resize is done.","example":[300,400]},"returnOriginalRect":{"type":"boolean","description":"Whether to return the coordinates of the rectangle with the face in the original image prepared for the face crop.","example":true}}},"OutputImageParams":{"type":"object","description":"Whether to process the uploaded image according to the indicated settings.","properties":{"backgroundColor":{"description":"The RGB value for the background color: the silhouette of a person is cut out and the background is filled with this color.","$ref":"#/components/schemas/RGB"},"crop":{"description":"Whether to return the Base64 of an aligned and cropped portrait in the crop field.","$ref":"#/components/schemas/Crop"}}},"FaceAttribute":{"type":"string","description":"Face attributes.","enum":["Age","Emotion","EyeLeft","EyeRight","Smile","Glasses","HeadCovering","ForeheadCovering","Mouth","MedicalMask","Occlusion","StrongMakeup","Headphones"],"x-enum-varnames":["AGE","EMOTION","EYE_LEFT","EYE_RIGHT","SMILE","GLASSES","HEAD_COVERING","FOREHEAD_COVERING","MOUTH","MEDICAL_MASK","OCCLUSION","STRONG_MAKEUP","HEADPHONES"]},"QualityConfig":{"type":"object","description":"The configuration that defines the list of returned quality check characteristics.","properties":{"name":{"description":"The name of the characteristic.","$ref":"#/components/schemas/FaceAttribute","example":"Emotion"},"range":{"type":"array","items":{"type":"float"},"minItems":2,"maxItems":2,"description":"The range of applicable values for this characteristic. If the returned in the Response value fits this range, the value is identified as compliant with the requirements.","example":["x","y"]}}},"QualityConfigList":{"type":"array","items":{"$ref":"#/components/schemas/QualityConfig"}},"QualityRequest":{"type":"object","description":"Whether to perform the portrait quality check.","properties":{"backgroundMatchColor":{"description":"The RGB value for the background color: the silhouette of a person is cut out and the background is filled with this color.","$ref":"#/components/schemas/RGB"},"config":{"$ref":"#/components/schemas/QualityConfigList"}}},"ProcessParam":{"type":"object","description":"The processing parameters.","properties":{"scenario":{"$ref":"#/components/schemas/FaceQualityScenarios"},"onlyCentralFace":{"type":"boolean","description":"Whether to process only the central face on the image (true) or all the faces (false).","example":false},"outputImageParams":{"$ref":"#/components/schemas/OutputImageParams"},"quality":{"$ref":"#/components/schemas/QualityRequest"},"attributes":{"description":"Whether to evaluate attributes, such as age and emotions.","type":"object","properties":{"config":{"$ref":"#/components/schemas/QualityConfigList"}}}}},"DetectRequest":{"type":"object","properties":{"tag":{"type":"string","description":"Session identificator."},"processParam":{"$ref":"#/components/schemas/ProcessParam"},"image":{"$ref":"#/components/schemas/ImageData"},"thumbnails":{"description":"Whether to return the cropped portrains with the detected faces.","type":"boolean","default":false}}},"FaceQualityConfigName":{"type":"string","description":"All image characteristics that can be assessed during face image quality assessment.","enum":["ImageWidth","ImageHeight","ImageWidthToHeight","ImageChannelsNumber","PaddingRatio","FaceMidPointHorizontalPosition","FaceMidPointVerticalPosition","HeadWidthRatio","HeadHeightRatio","EyesDistance","Yaw","Pitch","Roll","BlurLevel","NoiseLevel","EyeRightClosed","EyeLeftClosed","EyeRightOccluded","EyeLeftOccluded","EyesRed","EyeRightCoveredWithHair","EyeLeftCoveredWithHair","OffGaze","FaceDynamicRange","UnnaturalSkinTone","TooDark","TooLight","FaceGlare","ShadowsOnFace","DarkGlasses","ReflectionOnGlasses","FramesTooHeavy","FaceOccluded","HeadCovering","BackgroundUniformity","ShadowsOnBackground","OtherFaces","ShouldersPose","ExpressionLevel","MouthOpen","ForeheadCovering","Smile","StrongMakeup","Headphones","MedicalMask","BackgroundColorMatch","ArtFace","ContactLenses"],"x-enum-varnames":["IMAGE_WIDTH","IMAGE_HEIGHT","IMAGE_WIDTH_TO_HEIGHT","IMAGE_CHANNELS_NUMBER","PADDING_RATIO","FACE_MID_POINT_HORIZONTAL_POSITION","FACE_MID_POINT_VERTICAL_POSITION","HEAD_WIDTH_RATIO","HEAD_HEIGHT_RATIO","EYES_DISTANCE","YAW","PITCH","ROLL","BLUR_LEVEL","NOISE_LEVEL","EYE_RIGHT_CLOSED","EYE_LEFT_CLOSED","EYE_RIGHT_OCCLUDED","EYE_LEFT_OCCLUDED","EYES_RED","EYE_RIGHT_COVERED_WITH_HAIR","EYE_LEFT_COVERED_WITH_HAIR","OFF_GAZE","FACE_DYNAMIC_RANGE","UNNATURAL_SKIN_TONE","TOO_DARK","TOO_LIGHT","FACE_GLARE","SHADOWS_ON_FACE","DARK_GLASSES","REFLECTION_ON_GLASSES","FRAMES_TOO_HEAVY","FACE_OCCLUDED","HEAD_COVERING","BACKGROUND_UNIFORMITY","SHADOWS_ON_BACKGROUND","OTHER_FACES","SHOULDERS_POSE","EXPRESSION_LEVEL","MOUTH_OPEN","FOREHEAD_COVERING","SMILE","STRONG_MAKEUP","HEADPHONES","MEDICAL_MASK","BACKGROUND_COLOR_MATCH","ART_FACE","CONTACT_LENSES"]},"FaceImageQualityGroups":{"type":"integer","description":"Face image quality group types for face image quality assessment.","enum":[1,2,3,4,5,6,7,8],"x-enum-varnames":["IMAGE_CHARACTERISTICS","HEAD_SIZE_AND_POSITIONS","FACE_QUALITY","EYES_CHARACTERISTICS","SHADOWS_AND_LIGHTNING","POSE_AND_EXPRESSION","HEAD_OCCLUSION","BACKGROUND"]},"FaceImageQualityGroupsStrings":{"type":"string","description":"Face image quality group types for face image quality assessment.","enum":["ImageCharacteristics","HeadSizeAndPosition","FaceQuality","EyesCharacteristics","ShadowsAndLightning","PoseAndExpression","HeadOcclusion","Background"],"x-enum-varnames":["IMAGE_CHARACTERISTICS","HEAD_SIZE_AND_POSITIONS","FACE_QUALITY","EYES_CHARACTERISTICS","SHADOWS_AND_LIGHTNING","POSE_AND_EXPRESSION","HEAD_OCCLUSION","BACKGROUND"]},"QualityDetailsGroups":{"type":"object","properties":{"groupId":{"description":"The ID of the characteristics group.","$ref":"#/components/schemas/FaceImageQualityGroups"},"name":{"$ref":"#/components/schemas/FaceImageQualityGroupsStrings","description":"The name of the characteristics group."},"totalCount":{"type":"integer","description":"The total number of characteristics in the group.","example":5},"compliantCount":{"type":"integer","description":"The number of compliant characteristics in the group.","example":4}}},"FaceImageQualityStatus":{"type":"integer","description":"The processing status returned for each assessed quality characteristic.","enum":[0,1,2],"x-enum-varnames":["QUALITY_STATUS_FALSE","QUALITY_STATUS_TRUE","QUALITY_STATUS_UNDETERMINED"]},"QualityDetail":{"type":"object","properties":{"groupId":{"description":"The ID of the characteristics group.","$ref":"#/components/schemas/FaceImageQualityGroups","example":0},"name":{"$ref":"#/components/schemas/FaceQualityConfigName","description":"The name of the characteristic.","example":"Roll"},"range":{"type":"array","description":"The range of set values for this characteristic.","items":{"type":"float"},"minItems":2,"maxItems":2,"example":["x","y"]},"status":{"$ref":"#/components/schemas/FaceImageQualityStatus","example":1,"description":"The assessment status."},"value":{"type":"float","description":"The assessed value for the characteristic, returned in the set units.","example":0}}},"Detection":{"type":"object","required":["landmarks","roi"],"properties":{"crop":{"description":"Base64 of the aligned and cropped portrait. Returned if align is set.","$ref":"#/components/schemas/ImageData"},"attributes":{"type":"object","properties":{"details":{"type":"array","items":{"type":"object","additionalProperties":true}},"elapsedTime":{"type":"number","description":"The elapsed time for attribute detection."}}},"landmarks":{"description":"Absolute coordinates (x,y) of five points of each detected face: left eye, right eye, nose, left point of lips, right point of lips.","type":"array","items":{"description":"Cartesian points. First element - X-axis coordinate. Second element - Y-axis coordinate.","type":"array","items":{"type":"integer","example":["x","y"]}},"example":[["x","y"]]},"quality":{"type":"object","description":"Field for checking the portrait quality. If it is not mentioned, no quality check is performed.","properties":{"nonCompliant":{"type":"array","description":"The array of all the non-compliant assessment characteristics.","items":{"$ref":"#/components/schemas/FaceQualityConfigName"},"example":["ImageWidthToHeight","Yaw"]},"detailsGroups":{"description":"The array of the assessment results for each group of characteristics.","type":"array","items":{"$ref":"#/components/schemas/QualityDetailsGroups"}},"details":{"type":"array","description":"The array of the assessment characteristics that were set in the request.","items":{"$ref":"#/components/schemas/QualityDetail"}},"score":{"type":"float","description":"Returns the estimated portrait quality assessment result, a number from 0 to 1, where 1 is for absolute compliance.","example":-1},"timer":{"type":"float","description":"The total time the quality assessment has taken.","example":0.420364111661911}}},"roi":{"$ref":"#/components/schemas/FaceRectangular"},"thumbnail":{"$ref":"#/components/schemas/Thumbnail"}}},"DetectResult":{"type":"object","required":["detections"],"properties":{"detections":{"type":"array","items":{"$ref":"#/components/schemas/Detection"}},"detectorType":{"description":"Internal.","type":"integer"},"landmarksType":{"description":"Internal.","type":"integer"},"scenario":{"description":"Scenario from Request processParam.","$ref":"#/components/schemas/FaceQualityScenarios"},"timer":{"type":"float","description":"The total time taken for the detection.","example":0.8479356}}},"DetectResponse":{"allOf":[{"$ref":"#/components/schemas/FaceSDKResult"},{"type":"object","properties":{"results":{"$ref":"#/components/schemas/DetectResult"}}}]},"OperationLog":{"type":"object","properties":{"statusCode":{"type":"integer","description":"Status code."},"type":{"type":"string","description":"Error type."},"msg":{"type":"string","description":"Error message."}}},"Page":{"type":"object","description":"Information about current page number and total pages count","properties":{"page":{"type":"integer","description":"Current page number.","example":1},"totalPages":{"type":"integer","description":"Total number of pages.","example":2}}},"ImagePage":{"allOf":[{"$ref":"#/components/schemas/Page"},{"type":"object","description":"Image page.","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Image"}}}}]},"ResizeOptions":{"type":"object","description":"Set to resize the original image.","properties":{"width":{"type":"integer","description":"Resized image width, px."},"height":{"type":"integer","description":"Resized image height, px."},"quality":{"type":"integer","default":100,"description":"Resized image quality, percent."}}},"ImageFields":{"type":"object","description":"Image in the request data, includes image and contentType.","properties":{"tag":{"type":"string","description":"Session identificator."},"image":{"type":"object","description":"Uploaded image.","properties":{"contentType":{"type":"string","description":"Original media type of the uploaded image."},"content":{"$ref":"#/components/schemas/ImageData"},"imageUrl":{"type":"string","description":"Image URL."},"resizeOptions":{"$ref":"#/components/schemas/ResizeOptions"}}},"outputImageParams":{"$ref":"#/components/schemas/OutputImageParams"},"detectAll":{"$ref":"#/components/schemas/detectAll"},"threshold":{"type":"float","description":"The similarity threshold."},"limit":{"type":"integer","description":"The maximum number of results to be returned."}}},"GroupToCreate":{"type":"object","description":"Request body of the group to create data, includes name and metadata.","properties":{"tag":{"type":"string","description":"Session identificator."},"name":{"type":"string","description":"Group to create name."},"metadata":{"type":"object","additionalProperties":true,"description":"A free-form object containing group's extended attributes."}}},"Group":{"allOf":[{"$ref":"#/components/schemas/GroupToCreate"},{"type":"object","description":"Additional group data in the response, includes id and createdAt.","properties":{"id":{"type":"string","format":"uuid","description":"Group ID."},"createdAt":{"type":"string","description":"Group creation date."}}}]},"GroupPage":{"allOf":[{"type":"object","properties":{"items":{"type":"array","description":"Array of Groups that are found during the search.","items":{"$ref":"#/components/schemas/Group"}}}},{"$ref":"#/components/schemas/Page"}]},"PersonsPage":{"allOf":[{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Person"}}}},{"$ref":"#/components/schemas/Page"}]},"UpdateGroup":{"type":"object","description":"Update group.","properties":{"addItems":{"type":"array","description":"Add items.","items":{"type":"string","format":"uuid"}},"removeItems":{"type":"array","description":"Remove items.","items":{"type":"string","format":"uuid"}}}},"SearchRequest":{"allOf":[{"$ref":"#/components/schemas/SearchParameters"},{"$ref":"#/components/schemas/ImageFields"}]},"SearchDetection":{"type":"object","description":"The array of identified persons.","properties":{"code":{"type":"integer","description":"Internal."},"crop":{"type":"string","format":"base64","description":"Base64 of the aligned and cropped portrait."},"detectorType":{"type":"integer","description":"Internal."},"hash":{"type":"string","description":"Internal."},"idx":{"type":"integer","description":"Internal."},"image":{"type":"string","format":"base64","description":"Internal."},"landmarks":{"description":"Absolute coordinates (x,y) of five points of each detected face: left eye, right eye, nose, left point of lips, right point of lips.","type":"array","items":{"description":"Cartesian points. First element - X-axis coordinate. Second element - Y-axis coordinate.","type":"array","items":{"type":"integer","example":["x","y"]}},"example":[["x","y"]]},"landmarksType":{"type":"integer","description":"Internal.","example":2},"msg":{"type":"string","description":"Internal."},"roi":{"$ref":"#/components/schemas/FaceRectangular"},"versionSDK":{"type":"string","example":"5.2.245.687"}}},"SearchPerson":{"allOf":[{"$ref":"#/components/schemas/Person"},{"type":"object","description":"Person data.","properties":{"detection":{"$ref":"#/components/schemas/SearchDetection"},"images":{"type":"array","description":"Array of Person images.","items":{"$ref":"#/components/schemas/RecognizeImage"}}}}]},"SearchResult":{"type":"object","properties":{"code":{"type":"integer","description":"Search result code."},"persons":{"type":"array","description":"Person data.","items":{"$ref":"#/components/schemas/SearchPerson"}}}},"PersonCreatedResponse":{"type":"object","properties":{"code":{"type":"integer","description":"Result code."},"persons":{"type":"array","description":"Array of Person images.","items":{"$ref":"#/components/schemas/SearchPerson"}},"metadata":{"type":"object","additionalProperties":true,"description":"A free-form object containing person's extended attributes."}}},"SearchBadParams":{"type":"object","properties":{"msg":{"type":"string","default":"Descriptor already calculated"},"statusCode":{"type":"integer","default":400},"type":{"type":"string","default":"BadParamsException"}}},"TransactionInfo":{"type":"object","properties":{"code":{"type":"integer","description":"Result code, one of the FaceSDKResultCode enum values. See the enum: https://docs.regulaforensics.com/develop/face-sdk/web-service/development/enums/face-sdk-result-code/"},"status":{"type":"integer","default":null,"description":"Whether the liveness detection is confirmed (0) or not (1)."},"tag":{"type":"string","description":"Session identificator."},"transactionId":{"type":"string","description":"Transaction ID, there can be several transactions within one session."},"video":{"type":"string","description":"Link to the session video."},"age":{"type":"integer","description":"Approximate age with an accuracy of +/-3 years."},"portrait":{"type":"string","description":"Link to the portrait."},"metadata":{"type":"object","additionalProperties":true,"description":"A free-form object containing person's extended attributes."}}}},"responses":{"BadLicense":{"description":"Bad license. Either the server or request does not contain a valid license."},"SuccessPerson":{"description":"Successful operation; return person.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Person"}}}},"BadRequest":{"description":"Bad request. Check your input data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationLog"}}}},"PersonNotFound":{"description":"Person with the personId is not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationLog"}}}},"SuccessEmpty":{"description":"Successful operation, return nothing."},"SuccessGroup":{"description":"Successful operation; return group.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Group"}}}},"GroupNotFound":{"description":"Group with the groupId is not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationLog"}}}},"SearchBadParamsException":{"description":"Bad request. Check your input data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchBadParams"}}}},"ReadinessOK":{"description":"License is OK.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"ReadinessBad":{"description":"Bad license: deactivated, expired, etc.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}}}}}},"searchIndex":{"store":["section/Clients","tag/matching","tag/matching/operation/match","tag/matching/operation/match_and_search","tag/matching/operation/detect","tag/person","tag/person/operation/create_person","tag/person/operation/get_person","tag/person/operation/update_person","tag/person/operation/delete_person","tag/person/operation/get_all_images_by_person_id","tag/person/operation/add_image_to_person","tag/person/operation/get_image_of_person","tag/person/operation/delete_image_of_person","tag/person/operation/get_all_groups_by_person_id","tag/group","tag/group/operation/get_all_groups","tag/group/operation/create_group","tag/group/operation/get_group","tag/group/operation/update_group","tag/group/operation/delete_group","tag/group/operation/get_all_persons_by_group_id","tag/group/operation/update_persons_in_group","tag/search","tag/search/operation/search","tag/liveness-2.0","tag/liveness-2.0/operation/get_liveness_transaction_info","tag/diagnostics","tag/diagnostics/operation/readiness"],"index":{"version":"2.3.9","fields":["title","description"],"fieldVectors":[["title/0",[0,3.201]],["description/0",[0,1.22,1,1.742,2,0.442,3,0.442,4,0.442,5,0.442,6,0.442,7,0.442,8,0.442,9,0.442,10,0.442,11,0.442,12,0.442,13,0.442,14,0.828,15,0.442]],["title/1",[16,3.201]],["description/1",[]],["title/2",[17,2.612,18,2.166,19,2.612]],["description/2",[20,3.529]],["title/3",[16,1.865,21,1.865,22,2.248,23,2.248]],["description/3",[24,3.529]],["title/4",[18,1.316,25,1.586,26,1.586,27,1.586,28,1.316,29,1.586,30,1.586]],["description/4",[31,3.529]],["title/5",[32,1.029]],["description/5",[]],["title/6",[32,0.83,33,2.584]],["description/6",[34,3.529]],["title/7",[32,1.029]],["description/7",[35,2.531]],["title/8",[32,0.83,36,2.584]],["description/8",[35,2.531]],["title/9",[32,0.83,37,2.234]],["description/9",[35,2.531]],["title/10",[32,0.83,38,1.764]],["description/10",[39,2.928]],["title/11",[32,0.696,38,1.479,40,2.612]],["description/11",[39,2.928]],["title/12",[32,0.696,38,1.479,41,2.612]],["description/12",[42,2.928]],["title/13",[32,0.696,37,1.873,38,1.479]],["description/13",[42,2.928]],["title/14",[32,0.83,43,1.092]],["description/14",[44,3.529]],["title/15",[43,1.352]],["description/15",[]],["title/16",[43,1.352]],["description/16",[45,2.928]],["title/17",[33,2.584,43,1.092]],["description/17",[45,2.928]],["title/18",[43,1.352]],["description/18",[46,2.531]],["title/19",[36,2.584,43,1.092]],["description/19",[46,2.531]],["title/20",[37,2.234,43,1.092]],["description/20",[46,2.531]],["title/21",[32,0.83,43,1.092]],["description/21",[47,2.928]],["title/22",[32,0.696,43,0.915,48,2.612]],["description/22",[47,2.928]],["title/23",[21,3.201]],["description/23",[]],["title/24",[32,0.599,38,1.273,43,0.788,49,2.248]],["description/24",[50,3.529]],["title/25",[51,2.584,52,3.115]],["description/25",[]],["title/26",[28,2.584,51,2.584]],["description/26",[53,3.529]],["title/27",[54,3.859]],["description/27",[]],["title/28",[55,2.612,56,2.612,57,2.612]],["description/28",[58,3.529]]],"invertedIndex":[["",{"_index":1,"title":{},"description":{"0":{}}}],["2.0",{"_index":52,"title":{"25":{}},"description":{}}],["3.5",{"_index":12,"title":{},"description":{"0":{}}}],["add",{"_index":40,"title":{"11":{}},"description":{}}],["add/remov",{"_index":48,"title":{"22":{}},"description":{}}],["android",{"_index":10,"title":{},"description":{"0":{}}}],["api/detect",{"_index":31,"title":{},"description":{"4":{}}}],["api/group",{"_index":45,"title":{},"description":{"16":{},"17":{}}}],["api/groups/{groupid",{"_index":46,"title":{},"description":{"18":{},"19":{},"20":{}}}],["api/groups/{groupid}/person",{"_index":47,"title":{},"description":{"21":{},"22":{}}}],["api/match",{"_index":20,"title":{},"description":{"2":{}}}],["api/match_and_search",{"_index":24,"title":{},"description":{"3":{}}}],["api/person",{"_index":34,"title":{},"description":{"6":{}}}],["api/persons/{personid",{"_index":35,"title":{},"description":{"7":{},"8":{},"9":{}}}],["api/persons/{personid}/group",{"_index":44,"title":{},"description":{"14":{}}}],["api/persons/{personid}/imag",{"_index":39,"title":{},"description":{"10":{},"11":{}}}],["api/persons/{personid}/images/{imageid",{"_index":42,"title":{},"description":{"12":{},"13":{}}}],["api/readi",{"_index":58,"title":{},"description":{"28":{}}}],["api/search",{"_index":50,"title":{},"description":{"24":{}}}],["api/v2/l",{"_index":53,"title":{},"description":{"26":{}}}],["assess",{"_index":28,"title":{"4":{},"26":{}},"description":{}}],["attribut",{"_index":27,"title":{"4":{}},"description":{}}],["axio",{"_index":6,"title":{},"description":{"0":{}}}],["base",{"_index":5,"title":{},"description":{"0":{}}}],["browser",{"_index":3,"title":{},"description":{"0":{}}}],["c#](https://github.com/regulaforensics/facesdk-web-csharp-cli",{"_index":13,"title":{},"description":{"0":{}}}],["check",{"_index":55,"title":{"28":{}},"description":{}}],["client",{"_index":0,"title":{"0":{}},"description":{"0":{}}}],["combin",{"_index":19,"title":{"2":{}},"description":{}}],["compar",{"_index":17,"title":{"2":{}},"description":{}}],["compat",{"_index":8,"title":{},"description":{"0":{}}}],["core",{"_index":15,"title":{},"description":{"0":{}}}],["creat",{"_index":33,"title":{"6":{},"17":{}},"description":{}}],["delet",{"_index":37,"title":{"9":{},"13":{},"20":{}},"description":{}}],["detect",{"_index":25,"title":{"4":{}},"description":{}}],["diagnost",{"_index":54,"title":{"27":{}},"description":{}}],["evalu",{"_index":26,"title":{"4":{}},"description":{}}],["face",{"_index":18,"title":{"2":{},"4":{}},"description":{}}],["find",{"_index":49,"title":{"24":{}},"description":{}}],["group",{"_index":43,"title":{"14":{},"15":{},"16":{},"17":{},"18":{},"19":{},"20":{},"21":{},"22":{},"24":{}},"description":{}}],["id",{"_index":41,"title":{"12":{}},"description":{}}],["imag",{"_index":38,"title":{"10":{},"11":{},"12":{},"13":{},"24":{}},"description":{}}],["java](https://github.com/regulaforensics/facesdk-web-java-cli",{"_index":7,"title":{},"description":{"0":{}}}],["javascript](https://github.com/regulaforensics/facesdk-web-js-cli",{"_index":2,"title":{},"description":{"0":{}}}],["jvm",{"_index":9,"title":{},"description":{"0":{}}}],["licens",{"_index":56,"title":{"28":{}},"description":{}}],["live",{"_index":51,"title":{"25":{},"26":{}},"description":{}}],["match",{"_index":16,"title":{"1":{},"3":{}},"description":{}}],["net",{"_index":14,"title":{},"description":{"0":{}}}],["node.j",{"_index":4,"title":{},"description":{"0":{}}}],["on",{"_index":22,"title":{"3":{}},"description":{}}],["person",{"_index":32,"title":{"5":{},"6":{},"7":{},"8":{},"9":{},"10":{},"11":{},"12":{},"13":{},"14":{},"21":{},"22":{},"24":{}},"description":{}}],["portrait",{"_index":29,"title":{"4":{}},"description":{}}],["python](https://github.com/regulaforensics/facesdk-web-python-cli",{"_index":11,"title":{},"description":{"0":{}}}],["qualiti",{"_index":30,"title":{"4":{}},"description":{}}],["request",{"_index":23,"title":{"3":{}},"description":{}}],["search",{"_index":21,"title":{"3":{},"23":{}},"description":{}}],["statu",{"_index":57,"title":{"28":{}},"description":{}}],["updat",{"_index":36,"title":{"8":{},"19":{}},"description":{}}]],"pipeline":[]}},"options":{"maxDisplayedEnumValues":5,"theme":{"logo":{"gutter":"20px"},"colors":{"primary":{"main":"#8a53cb"}}},"expandResponses":"all","expandSingleSchemaField":true,"hideDownloadButton":true,"jsonSampleExpandLevel":6}};
+    const __redoc_state = {"menu":{"activeItemIdx":-1},"spec":{"data":{"openapi":"3.0.3","info":{"version":"5.2.0","title":"Regula FaceSDK Web API","x-logo":{"url":"https://static-content.regulaforensics.com/Icons/Logos/Regula-logo.svg","href":"https://mobile.regulaforensics.com/"},"description":"Regula FaceSDK Web API\n# Clients\n* [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios\n* [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android\n* [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client\n* [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core\n","x-tagGroups":{"name":"liveness","tags":["liveness","match"]}},"servers":[{"url":"http://localhost:41101/","description":"Local on-premise installation"}],"paths":{"/api/match":{"parameters":[{"$ref":"#/components/parameters/x-request"}],"post":{"tags":["matching"],"summary":"Compare faces in all combinations","operationId":"match","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MatchRequest"}}}},"responses":{"200":{"description":"Successful operation; the compare results are returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MatchResponse"}}}},"403":{"$ref":"#/components/responses/BadLicense"}}}},"/api/match_and_search":{"parameters":[{"$ref":"#/components/parameters/x-request"}],"post":{"tags":["matching"],"summary":"Match and Search in one request","operationId":"match_and_search","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MatchAndSearchRequest"}}}},"responses":{"200":{"description":"Successful operation; the compare results are returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MatchAndSearchResponse"}}}},"403":{"$ref":"#/components/responses/BadLicense"}}}},"/api/detect":{"parameters":[{"$ref":"#/components/parameters/x-request"}],"post":{"tags":["matching"],"summary":"Detect face, evaluate attributes, assess the portrait quality","operationId":"detect","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DetectRequest"}}}},"responses":{"200":{"description":"Successful operation; the coordinates of the detected faces are returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DetectResponse"}}}},"403":{"$ref":"#/components/responses/BadLicense"}}}},"/api/persons":{"parameters":[{"$ref":"#/components/parameters/x-request"}],"post":{"tags":["person"],"summary":"Create person","operationId":"create_person","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonFields"}}}},"responses":{"201":{"$ref":"#/components/responses/SuccessPerson"},"400":{"$ref":"#/components/responses/BadRequest"}}}},"/api/persons/{personId}":{"parameters":[{"$ref":"#/components/parameters/personId"},{"$ref":"#/components/parameters/x-request"}],"get":{"tags":["person"],"summary":"Get person","operationId":"get_person","responses":{"200":{"$ref":"#/components/responses/SuccessPerson"},"400":{"$ref":"#/components/responses/BadRequest"},"404":{"$ref":"#/components/responses/PersonNotFound"}}},"put":{"tags":["person"],"summary":"Update person","operationId":"update_person","requestBody":{"description":"Request body for the Person to update.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonFields"}}}},"responses":{"204":{"$ref":"#/components/responses/SuccessEmpty"},"400":{"$ref":"#/components/responses/BadRequest"},"404":{"$ref":"#/components/responses/PersonNotFound"}}},"delete":{"tags":["person"],"summary":"Delete person","operationId":"delete_person","responses":{"204":{"$ref":"#/components/responses/SuccessEmpty"},"400":{"$ref":"#/components/responses/BadRequest"},"404":{"$ref":"#/components/responses/PersonNotFound"}}}},"/api/persons/{personId}/images":{"parameters":[{"$ref":"#/components/parameters/personId"},{"$ref":"#/components/parameters/x-request"}],"get":{"tags":["person"],"summary":"Get person images","operationId":"get_all_images_by_person_id","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/size"}],"responses":{"200":{"description":"Successful operation; return all person images.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImagePage"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"404":{"$ref":"#/components/responses/PersonNotFound"}}},"post":{"tags":["person"],"summary":"Add person image","operationId":"add_image_to_person","requestBody":{"description":"Image to add.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageFields"}}}},"responses":{"200":{"description":"Successful operation; return image ID.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Image"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"404":{"$ref":"#/components/responses/PersonNotFound"}}}},"/api/persons/{personId}/images/{imageId}":{"parameters":[{"$ref":"#/components/parameters/personId"},{"$ref":"#/components/parameters/x-request"}],"get":{"tags":["person"],"summary":"Get person image by id","operationId":"get_image_of_person","parameters":[{"$ref":"#/components/parameters/imageId"}],"responses":{"200":{"description":"Successful operation, return image.","content":{"image/*":{"schema":{"type":"string","format":"binary"}}}},"400":{"$ref":"#/components/responses/BadRequest","description":"Person does not have such an image."},"404":{"$ref":"#/components/responses/PersonNotFound","description":"Such an image does not exists."}}},"delete":{"tags":["person"],"summary":"Delete image of person","operationId":"delete_image_of_person","parameters":[{"$ref":"#/components/parameters/imageId"}],"responses":{"204":{"$ref":"#/components/responses/SuccessEmpty"},"400":{"$ref":"#/components/responses/BadRequest"},"404":{"description":"Person with the personId or image with the imageId is not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationLog"}}}}}}},"/api/persons/{personId}/groups":{"parameters":[{"$ref":"#/components/parameters/personId"},{"$ref":"#/components/parameters/x-request"}],"get":{"tags":["person"],"summary":"Get person groups","operationId":"get_all_groups_by_person_id","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/size"}],"responses":{"200":{"description":"Successful operation; return all groups.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupPage"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"404":{"$ref":"#/components/responses/PersonNotFound"}}}},"/api/groups":{"parameters":[{"$ref":"#/components/parameters/x-request"}],"get":{"tags":["group"],"summary":"Get groups","operationId":"get_all_groups","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/size"}],"responses":{"200":{"description":"Successful operation, return all groups.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupPage"}}}},"400":{"$ref":"#/components/responses/BadRequest"}}},"post":{"tags":["group"],"summary":"Create group","operationId":"create_group","requestBody":{"description":"Request body for the group to create.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupToCreate"}}}},"responses":{"201":{"$ref":"#/components/responses/SuccessGroup"},"400":{"$ref":"#/components/responses/BadRequest"}}}},"/api/groups/{groupId}":{"parameters":[{"$ref":"#/components/parameters/groupId"},{"$ref":"#/components/parameters/x-request"}],"get":{"tags":["group"],"summary":"Get group","operationId":"get_group","responses":{"200":{"$ref":"#/components/responses/SuccessGroup"},"400":{"$ref":"#/components/responses/BadRequest"},"404":{"$ref":"#/components/responses/GroupNotFound"}}},"put":{"tags":["group"],"summary":"Update group","operationId":"update_group","requestBody":{"description":"Request body for the group to update.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupToCreate"}}}},"responses":{"204":{"$ref":"#/components/responses/SuccessEmpty"},"400":{"$ref":"#/components/responses/BadRequest"},"404":{"$ref":"#/components/responses/GroupNotFound"}}},"delete":{"tags":["group"],"summary":"Delete group","operationId":"delete_group","responses":{"204":{"$ref":"#/components/responses/SuccessEmpty"},"404":{"$ref":"#/components/responses/GroupNotFound"}}}},"/api/groups/{groupId}/persons":{"parameters":[{"$ref":"#/components/parameters/groupId"},{"$ref":"#/components/parameters/x-request"}],"get":{"tags":["group"],"summary":"Get group persons","operationId":"get_all_persons_by_group_id","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/size"}],"responses":{"200":{"description":"Successful operation, return all persons.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonsPage"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"404":{"description":"Group with the groupId or persons with the personIds are not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationLog"}}}}}},"put":{"tags":["group"],"summary":"Add/remove persons to group","operationId":"update_persons_in_group","requestBody":{"description":"Request body for person IDs to add or remove.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateGroup"}}}},"responses":{"204":{"$ref":"#/components/responses/SuccessEmpty"},"400":{"$ref":"#/components/responses/BadRequest"},"404":{"$ref":"#/components/responses/GroupNotFound"}}}},"/api/search":{"parameters":[{"$ref":"#/components/parameters/x-request"}],"post":{"tags":["search"],"summary":"Find person by image in groups","operationId":"search","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchRequest"}}}},"responses":{"200":{"description":"Successful operation; the search result is returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchResult"}}}},"201":{"description":"New person created with the search photo and the data specified.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonCreatedResponse"}}}},"400":{"$ref":"#/components/responses/SearchBadParamsException"}}}},"/api/v2/liveness":{"parameters":[{"$ref":"#/components/parameters/transactionId"}],"get":{"tags":["liveness 2.0"],"summary":"Liveness assessment","operationId":"get_liveness_transaction_info","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionInfo"}}}}}}},"/api/readiness":{"parameters":[{"$ref":"#/components/parameters/x-request"}],"get":{"tags":["diagnostics"],"summary":"Checking the license status","operationId":"readiness","responses":{"200":{"$ref":"#/components/responses/ReadinessOK"},"400":{"$ref":"#/components/responses/ReadinessBad"}}}}},"components":{"parameters":{"x-request":{"in":"header","name":"X-RequestID","description":"Request header label.","schema":{"type":"string"}},"personId":{"name":"personId","in":"path","description":"Person ID.","required":true,"schema":{"format":"uuid","type":"string"}},"page":{"name":"page","in":"query","required":true,"description":"The page number to get a list of persons or groups.","schema":{"type":"integer","default":1}},"size":{"name":"size","in":"query","required":true,"description":"The page size with a list of persons or groups, items.","schema":{"type":"integer","default":1000}},"imageId":{"name":"imageId","in":"path","description":"Image ID.","required":true,"schema":{"string":"uuid","type":"string"}},"groupId":{"name":"groupId","in":"path","description":"Group ID.","required":true,"schema":{"type":"string","format":"uuid"}},"transactionId":{"in":"query","name":"transactionId","required":true,"description":"ID of the current liveness transaction.","schema":{"type":"string","format":"uuid"}}},"schemas":{"MatchImageIndex":{"type":"integer","description":"The image index number. Can be given; if not given, the index numbers are set automatically starting from 0. All index numbers must be whole and unique—not repeated."},"ImageSource":{"description":"The type of the image, defines the way the comparison is performed. See the enum: https://docs.regulaforensics.com/develop/face-sdk/web-service/development/enums/image-source/","type":"integer","enum":[1,2,3,4,5,6],"x-enum-varnames":["DOCUMENT_PRINTED","DOCUMENT_RFID","LIVE","DOCUMENT_WITH_LIVE","EXTERNAL","GHOST"]},"ImageData":{"description":"Base64 encoded image.","type":"string","format":"byte"},"detectAll":{"type":"boolean","description":"Whether to detect all faces in the image. If set to false, only the most central face is detected.","default":false},"MatchImage":{"type":"object","required":["data"],"properties":{"index":{"$ref":"#/components/schemas/MatchImageIndex"},"type":{"$ref":"#/components/schemas/ImageSource"},"data":{"$ref":"#/components/schemas/ImageData"},"detectAll":{"$ref":"#/components/schemas/detectAll"}}},"MatchRequest":{"type":"object","required":["images"],"properties":{"tag":{"type":"string","description":"Session identificator."},"thumbnails":{"type":"boolean","description":"Whether to return thumbnails: Base64 cropped images that contain vertically aligned faces.","default":false},"images":{"type":"array","description":"The array of all images included in the comparison.","items":{"$ref":"#/components/schemas/MatchImage"}}}},"FaceSDKResultCode":{"type":"integer","description":"The result code, see enum: https://docs.regulaforensics.com/develop/face-sdk/web-service/development/enums/face-sdk-result-code/","enum":[0,1,2,3,4,5,6,7,199,200,201,202,203,224,227,228,229,230,231,232,233,234,235,236,237,238,239,240,242,243,244,245,246,247,248,249,250,251,252],"x-enum-varnames":["FACER_OK","FR_IMAGE_EMPTY","FR_FACE_NOT_DETECTED","FR_LANDMARKS_NOT_DETECTED","FR_FACE_ALIGHNER_FAILED","FR_DESCRIPTOR_EXTRACTOR_ERROR","FR_IMAGE_DECODE_ERROR","FR_INTERNAL_ERROR","FACER_CONFIG_ERROR","FACER_NO_LICENSE","FACER_IS_NOT_INITIALIZED","FACER_COMMAND_IS_NOT_SUPPORTED","FACER_COMMAND_PARAMS_READ_ERROR","FACER_LESS_THAN_TWO_IMAGES_IN_REQUEST","FACER_VIDEO_DECODE_ERROR","FACER_NOT_ENOUGH_FRAMES","FACER_OUTPUT_IS_NOT_DEFINED","FACER_CLOSED_EYES_DETECTED","FACER_LOW_QUALITY","FACER_HIGH_ASYMMETRY","FACER_FACE_OVER_EMOTIONAL","FACER_SUNGLASSES_DETECTED","FACER_SMALL_AGE","FACER_HEADDRESS_DETECTED","FACER_FACES_NOT_MATCHED","FACER_IMAGES_COUNT_LIMIT_EXCEEDED","FACER_MEDICINE_MASK_DETECTED","FACER_OCCLUSION_DETECTED","FACER_FOREHEAD_GLASSES_DETECTED","FACER_MOUTH_OPENED","FACER_ART_MASK_DETECTED","FACER_ELECTRONIC_DEVICE_DETECTED","FACER_TRACK_BREAK","FACER_WRONG_GEO","FACER_WRONG_OF","FACER_WRONG_VIEW","FACER_TIMEOUT_LIVENESS_TRANSACTION","FACER_FAILED_LIVENESS_TRANSACTION","FACER_ABORTED_LIVENESS_TRANSACTION"]},"FaceSDKResult":{"type":"object","required":["code"],"properties":{"code":{"$ref":"#/components/schemas/FaceSDKResultCode"}}},"MatchFaceIndex":{"type":"number","description":"The detected face index number."},"FaceRectangular":{"description":"The rectangular area of a detected face that is represented by a set of four elements: the X and Y coordinates of the top-left point, and the width and height dimensions of the rectangle.","type":"array","items":{"type":"number"},"example":["x","y","width","height"]},"Thumbnail":{"description":"Base64 of the cropped portrait.","type":"string","format":"byte"},"DetectionFace":{"type":"object","properties":{"faceIndex":{"$ref":"#/components/schemas/MatchFaceIndex"},"landmarks":{"description":"Absolute coordinates (x,y) of five points of each detected face: left eye, right eye, nose, left point of lips, right point of lips.","type":"array","items":{"description":"Cartesian points. First element - X-axis coordinate. Second element - Y-axis coordinate.","type":"array","items":{"type":"number","example":["x","y"]}},"example":[["x","y"]]},"rotationAngle":{"description":"Angle of rotation of the face from the vertical axis, degrees.","type":"float"},"roi":{"$ref":"#/components/schemas/FaceRectangular"},"thumbnail":{"$ref":"#/components/schemas/Thumbnail"}}},"MatchImageDetection":{"type":"object","required":["imageIndex","status"],"properties":{"faces":{"type":"array","description":"The array of detected faces.","items":{"$ref":"#/components/schemas/DetectionFace"}},"imageIndex":{"$ref":"#/components/schemas/MatchImageIndex"},"status":{"$ref":"#/components/schemas/FaceSDKResultCode"}}},"MatchImageResult":{"type":"object","required":["firstIndex","secondIndex"],"properties":{"firstIndex":{"$ref":"#/components/schemas/MatchImageIndex"},"firstFaceIndex":{"$ref":"#/components/schemas/MatchFaceIndex"},"first":{"$ref":"#/components/schemas/ImageSource"},"secondIndex":{"$ref":"#/components/schemas/MatchImageIndex"},"secondFaceIndex":{"$ref":"#/components/schemas/MatchFaceIndex"},"second":{"$ref":"#/components/schemas/ImageSource"},"score":{"type":"number","description":"A dimensionless number that shows how similar the compared faces are. 0—absolutely identical faces."},"similarity":{"type":"number","description":"The detected faces similarity, %. 100%—absolutely identical faces, 0%—absolutely not identical."}}},"MatchResponse":{"allOf":[{"$ref":"#/components/schemas/FaceSDKResult"},{"type":"object","properties":{"detections":{"type":"array","description":"The array of detected faces.","items":{"$ref":"#/components/schemas/MatchImageDetection"}},"results":{"type":"array","description":"The array of matching results.","items":{"$ref":"#/components/schemas/MatchImageResult"}}}}]},"SearchParameters":{"type":"object","description":"Request search data.","properties":{"createPerson":{"type":"object","description":"If a person is not found, a new person entry is created using the descriptor calculated while searching.","properties":{"name":{"type":"string","description":"Person's name."},"metadata":{"type":"object","additionalProperties":true,"description":"A free-form object containing person's extended attributes."}}},"groupIds":{"type":"array","description":"IDs of the groups in which the search is performed.","items":{"type":"integer"}}}},"MatchAndSearchRequest":{"allOf":[{"type":"object","properties":{"tag":{"type":"string","description":"Session identificator."},"images":{"type":"array","description":"Array of Person images.","items":{"type":"object","properties":{"content":{"$ref":"#/components/schemas/ImageData"},"type":{"$ref":"#/components/schemas/ImageSource"}}}}}},{"$ref":"#/components/schemas/SearchParameters"}]},"Image":{"type":"object","description":"Image in the response.","properties":{"id":{"type":"string","description":"Response image ID. The list is sorted by decreasing ID value."},"contentType":{"type":"string","description":"Original media type of the returned image."},"createdAt":{"type":"string","description":"Returned image creation date."},"updatedAt":{"type":"string","description":"Returned image update date."},"path":{"type":"string","description":"Returned image path."},"url":{"type":"string","description":"Returned image URL."},"metadata":{"type":"object","additionalProperties":true,"description":"A free-form object containing person's extended attributes."}}},"RecognizeImage":{"allOf":[{"$ref":"#/components/schemas/Image"},{"type":"object","properties":{"similarity":{"type":"number","format":"float","description":"Similarity score."},"distance":{"type":"number","format":"float","description":"Similarity distance score: the lower the distance, the higher the face's similarity."}}}]},"PersonFields":{"type":"object","description":"Person Request body: name and metadata.","properties":{"tag":{"type":"string","description":"Session identificator."},"name":{"type":"string","description":"Person name."},"metadata":{"type":"object","additionalProperties":true,"description":"A free-form object containing person's extended attributes."},"groups":{"type":"array","description":"Groups a person should be placed to. If no group is specified in request, a Default group is created and the person is placed to it.","items":{"type":"string","format":"uuid"}}}},"Person":{"description":"Person response body: person ID, creation date, update date if any.","allOf":[{"$ref":"#/components/schemas/PersonFields"},{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Person ID. The list of persons is sorted by decreasing ID value."},"createdAt":{"type":"string","description":"Person creation date."},"updatedAt":{"type":"string","description":"Person update date."},"groups":{"type":"array","description":"List of groups this person belongs to.","items":{"type":"string","format":"uuid"}}}}]},"PersonWithImages":{"allOf":[{"type":"object","properties":{"images":{"type":"array","items":{"$ref":"#/components/schemas/RecognizeImage"}}}},{"$ref":"#/components/schemas/Person"}]},"FacesResponse":{"allOf":[{"$ref":"#/components/schemas/DetectionFace"},{"type":"object","properties":{"persons":{"type":"array","items":{"$ref":"#/components/schemas/PersonWithImages"}},"rotationAngle":{"type":"float","example":2.1272900104522705}}}]},"MatchAndSearchResponse":{"allOf":[{"$ref":"#/components/schemas/FaceSDKResult"},{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/MatchImageResult"}},"elapsedTime":{"type":"float","example":1.317137987},"metadata":{"type":"object","additionalProperties":true,"description":"A free-form object containing person's extended attributes."},"detections":{"type":"array","items":{"type":"object","properties":{"faces":{"type":"array","items":{"$ref":"#/components/schemas/FacesResponse"}},"imageIndex":{"$ref":"#/components/schemas/MatchImageIndex"},"status":{"$ref":"#/components/schemas/FaceSDKResultCode"}}}}}}]},"FaceQualityScenarios":{"type":"string","description":"Face detection scenario.","enum":["OldMode","QualityFull","QualityICAO","QualityVisaSchengen","QualityVisaUSA","CropCentralFace","CropAllFaces","Thumbnail"],"x-enum-varnames":["OLD_MODE","QUALITY_FULL","QUALITY_ICAO","QUALITY_VISA_SCHENGEN","QUALITY_VISA_USA","CROP_CENTRAL_FACE","CROP_ALL_FACES","THUMBNAIL"]},"RGB":{"type":"array","description":"The RGB value of a color for filling background behind a person's silhouette and for aligning the image.","items":{"type":"integer"},"minItems":3,"maxItems":3,"example":[128,128,128]},"FaceImageQualityAlignType":{"type":"integer","description":"The aspect ratio according to which face alignment is performed during face detection.","enum":[0,1,2,3,4],"x-enum-varnames":["ALIGN_3x4","ALIGN_4x5","ALIGN_2x3","ALIGN_1x1","ALIGN_7x9"]},"Crop":{"type":"object","description":"Whether to return the Base64 of an aligned and cropped portrait in the crop field.","properties":{"type":{"$ref":"#/components/schemas/FaceImageQualityAlignType","description":"The dimensions ratio to the height of the required pattern.","example":1},"padColor":{"$ref":"#/components/schemas/RGB","description":"The RGB value for the color that will complement the image if this is needed for alignment."},"size":{"type":"array","items":{"type":"integer"},"minItems":2,"maxItems":2,"description":"The resize value in case type matches this value. If it doesn't, no resize is done.","example":[300,400]},"returnOriginalRect":{"type":"boolean","description":"Whether to return the coordinates of the rectangle with the face in the original image prepared for the face crop.","example":true}}},"OutputImageParams":{"type":"object","description":"Whether to process the uploaded image according to the indicated settings.","properties":{"backgroundColor":{"description":"The RGB value for the background color: the silhouette of a person is cut out and the background is filled with this color.","$ref":"#/components/schemas/RGB"},"crop":{"description":"Whether to return the Base64 of an aligned and cropped portrait in the crop field.","$ref":"#/components/schemas/Crop"}}},"FaceAttribute":{"type":"string","description":"Face attributes.","enum":["Age","Emotion","EyeLeft","EyeRight","Smile","Glasses","HeadCovering","ForeheadCovering","Mouth","MedicalMask","Occlusion","StrongMakeup","Headphones"],"x-enum-varnames":["AGE","EMOTION","EYE_LEFT","EYE_RIGHT","SMILE","GLASSES","HEAD_COVERING","FOREHEAD_COVERING","MOUTH","MEDICAL_MASK","OCCLUSION","STRONG_MAKEUP","HEADPHONES"]},"QualityConfig":{"type":"object","description":"The configuration that defines the list of returned quality check characteristics.","properties":{"name":{"description":"The name of the characteristic.","$ref":"#/components/schemas/FaceAttribute","example":"Emotion"},"range":{"type":"array","items":{"type":"float"},"minItems":2,"maxItems":2,"description":"The range of applicable values for this characteristic. If the returned in the Response value fits this range, the value is identified as compliant with the requirements.","example":["x","y"]}}},"QualityConfigList":{"type":"array","items":{"$ref":"#/components/schemas/QualityConfig"}},"QualityRequest":{"type":"object","description":"Whether to perform the portrait quality check.","properties":{"backgroundMatchColor":{"description":"The RGB value for the background color: the silhouette of a person is cut out and the background is filled with this color.","$ref":"#/components/schemas/RGB"},"config":{"$ref":"#/components/schemas/QualityConfigList"}}},"ProcessParam":{"type":"object","description":"The processing parameters.","properties":{"scenario":{"$ref":"#/components/schemas/FaceQualityScenarios"},"onlyCentralFace":{"type":"boolean","description":"Whether to process only the central face on the image (true) or all the faces (false).","example":false},"outputImageParams":{"$ref":"#/components/schemas/OutputImageParams"},"quality":{"$ref":"#/components/schemas/QualityRequest"},"attributes":{"description":"If set, the selected attributes, such as age or emotions, are evaluated.","type":"object","properties":{"config":{"$ref":"#/components/schemas/QualityConfigList"}}}}},"DetectRequest":{"type":"object","properties":{"tag":{"type":"string","description":"Session identificator."},"processParam":{"$ref":"#/components/schemas/ProcessParam"},"image":{"$ref":"#/components/schemas/ImageData"},"thumbnails":{"description":"Whether to return the cropped portrains with the detected faces.","type":"boolean","default":false}}},"FaceQualityConfigName":{"type":"string","description":"All image characteristics that can be assessed during face image quality assessment.","enum":["ImageWidth","ImageHeight","ImageWidthToHeight","ImageChannelsNumber","PaddingRatio","FaceMidPointHorizontalPosition","FaceMidPointVerticalPosition","HeadWidthRatio","HeadHeightRatio","EyesDistance","Yaw","Pitch","Roll","BlurLevel","NoiseLevel","EyeRightClosed","EyeLeftClosed","EyeRightOccluded","EyeLeftOccluded","EyesRed","EyeRightCoveredWithHair","EyeLeftCoveredWithHair","OffGaze","FaceDynamicRange","UnnaturalSkinTone","TooDark","TooLight","FaceGlare","ShadowsOnFace","DarkGlasses","ReflectionOnGlasses","FramesTooHeavy","FaceOccluded","HeadCovering","BackgroundUniformity","ShadowsOnBackground","OtherFaces","ShouldersPose","ExpressionLevel","MouthOpen","ForeheadCovering","Smile","StrongMakeup","Headphones","MedicalMask","BackgroundColorMatch","ArtFace","ContactLenses"],"x-enum-varnames":["IMAGE_WIDTH","IMAGE_HEIGHT","IMAGE_WIDTH_TO_HEIGHT","IMAGE_CHANNELS_NUMBER","PADDING_RATIO","FACE_MID_POINT_HORIZONTAL_POSITION","FACE_MID_POINT_VERTICAL_POSITION","HEAD_WIDTH_RATIO","HEAD_HEIGHT_RATIO","EYES_DISTANCE","YAW","PITCH","ROLL","BLUR_LEVEL","NOISE_LEVEL","EYE_RIGHT_CLOSED","EYE_LEFT_CLOSED","EYE_RIGHT_OCCLUDED","EYE_LEFT_OCCLUDED","EYES_RED","EYE_RIGHT_COVERED_WITH_HAIR","EYE_LEFT_COVERED_WITH_HAIR","OFF_GAZE","FACE_DYNAMIC_RANGE","UNNATURAL_SKIN_TONE","TOO_DARK","TOO_LIGHT","FACE_GLARE","SHADOWS_ON_FACE","DARK_GLASSES","REFLECTION_ON_GLASSES","FRAMES_TOO_HEAVY","FACE_OCCLUDED","HEAD_COVERING","BACKGROUND_UNIFORMITY","SHADOWS_ON_BACKGROUND","OTHER_FACES","SHOULDERS_POSE","EXPRESSION_LEVEL","MOUTH_OPEN","FOREHEAD_COVERING","SMILE","STRONG_MAKEUP","HEADPHONES","MEDICAL_MASK","BACKGROUND_COLOR_MATCH","ART_FACE","CONTACT_LENSES"]},"FaceImageQualityGroups":{"type":"integer","description":"Face image quality group types for face image quality assessment.","enum":[1,2,3,4,5,6,7,8],"x-enum-varnames":["IMAGE_CHARACTERISTICS","HEAD_SIZE_AND_POSITIONS","FACE_QUALITY","EYES_CHARACTERISTICS","SHADOWS_AND_LIGHTNING","POSE_AND_EXPRESSION","HEAD_OCCLUSION","BACKGROUND"]},"FaceImageQualityGroupsStrings":{"type":"string","description":"Face image quality group types for face image quality assessment.","enum":["ImageCharacteristics","HeadSizeAndPosition","FaceQuality","EyesCharacteristics","ShadowsAndLightning","PoseAndExpression","HeadOcclusion","Background"],"x-enum-varnames":["IMAGE_CHARACTERISTICS","HEAD_SIZE_AND_POSITIONS","FACE_QUALITY","EYES_CHARACTERISTICS","SHADOWS_AND_LIGHTNING","POSE_AND_EXPRESSION","HEAD_OCCLUSION","BACKGROUND"]},"QualityDetailsGroups":{"type":"object","properties":{"groupId":{"description":"The ID of the characteristics group.","$ref":"#/components/schemas/FaceImageQualityGroups"},"name":{"$ref":"#/components/schemas/FaceImageQualityGroupsStrings","description":"The name of the characteristics group."},"totalCount":{"type":"integer","description":"The total number of characteristics in the group.","example":5},"compliantCount":{"type":"integer","description":"The number of compliant characteristics in the group.","example":4}}},"FaceImageQualityStatus":{"type":"integer","description":"The processing status returned for each assessed quality characteristic.","enum":[0,1,2],"x-enum-varnames":["QUALITY_STATUS_FALSE","QUALITY_STATUS_TRUE","QUALITY_STATUS_UNDETERMINED"]},"QualityDetail":{"type":"object","properties":{"groupId":{"description":"The ID of the characteristics group.","$ref":"#/components/schemas/FaceImageQualityGroups","example":0},"name":{"$ref":"#/components/schemas/FaceQualityConfigName","description":"The name of the characteristic.","example":"Roll"},"range":{"type":"array","description":"The range of set values for this characteristic.","items":{"type":"float"},"minItems":2,"maxItems":2,"example":["x","y"]},"status":{"$ref":"#/components/schemas/FaceImageQualityStatus","example":1,"description":"The assessment status."},"value":{"type":"float","description":"The assessed value for the characteristic, returned in the set units.","example":0}}},"Detection":{"type":"object","required":["landmarks","roi"],"properties":{"crop":{"description":"Base64 of the aligned and cropped portrait. Returned if align is set.","$ref":"#/components/schemas/ImageData"},"attributes":{"type":"object","properties":{"details":{"type":"array","items":{"type":"object","additionalProperties":true}},"elapsedTime":{"type":"number","description":"The elapsed time for attribute detection."}}},"landmarks":{"description":"Absolute coordinates (x,y) of five points of each detected face: left eye, right eye, nose, left point of lips, right point of lips.","type":"array","items":{"description":"Cartesian points. First element - X-axis coordinate. Second element - Y-axis coordinate.","type":"array","items":{"type":"integer","example":["x","y"]}},"example":[["x","y"]]},"quality":{"type":"object","description":"Field for checking the portrait quality. If it is not mentioned, no quality check is performed.","properties":{"nonCompliant":{"type":"array","description":"The array of all the non-compliant assessment characteristics.","items":{"$ref":"#/components/schemas/FaceQualityConfigName"},"example":["ImageWidthToHeight","Yaw"]},"detailsGroups":{"description":"The array of the assessment results for each group of characteristics.","type":"array","items":{"$ref":"#/components/schemas/QualityDetailsGroups"}},"details":{"type":"array","description":"The array of the assessment characteristics that were set in the request.","items":{"$ref":"#/components/schemas/QualityDetail"}},"score":{"type":"float","description":"Returns the estimated portrait quality assessment result, a number from 0 to 1, where 1 is for absolute compliance.","example":-1},"timer":{"type":"float","description":"The total time the quality assessment has taken.","example":0.420364111661911}}},"roi":{"$ref":"#/components/schemas/FaceRectangular"},"thumbnail":{"$ref":"#/components/schemas/Thumbnail"}}},"DetectResult":{"type":"object","required":["detections"],"properties":{"detections":{"type":"array","items":{"$ref":"#/components/schemas/Detection"}},"detectorType":{"description":"Internal.","type":"integer"},"landmarksType":{"description":"Internal.","type":"integer"},"scenario":{"description":"Scenario from Request processParam.","$ref":"#/components/schemas/FaceQualityScenarios"},"timer":{"type":"float","description":"The total time taken for the detection.","example":0.8479356}}},"DetectResponse":{"allOf":[{"$ref":"#/components/schemas/FaceSDKResult"},{"type":"object","properties":{"results":{"$ref":"#/components/schemas/DetectResult"}}}]},"OperationLog":{"type":"object","properties":{"statusCode":{"type":"integer","description":"Status code."},"type":{"type":"string","description":"Error type."},"msg":{"type":"string","description":"Error message."}}},"Page":{"type":"object","description":"Information about current page number and total pages count","properties":{"page":{"type":"integer","description":"Current page number.","example":1},"totalPages":{"type":"integer","description":"Total number of pages.","example":2}}},"ImagePage":{"allOf":[{"$ref":"#/components/schemas/Page"},{"type":"object","description":"Image page.","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Image"}}}}]},"ResizeOptions":{"type":"object","description":"Set to resize the original image.","properties":{"width":{"type":"integer","description":"Resized image width, px."},"height":{"type":"integer","description":"Resized image height, px."},"quality":{"type":"integer","default":100,"description":"Resized image quality, percent."}}},"ImageFields":{"type":"object","description":"Image in the request data, includes image and contentType.","properties":{"tag":{"type":"string","description":"Session identificator."},"image":{"type":"object","description":"Uploaded image.","properties":{"contentType":{"type":"string","description":"Original media type of the uploaded image."},"content":{"$ref":"#/components/schemas/ImageData"},"imageUrl":{"type":"string","description":"Image URL."},"resizeOptions":{"$ref":"#/components/schemas/ResizeOptions"}}},"outputImageParams":{"$ref":"#/components/schemas/OutputImageParams"},"detectAll":{"$ref":"#/components/schemas/detectAll"},"threshold":{"type":"float","description":"The similarity threshold."},"limit":{"type":"integer","description":"The maximum number of results to be returned."}}},"GroupToCreate":{"type":"object","description":"Request body of the group to create data, includes name and metadata.","properties":{"tag":{"type":"string","description":"Session identificator."},"name":{"type":"string","description":"Group to create name."},"metadata":{"type":"object","additionalProperties":true,"description":"A free-form object containing group's extended attributes."}}},"Group":{"allOf":[{"$ref":"#/components/schemas/GroupToCreate"},{"type":"object","description":"Additional group data in the response, includes id and createdAt.","properties":{"id":{"type":"string","format":"uuid","description":"Group ID."},"createdAt":{"type":"string","description":"Group creation date."}}}]},"GroupPage":{"allOf":[{"type":"object","properties":{"items":{"type":"array","description":"Array of Groups that are found during the search.","items":{"$ref":"#/components/schemas/Group"}}}},{"$ref":"#/components/schemas/Page"}]},"PersonsPage":{"allOf":[{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Person"}}}},{"$ref":"#/components/schemas/Page"}]},"UpdateGroup":{"type":"object","description":"Update group.","properties":{"addItems":{"type":"array","description":"Add items.","items":{"type":"string","format":"uuid"}},"removeItems":{"type":"array","description":"Remove items.","items":{"type":"string","format":"uuid"}}}},"SearchRequest":{"allOf":[{"$ref":"#/components/schemas/SearchParameters"},{"$ref":"#/components/schemas/ImageFields"}]},"SearchDetection":{"type":"object","description":"The array of identified persons.","properties":{"code":{"type":"integer","description":"Internal."},"crop":{"type":"string","format":"base64","description":"Base64 of the aligned and cropped portrait."},"detectorType":{"type":"integer","description":"Internal."},"hash":{"type":"string","description":"Internal."},"idx":{"type":"integer","description":"Internal."},"image":{"type":"string","format":"base64","description":"Internal."},"landmarks":{"description":"Absolute coordinates (x,y) of five points of each detected face: left eye, right eye, nose, left point of lips, right point of lips.","type":"array","items":{"description":"Cartesian points. First element - X-axis coordinate. Second element - Y-axis coordinate.","type":"array","items":{"type":"integer","example":["x","y"]}},"example":[["x","y"]]},"landmarksType":{"type":"integer","description":"Internal.","example":2},"msg":{"type":"string","description":"Internal."},"roi":{"$ref":"#/components/schemas/FaceRectangular"},"versionSDK":{"type":"string","example":"5.2.245.687"}}},"SearchPerson":{"allOf":[{"$ref":"#/components/schemas/Person"},{"type":"object","description":"Person data.","properties":{"detection":{"$ref":"#/components/schemas/SearchDetection"},"images":{"type":"array","description":"Array of Person images.","items":{"$ref":"#/components/schemas/RecognizeImage"}}}}]},"SearchResult":{"type":"object","properties":{"code":{"type":"integer","description":"Search result code."},"persons":{"type":"array","description":"Person data.","items":{"$ref":"#/components/schemas/SearchPerson"}}}},"PersonCreatedResponse":{"type":"object","properties":{"code":{"type":"integer","description":"Result code."},"persons":{"type":"array","description":"Array of Person images.","items":{"$ref":"#/components/schemas/SearchPerson"}},"metadata":{"type":"object","additionalProperties":true,"description":"A free-form object containing person's extended attributes."}}},"SearchBadParams":{"type":"object","properties":{"msg":{"type":"string","default":"Descriptor already calculated"},"statusCode":{"type":"integer","default":400},"type":{"type":"string","default":"BadParamsException"}}},"TransactionInfo":{"type":"object","properties":{"code":{"type":"integer","description":"Result code, one of the FaceSDKResultCode enum values. See the enum: https://docs.regulaforensics.com/develop/face-sdk/web-service/development/enums/face-sdk-result-code/"},"status":{"type":"integer","default":null,"description":"Whether the liveness detection is confirmed (0) or not (1)."},"tag":{"type":"string","description":"Session identificator."},"transactionId":{"type":"string","description":"Transaction ID, there can be several transactions within one session."},"video":{"type":"string","description":"Link to the session video."},"age":{"type":"integer","description":"Approximate age with an accuracy of +/-3 years."},"portrait":{"type":"string","description":"Link to the portrait."},"metadata":{"type":"object","additionalProperties":true,"description":"A free-form object containing person's extended attributes."}}}},"responses":{"BadLicense":{"description":"Bad license. Either the server or request does not contain a valid license."},"SuccessPerson":{"description":"Successful operation; return person.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Person"}}}},"BadRequest":{"description":"Bad request. Check your input data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationLog"}}}},"PersonNotFound":{"description":"Person with the personId is not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationLog"}}}},"SuccessEmpty":{"description":"Successful operation, return nothing."},"SuccessGroup":{"description":"Successful operation; return group.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Group"}}}},"GroupNotFound":{"description":"Group with the groupId is not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationLog"}}}},"SearchBadParamsException":{"description":"Bad request. Check your input data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchBadParams"}}}},"ReadinessOK":{"description":"License is OK.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"ReadinessBad":{"description":"Bad license: deactivated, expired, etc.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}}}}}},"searchIndex":{"store":["section/Clients","tag/matching","tag/matching/operation/match","tag/matching/operation/match_and_search","tag/matching/operation/detect","tag/person","tag/person/operation/create_person","tag/person/operation/get_person","tag/person/operation/update_person","tag/person/operation/delete_person","tag/person/operation/get_all_images_by_person_id","tag/person/operation/add_image_to_person","tag/person/operation/get_image_of_person","tag/person/operation/delete_image_of_person","tag/person/operation/get_all_groups_by_person_id","tag/group","tag/group/operation/get_all_groups","tag/group/operation/create_group","tag/group/operation/get_group","tag/group/operation/update_group","tag/group/operation/delete_group","tag/group/operation/get_all_persons_by_group_id","tag/group/operation/update_persons_in_group","tag/search","tag/search/operation/search","tag/liveness-2.0","tag/liveness-2.0/operation/get_liveness_transaction_info","tag/diagnostics","tag/diagnostics/operation/readiness"],"index":{"version":"2.3.9","fields":["title","description"],"fieldVectors":[["title/0",[0,3.201]],["description/0",[0,1.22,1,1.742,2,0.442,3,0.442,4,0.442,5,0.442,6,0.442,7,0.442,8,0.442,9,0.442,10,0.442,11,0.442,12,0.442,13,0.442,14,0.828,15,0.442]],["title/1",[16,3.201]],["description/1",[]],["title/2",[17,2.612,18,2.166,19,2.612]],["description/2",[20,3.529]],["title/3",[16,1.865,21,1.865,22,2.248,23,2.248]],["description/3",[24,3.529]],["title/4",[18,1.316,25,1.586,26,1.586,27,1.586,28,1.316,29,1.586,30,1.586]],["description/4",[31,3.529]],["title/5",[32,1.029]],["description/5",[]],["title/6",[32,0.83,33,2.584]],["description/6",[34,3.529]],["title/7",[32,1.029]],["description/7",[35,2.531]],["title/8",[32,0.83,36,2.584]],["description/8",[35,2.531]],["title/9",[32,0.83,37,2.234]],["description/9",[35,2.531]],["title/10",[32,0.83,38,1.764]],["description/10",[39,2.928]],["title/11",[32,0.696,38,1.479,40,2.612]],["description/11",[39,2.928]],["title/12",[32,0.696,38,1.479,41,2.612]],["description/12",[42,2.928]],["title/13",[32,0.696,37,1.873,38,1.479]],["description/13",[42,2.928]],["title/14",[32,0.83,43,1.092]],["description/14",[44,3.529]],["title/15",[43,1.352]],["description/15",[]],["title/16",[43,1.352]],["description/16",[45,2.928]],["title/17",[33,2.584,43,1.092]],["description/17",[45,2.928]],["title/18",[43,1.352]],["description/18",[46,2.531]],["title/19",[36,2.584,43,1.092]],["description/19",[46,2.531]],["title/20",[37,2.234,43,1.092]],["description/20",[46,2.531]],["title/21",[32,0.83,43,1.092]],["description/21",[47,2.928]],["title/22",[32,0.696,43,0.915,48,2.612]],["description/22",[47,2.928]],["title/23",[21,3.201]],["description/23",[]],["title/24",[32,0.599,38,1.273,43,0.788,49,2.248]],["description/24",[50,3.529]],["title/25",[51,2.584,52,3.115]],["description/25",[]],["title/26",[28,2.584,51,2.584]],["description/26",[53,3.529]],["title/27",[54,3.859]],["description/27",[]],["title/28",[55,2.612,56,2.612,57,2.612]],["description/28",[58,3.529]]],"invertedIndex":[["",{"_index":1,"title":{},"description":{"0":{}}}],["2.0",{"_index":52,"title":{"25":{}},"description":{}}],["3.5",{"_index":12,"title":{},"description":{"0":{}}}],["add",{"_index":40,"title":{"11":{}},"description":{}}],["add/remov",{"_index":48,"title":{"22":{}},"description":{}}],["android",{"_index":10,"title":{},"description":{"0":{}}}],["api/detect",{"_index":31,"title":{},"description":{"4":{}}}],["api/group",{"_index":45,"title":{},"description":{"16":{},"17":{}}}],["api/groups/{groupid",{"_index":46,"title":{},"description":{"18":{},"19":{},"20":{}}}],["api/groups/{groupid}/person",{"_index":47,"title":{},"description":{"21":{},"22":{}}}],["api/match",{"_index":20,"title":{},"description":{"2":{}}}],["api/match_and_search",{"_index":24,"title":{},"description":{"3":{}}}],["api/person",{"_index":34,"title":{},"description":{"6":{}}}],["api/persons/{personid",{"_index":35,"title":{},"description":{"7":{},"8":{},"9":{}}}],["api/persons/{personid}/group",{"_index":44,"title":{},"description":{"14":{}}}],["api/persons/{personid}/imag",{"_index":39,"title":{},"description":{"10":{},"11":{}}}],["api/persons/{personid}/images/{imageid",{"_index":42,"title":{},"description":{"12":{},"13":{}}}],["api/readi",{"_index":58,"title":{},"description":{"28":{}}}],["api/search",{"_index":50,"title":{},"description":{"24":{}}}],["api/v2/l",{"_index":53,"title":{},"description":{"26":{}}}],["assess",{"_index":28,"title":{"4":{},"26":{}},"description":{}}],["attribut",{"_index":27,"title":{"4":{}},"description":{}}],["axio",{"_index":6,"title":{},"description":{"0":{}}}],["base",{"_index":5,"title":{},"description":{"0":{}}}],["browser",{"_index":3,"title":{},"description":{"0":{}}}],["c#](https://github.com/regulaforensics/facesdk-web-csharp-cli",{"_index":13,"title":{},"description":{"0":{}}}],["check",{"_index":55,"title":{"28":{}},"description":{}}],["client",{"_index":0,"title":{"0":{}},"description":{"0":{}}}],["combin",{"_index":19,"title":{"2":{}},"description":{}}],["compar",{"_index":17,"title":{"2":{}},"description":{}}],["compat",{"_index":8,"title":{},"description":{"0":{}}}],["core",{"_index":15,"title":{},"description":{"0":{}}}],["creat",{"_index":33,"title":{"6":{},"17":{}},"description":{}}],["delet",{"_index":37,"title":{"9":{},"13":{},"20":{}},"description":{}}],["detect",{"_index":25,"title":{"4":{}},"description":{}}],["diagnost",{"_index":54,"title":{"27":{}},"description":{}}],["evalu",{"_index":26,"title":{"4":{}},"description":{}}],["face",{"_index":18,"title":{"2":{},"4":{}},"description":{}}],["find",{"_index":49,"title":{"24":{}},"description":{}}],["group",{"_index":43,"title":{"14":{},"15":{},"16":{},"17":{},"18":{},"19":{},"20":{},"21":{},"22":{},"24":{}},"description":{}}],["id",{"_index":41,"title":{"12":{}},"description":{}}],["imag",{"_index":38,"title":{"10":{},"11":{},"12":{},"13":{},"24":{}},"description":{}}],["java](https://github.com/regulaforensics/facesdk-web-java-cli",{"_index":7,"title":{},"description":{"0":{}}}],["javascript](https://github.com/regulaforensics/facesdk-web-js-cli",{"_index":2,"title":{},"description":{"0":{}}}],["jvm",{"_index":9,"title":{},"description":{"0":{}}}],["licens",{"_index":56,"title":{"28":{}},"description":{}}],["live",{"_index":51,"title":{"25":{},"26":{}},"description":{}}],["match",{"_index":16,"title":{"1":{},"3":{}},"description":{}}],["net",{"_index":14,"title":{},"description":{"0":{}}}],["node.j",{"_index":4,"title":{},"description":{"0":{}}}],["on",{"_index":22,"title":{"3":{}},"description":{}}],["person",{"_index":32,"title":{"5":{},"6":{},"7":{},"8":{},"9":{},"10":{},"11":{},"12":{},"13":{},"14":{},"21":{},"22":{},"24":{}},"description":{}}],["portrait",{"_index":29,"title":{"4":{}},"description":{}}],["python](https://github.com/regulaforensics/facesdk-web-python-cli",{"_index":11,"title":{},"description":{"0":{}}}],["qualiti",{"_index":30,"title":{"4":{}},"description":{}}],["request",{"_index":23,"title":{"3":{}},"description":{}}],["search",{"_index":21,"title":{"3":{},"23":{}},"description":{}}],["statu",{"_index":57,"title":{"28":{}},"description":{}}],["updat",{"_index":36,"title":{"8":{},"19":{}},"description":{}}]],"pipeline":[]}},"options":{"maxDisplayedEnumValues":5,"theme":{"logo":{"gutter":"20px"},"colors":{"primary":{"main":"#8a53cb"}}},"expandResponses":"all","expandSingleSchemaField":true,"hideDownloadButton":true,"jsonSampleExpandLevel":6}};
 
     var container = document.getElementById('redoc');
     Redoc.hydrate(__redoc_state, container);