{ "info": { "_postman_id": "a49d3b54-3a1f-40e6-9179-884444c025d8", "name": "Microsoft Azure Face Client", "description": "An API for face detection, verification, and identification.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "lastUpdatedBy": "35240", "uid": "35240-a49d3b54-3a1f-40e6-9179-884444c025d8" }, "item": [ { "name": "findsimilars", "item": [ { "name": "Microsoft Azure Post Findsimilars", "id": "ddd1a9a3-2958-490f-9ada-7b2b487488c8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"faceId\": \"\",\n \"faceListId\": \"m\",\n \"largeFaceListId\": \"7rdu1\",\n \"faceIds\": [\n \"\",\n \"\"\n ],\n \"maxNumOfCandidatesReturned\": 20,\n \"mode\": \"matchPerson\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/findsimilars", "host": [ "{{baseUrl}}" ], "path": [ "findsimilars" ] }, "description": "Given query face's faceId, to search the similar-looking faces from a faceId array, a face list or a large face list. faceId array contains the faces created by [Face - Detect With Url](https://docs.microsoft.com/rest/api/faceapi/face/detectwithurl) or [Face - Detect With Stream](https://docs.microsoft.com/rest/api/faceapi/face/detectwithstream), which will expire at the time specified by faceIdTimeToLive after creation. A \"faceListId\" is created by [FaceList - Create](https://docs.microsoft.com/rest/api/faceapi/facelist/create) containing persistedFaceIds that will not expire. And a \"largeFaceListId\" is created by [LargeFaceList - Create](https://docs.microsoft.com/rest/api/faceapi/largefacelist/create) containing persistedFaceIds that will also not expire. Depending on the input the returned similar faces list contains faceIds or persistedFaceIds ranked by similarity.
Find similar has two working modes, \"matchPerson\" and \"matchFace\". \"matchPerson\" is the default mode that it tries to find faces of the same person as possible by using internal same-person thresholds. It is useful to find a known person's other photos. Note that an empty list will be returned if no faces pass the internal thresholds. \"matchFace\" mode ignores same-person thresholds and returns ranked similar faces anyway, even the similarity is low. It can be used in the cases like searching celebrity-looking faces.
The 'recognitionModel' associated with the query face's faceId should be the same as the 'recognitionModel' used by the target faceId array, face list or large face list.
" }, "response": [ { "id": "93760677-697e-4ce8-aa09-9c908eaa1d62", "name": "A successful call returns an array of the most similar faces represented in faceId if the input parameter is faceIds or persistedFaceId if the input parameter is faceListId.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"faceId\": \"\",\n \"faceListId\": \"m\",\n \"largeFaceListId\": \"7rdu1\",\n \"faceIds\": [\n \"\",\n \"\"\n ],\n \"maxNumOfCandidatesReturned\": 20,\n \"mode\": \"matchPerson\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/findsimilars", "host": [ "{{baseUrl}}" ], "path": [ "findsimilars" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"confidence\": \"\",\n \"faceId\": \"\",\n \"persistedFaceId\": \"\"\n },\n {\n \"confidence\": \"\",\n \"faceId\": \"\",\n \"persistedFaceId\": \"\"\n }\n]", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-93760677-697e-4ce8-aa09-9c908eaa1d62" }, { "id": "6ef74dcc-1424-4120-8593-e2b64d866fba", "name": "Error response.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"faceId\": \"\",\n \"faceListId\": \"m\",\n \"largeFaceListId\": \"7rdu1\",\n \"faceIds\": [\n \"\",\n \"\"\n ],\n \"maxNumOfCandidatesReturned\": 20,\n \"mode\": \"matchPerson\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/findsimilars", "host": [ "{{baseUrl}}" ], "path": [ "findsimilars" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-6ef74dcc-1424-4120-8593-e2b64d866fba" } ], "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-ddd1a9a3-2958-490f-9ada-7b2b487488c8" } ], "id": "cf45ee5f-9937-4bbe-adfb-5e9cbbef6cdf", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-cf45ee5f-9937-4bbe-adfb-5e9cbbef6cdf" }, { "name": "group", "item": [ { "name": "Microsoft Azure Post Group", "id": "c02c8255-26d6-40e7-a588-f169846a79b0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"faceIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/group", "host": [ "{{baseUrl}}" ], "path": [ "group" ] }, "description": "Divide candidate faces into groups based on face similarity.
* The output is one or more disjointed face groups and a messyGroup. A face group contains faces that have similar looking, often of the same person. Face groups are ranked by group size, i.e. number of faces. Notice that faces belonging to a same person might be split into several groups in the result.
* MessyGroup is a special face group containing faces that cannot find any similar counterpart face from original faces. The messyGroup will not appear in the result if all faces found their counterparts.
* Group API needs at least 2 candidate faces and 1000 at most. We suggest to try [Face - Verify](https://docs.microsoft.com/rest/api/faceapi/face/verifyfacetoface) when you only have 2 candidate faces.
* The 'recognitionModel' associated with the query faces' faceIds should be the same.
" }, "response": [ { "id": "d6d003c7-e4c7-4511-af37-8bd75e506e13", "name": "A successful call returns one or more groups of similar faces (rank by group size) and a messyGroup.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"faceIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/group", "host": [ "{{baseUrl}}" ], "path": [ "group" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"groups\": [\n [\n \"\",\n \"\"\n ],\n [\n \"\",\n \"\"\n ]\n ],\n \"messyGroup\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-d6d003c7-e4c7-4511-af37-8bd75e506e13" }, { "id": "8672db29-3972-4886-9975-876c5a64de1b", "name": "Error response.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"faceIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/group", "host": [ "{{baseUrl}}" ], "path": [ "group" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-8672db29-3972-4886-9975-876c5a64de1b" } ], "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-c02c8255-26d6-40e7-a588-f169846a79b0" } ], "id": "cb760079-84ff-4847-b9bf-41723c384812", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-cb760079-84ff-4847-b9bf-41723c384812" }, { "name": "identify", "item": [ { "name": "Microsoft Azure Post Identify", "id": "f1db957f-367c-4ded-9ef4-cab6afb9d555", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"faceIds\": [\n \"\",\n \"\"\n ],\n \"personGroupId\": \"qx311py\",\n \"largePersonGroupId\": \"aktbe9b3\",\n \"dynamicPersonGroupId\": \"i4nbzinql96\",\n \"personIds\": [\n \"\",\n \"\"\n ],\n \"maxNumOfCandidatesReturned\": 1,\n \"confidenceThreshold\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/identify", "host": [ "{{baseUrl}}" ], "path": [ "identify" ] }, "description": "1-to-many identification to find the closest matches of the specific query person face from a person group, large person group, person directory dynamic person group or person directory personIds array.
For each face in the faceIds array, Face Identify will compute similarities between the query face and all the faces in the person group (given by personGroupId) or large person group (given by largePersonGroupId), and return candidate person(s) for that face ranked by similarity confidence. The person group/large person group should be trained to make it ready for identification. See more in [PersonGroup - Train](https://docs.microsoft.com/rest/api/faceapi/persongroup/train) and [LargePersonGroup - Train](https://docs.microsoft.com/rest/api/faceapi/largepersongroup/train).


Remarks:
* The algorithm allows more than one face to be identified independently at the same request, but no more than 10 faces.
* Each person in the person group/large person group could have more than one face, but no more than 248 faces.
* Higher face image quality means better identification precision. Please consider high-quality faces: frontal, clear, and face size is 200x200 pixels (100 pixels between eyes) or bigger.
* Number of candidates returned is restricted by maxNumOfCandidatesReturned and confidenceThreshold. If no person is identified, the returned candidates will be an empty array.
* Try [Face - Find Similar](https://docs.microsoft.com/rest/api/faceapi/face/findsimilar) when you need to find similar faces from a face list/large face list instead of a person group/large person group.
* The 'recognitionModel' associated with the query faces' faceIds should be the same as the 'recognitionModel' used by the target person group or large person group.
" }, "response": [ { "id": "d9655a70-fb9c-4d29-a94c-8c0174d46a5b", "name": "A successful call returns the identified candidate person(s) for each query face.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"faceIds\": [\n \"\",\n \"\"\n ],\n \"personGroupId\": \"qx311py\",\n \"largePersonGroupId\": \"aktbe9b3\",\n \"dynamicPersonGroupId\": \"i4nbzinql96\",\n \"personIds\": [\n \"\",\n \"\"\n ],\n \"maxNumOfCandidatesReturned\": 1,\n \"confidenceThreshold\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/identify", "host": [ "{{baseUrl}}" ], "path": [ "identify" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"faceId\": \"\",\n \"candidates\": [\n {\n \"personId\": \"\",\n \"confidence\": \"\"\n },\n {\n \"personId\": \"\",\n \"confidence\": \"\"\n }\n ]\n },\n {\n \"faceId\": \"\",\n \"candidates\": [\n {\n \"personId\": \"\",\n \"confidence\": \"\"\n },\n {\n \"personId\": \"\",\n \"confidence\": \"\"\n }\n ]\n }\n]", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-d9655a70-fb9c-4d29-a94c-8c0174d46a5b" }, { "id": "d601ab45-573a-489a-b719-8a8f4beedce9", "name": "Error response.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"faceIds\": [\n \"\",\n \"\"\n ],\n \"personGroupId\": \"qx311py\",\n \"largePersonGroupId\": \"aktbe9b3\",\n \"dynamicPersonGroupId\": \"i4nbzinql96\",\n \"personIds\": [\n \"\",\n \"\"\n ],\n \"maxNumOfCandidatesReturned\": 1,\n \"confidenceThreshold\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/identify", "host": [ "{{baseUrl}}" ], "path": [ "identify" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-d601ab45-573a-489a-b719-8a8f4beedce9" } ], "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-f1db957f-367c-4ded-9ef4-cab6afb9d555" } ], "id": "b0719b0b-6ad5-4b9e-8317-a80e1dd93078", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-b0719b0b-6ad5-4b9e-8317-a80e1dd93078" }, { "name": "verify", "item": [ { "name": "Microsoft Azure Post Verify", "id": "9ec92c9a-fb9d-43a5-9e32-2002075e1d01", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"faceId1\": \"\",\n \"faceId2\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/verify", "host": [ "{{baseUrl}}" ], "path": [ "verify" ] }, "description": "Verify whether two faces belong to a same person or whether one face belongs to a person.

Remarks:
* Higher face image quality means better identification precision. Please consider high-quality faces: frontal, clear, and face size is 200x200 pixels (100 pixels between eyes) or bigger.
* For the scenarios that are sensitive to accuracy please make your own judgment.
* The 'recognitionModel' associated with the query faces' faceIds should be the same as the 'recognitionModel' used by the target face, person group or large person group.
" }, "response": [ { "id": "6ffb1ba7-11a9-4636-b2c5-8d7c27220f0f", "name": "A successful call returns the verification result.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"faceId1\": \"\",\n \"faceId2\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/verify", "host": [ "{{baseUrl}}" ], "path": [ "verify" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"isIdentical\": \"\",\n \"confidence\": \"\"\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-6ffb1ba7-11a9-4636-b2c5-8d7c27220f0f" }, { "id": "c606f473-bf14-450c-91bd-ac0d71662cb5", "name": "Error response.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"faceId1\": \"\",\n \"faceId2\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/verify", "host": [ "{{baseUrl}}" ], "path": [ "verify" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-c606f473-bf14-450c-91bd-ac0d71662cb5" } ], "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-9ec92c9a-fb9d-43a5-9e32-2002075e1d01" } ], "id": "d98d3672-14bc-4731-a0c3-181b252d64fb", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-d98d3672-14bc-4731-a0c3-181b252d64fb" }, { "name": "persongroups", "item": [ { "name": "{personGroupId}", "item": [ { "name": "persons", "item": [ { "name": "{personId}", "item": [ { "name": "persistedfaces", "item": [ { "name": "{persistedFaceId}", "item": [ { "name": "Microsoft Azure Delete Persongroups Persongroupid Persons Personid Persistedfaces Persistedfaceid", "id": "12213a4d-6986-434c-98b1-f4f57d09a86b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/persongroups/:personGroupId/persons/:personId/persistedfaces/:persistedFaceId", "host": [ "{{baseUrl}}" ], "path": [ "persongroups", ":personGroupId", "persons", ":personId", "persistedfaces", ":persistedFaceId" ], "variable": [ { "id": "713de327-546e-4fed-97a2-42755a169a16", "key": "personGroupId", "value": "p3", "description": "(Required) Id referencing a particular person group." }, { "id": "abd8fa80-0366-4a39-a454-d444e827a64f", "key": "personId", "value": "", "description": "(Required) Id referencing a particular person." }, { "id": "2ab55387-bee7-4207-a517-6ac028b2b967", "key": "persistedFaceId", "value": "", "description": "(Required) Id referencing a particular persistedFaceId of an existing face." } ] }, "description": "Delete a face from a person in a person group by specified personGroupId, personId and persistedFaceId.
Adding/deleting faces to/from a same person will be processed sequentially. Adding/deleting faces to/from different persons are processed in parallel." }, "response": [ { "id": "58b5e929-818d-4766-9ed0-911d3c8bb6a6", "name": "A successful call returns an empty response body.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/persongroups/:personGroupId/persons/:personId/persistedfaces/:persistedFaceId", "host": [ "{{baseUrl}}" ], "path": [ "persongroups", ":personGroupId", "persons", ":personId", "persistedfaces", ":persistedFaceId" ], "variable": [ { "key": "personGroupId" }, { "key": "personId" }, { "key": "persistedFaceId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-58b5e929-818d-4766-9ed0-911d3c8bb6a6" }, { "id": "31ecbf12-b77a-4b74-a423-22adc7794d24", "name": "Error response.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/persongroups/:personGroupId/persons/:personId/persistedfaces/:persistedFaceId", "host": [ "{{baseUrl}}" ], "path": [ "persongroups", ":personGroupId", "persons", ":personId", "persistedfaces", ":persistedFaceId" ], "variable": [ { "key": "personGroupId" }, { "key": "personId" }, { "key": "persistedFaceId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-31ecbf12-b77a-4b74-a423-22adc7794d24" } ], "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-12213a4d-6986-434c-98b1-f4f57d09a86b" }, { "name": "Microsoft Azure Get Persongroups Persongroupid Persons Personid Persistedfaces Persistedfaceid", "id": "1ead728e-3c93-47be-950d-76f5a277a241", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/persongroups/:personGroupId/persons/:personId/persistedfaces/:persistedFaceId", "host": [ "{{baseUrl}}" ], "path": [ "persongroups", ":personGroupId", "persons", ":personId", "persistedfaces", ":persistedFaceId" ], "variable": [ { "id": "13d4099f-a101-4a42-a704-92fd88f77088", "key": "personGroupId", "value": "p3", "description": "(Required) Id referencing a particular person group." }, { "id": "f93a28ab-eb64-416d-9dc6-22154752abfa", "key": "personId", "value": "", "description": "(Required) Id referencing a particular person." }, { "id": "b7e79d11-19cc-40bb-888f-41fd14a08206", "key": "persistedFaceId", "value": "", "description": "(Required) Id referencing a particular persistedFaceId of an existing face." } ] }, "description": "Retrieve information about a persisted face (specified by persistedFaceId, personId and its belonging personGroupId)." }, "response": [ { "id": "8fcb0d9d-8a4b-4778-90d6-9a06ef875271", "name": "A successful call returns target persisted face's information (persistedFaceId and userData).", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/persongroups/:personGroupId/persons/:personId/persistedfaces/:persistedFaceId", "host": [ "{{baseUrl}}" ], "path": [ "persongroups", ":personGroupId", "persons", ":personId", "persistedfaces", ":persistedFaceId" ], "variable": [ { "key": "personGroupId" }, { "key": "personId" }, { "key": "persistedFaceId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"persistedFaceId\": \"\",\n \"userData\": \"\"\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-8fcb0d9d-8a4b-4778-90d6-9a06ef875271" }, { "id": "4a73d29d-e794-4b81-bca7-5e79a45285b4", "name": "Error response.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/persongroups/:personGroupId/persons/:personId/persistedfaces/:persistedFaceId", "host": [ "{{baseUrl}}" ], "path": [ "persongroups", ":personGroupId", "persons", ":personId", "persistedfaces", ":persistedFaceId" ], "variable": [ { "key": "personGroupId" }, { "key": "personId" }, { "key": "persistedFaceId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-4a73d29d-e794-4b81-bca7-5e79a45285b4" } ], "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-1ead728e-3c93-47be-950d-76f5a277a241" }, { "name": "Microsoft Azure Patch Persongroups Persongroupid Persons Personid Persistedfaces Persistedfaceid", "id": "46b291b8-1a27-4ea1-9556-f2da13b9d682", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"userData\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/persongroups/:personGroupId/persons/:personId/persistedfaces/:persistedFaceId", "host": [ "{{baseUrl}}" ], "path": [ "persongroups", ":personGroupId", "persons", ":personId", "persistedfaces", ":persistedFaceId" ], "variable": [ { "id": "872341ed-38dc-4876-b0c9-c59c879c914f", "key": "personGroupId", "value": "p3", "description": "(Required) Id referencing a particular person group." }, { "id": "b282beaa-d8ff-40a0-8a79-5599f7febd8f", "key": "personId", "value": "", "description": "(Required) Id referencing a particular person." }, { "id": "5dff106b-ff27-47c6-8cff-3eb65f85221b", "key": "persistedFaceId", "value": "", "description": "(Required) Id referencing a particular persistedFaceId of an existing face." } ] }, "description": "Add a face to a person into a person group for face identification or verification. To deal with an image contains multiple faces, input face can be specified as an image with a targetFace rectangle. It returns a persistedFaceId representing the added face. No image will be stored. Only the extracted face feature will be stored on server until [PersonGroup PersonFace - Delete](https://docs.microsoft.com/rest/api/faceapi/persongroupperson/deleteface), [PersonGroup Person - Delete](https://docs.microsoft.com/rest/api/faceapi/persongroupperson/delete) or [PersonGroup - Delete](https://docs.microsoft.com/rest/api/faceapi/persongroup/delete) is called.
Note persistedFaceId is different from faceId generated by [Face - Detect](https://docs.microsoft.com/rest/api/faceapi/face/detectwithurl).
* Higher face image quality means better recognition precision. Please consider high-quality faces: frontal, clear, and face size is 200x200 pixels (100 pixels between eyes) or bigger.
* Each person entry can hold up to 248 faces.
* JPEG, PNG, GIF (the first frame), and BMP format are supported. The allowed image file size is from 1KB to 6MB.
* \"targetFace\" rectangle should contain one face. Zero or multiple faces will be regarded as an error. If the provided \"targetFace\" rectangle is not returned from [Face - Detect](https://docs.microsoft.com/rest/api/faceapi/face/detectwithurl), there\u2019s no guarantee to detect and add the face successfully.
* Out of detectable face size (36x36 - 4096x4096 pixels), large head-pose, or large occlusions will cause failures.
* Adding/deleting faces to/from a same person will be processed sequentially. Adding/deleting faces to/from different persons are processed in parallel." }, "response": [ { "id": "626f8744-f86a-4bb4-b639-0606b2e201ac", "name": "A successful call returns an empty response body.", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"userData\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/persongroups/:personGroupId/persons/:personId/persistedfaces/:persistedFaceId", "host": [ "{{baseUrl}}" ], "path": [ "persongroups", ":personGroupId", "persons", ":personId", "persistedfaces", ":persistedFaceId" ], "variable": [ { "key": "personGroupId" }, { "key": "personId" }, { "key": "persistedFaceId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-626f8744-f86a-4bb4-b639-0606b2e201ac" }, { "id": "9ae1360e-f1e4-4fbc-8daf-1828102ba409", "name": "Error response.", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"userData\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/persongroups/:personGroupId/persons/:personId/persistedfaces/:persistedFaceId", "host": [ "{{baseUrl}}" ], "path": [ "persongroups", ":personGroupId", "persons", ":personId", "persistedfaces", ":persistedFaceId" ], "variable": [ { "key": "personGroupId" }, { "key": "personId" }, { "key": "persistedFaceId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-9ae1360e-f1e4-4fbc-8daf-1828102ba409" } ], "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-46b291b8-1a27-4ea1-9556-f2da13b9d682" } ], "id": "39ed2259-d3e5-46b7-8f6b-8f8b4970078a", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-39ed2259-d3e5-46b7-8f6b-8f8b4970078a" }, { "name": "Microsoft Azure Post Persongroups Persongroupid Persons Personid Persistedfaces", "id": "4ae92dcd-562c-4717-8ac1-a1555ffae0f8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/persongroups/:personGroupId/persons/:personId/persistedfaces?userData=&targetFace=,&detectionModel=detection_01", "host": [ "{{baseUrl}}" ], "path": [ "persongroups", ":personGroupId", "persons", ":personId", "persistedfaces" ], "query": [ { "description": "User-specified data about the face for any purpose. The maximum length is 1KB.", "key": "userData", "value": "" }, { "description": "A face rectangle to specify the target face to be added to a person in the format of \"targetFace=left,top,width,height\". E.g. \"targetFace=10,10,100,100\". If there is more than one face in the image, targetFace is required to specify which face to add. No targetFace means there is only one face detected in the entire image.", "key": "targetFace", "value": "," }, { "description": "Name of detection model. Detection model is used to detect faces in the submitted image. A detection model name can be provided when performing Face - Detect or (Large)FaceList - Add Face or (Large)PersonGroup - Add Face. The default value is 'detection_01', if another model is needed, please explicitly specify it.", "key": "detectionModel", "value": "detection_01" } ], "variable": [ { "id": "4d4cc3cc-fa80-4ad3-b270-be8c8dab6cf2", "key": "personGroupId", "value": "p3", "description": "(Required) Id referencing a particular person group." }, { "id": "6aab160d-cd13-44f5-9ff2-1792e3c393bd", "key": "personId", "value": "", "description": "(Required) Id referencing a particular person." } ] }, "description": "Add a face to a person into a person group for face identification or verification. To deal with an image contains multiple faces, input face can be specified as an image with a targetFace rectangle. It returns a persistedFaceId representing the added face. No image will be stored. Only the extracted face feature will be stored on server until [PersonGroup PersonFace - Delete](https://docs.microsoft.com/rest/api/faceapi/persongroupperson/deleteface), [PersonGroup Person - Delete](https://docs.microsoft.com/rest/api/faceapi/persongroupperson/delete) or [PersonGroup - Delete](https://docs.microsoft.com/rest/api/faceapi/persongroup/delete) is called.
Note persistedFaceId is different from faceId generated by [Face - Detect](https://docs.microsoft.com/rest/api/faceapi/face/detectwithurl).
* Higher face image quality means better recognition precision. Please consider high-quality faces: frontal, clear, and face size is 200x200 pixels (100 pixels between eyes) or bigger.
* Each person entry can hold up to 248 faces.
* JPEG, PNG, GIF (the first frame), and BMP format are supported. The allowed image file size is from 1KB to 6MB.
* \"targetFace\" rectangle should contain one face. Zero or multiple faces will be regarded as an error. If the provided \"targetFace\" rectangle is not returned from [Face - Detect](https://docs.microsoft.com/rest/api/faceapi/face/detectwithurl), there\u2019s no guarantee to detect and add the face successfully.
* Out of detectable face size (36x36 - 4096x4096 pixels), large head-pose, or large occlusions will cause failures.
* Adding/deleting faces to/from a same person will be processed sequentially. Adding/deleting faces to/from different persons are processed in parallel.
* The minimum detectable face size is 36x36 pixels in an image no larger than 1920x1080 pixels. Images with dimensions higher than 1920x1080 pixels will need a proportionally larger minimum face size.
* Different 'detectionModel' values can be provided. To use and compare different detection models, please refer to [How to specify a detection model](https://docs.microsoft.com/azure/cognitive-services/face/face-api-how-to-topics/specify-detection-model)." }, "response": [ { "id": "e7dbdf57-dfec-41ff-b990-61de636aabe5", "name": "A successful call returns the new persistedFaceId.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/persongroups/:personGroupId/persons/:personId/persistedfaces?userData=&targetFace=,&detectionModel=detection_01", "host": [ "{{baseUrl}}" ], "path": [ "persongroups", ":personGroupId", "persons", ":personId", "persistedfaces" ], "query": [ { "description": "User-specified data about the face for any purpose. The maximum length is 1KB.", "key": "userData", "value": "" }, { "description": "A face rectangle to specify the target face to be added to a person in the format of \"targetFace=left,top,width,height\". E.g. \"targetFace=10,10,100,100\". If there is more than one face in the image, targetFace is required to specify which face to add. No targetFace means there is only one face detected in the entire image.", "key": "targetFace", "value": "," }, { "description": "Name of detection model. Detection model is used to detect faces in the submitted image. A detection model name can be provided when performing Face - Detect or (Large)FaceList - Add Face or (Large)PersonGroup - Add Face. The default value is 'detection_01', if another model is needed, please explicitly specify it.", "key": "detectionModel", "value": "detection_01" } ], "variable": [ { "key": "personGroupId" }, { "key": "personId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"persistedFaceId\": \"\",\n \"userData\": \"\"\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-e7dbdf57-dfec-41ff-b990-61de636aabe5" }, { "id": "ace37780-59e7-4b65-8085-31514a6ee193", "name": "Error response.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/persongroups/:personGroupId/persons/:personId/persistedfaces?userData=&targetFace=,&detectionModel=detection_01", "host": [ "{{baseUrl}}" ], "path": [ "persongroups", ":personGroupId", "persons", ":personId", "persistedfaces" ], "query": [ { "description": "User-specified data about the face for any purpose. The maximum length is 1KB.", "key": "userData", "value": "" }, { "description": "A face rectangle to specify the target face to be added to a person in the format of \"targetFace=left,top,width,height\". E.g. \"targetFace=10,10,100,100\". If there is more than one face in the image, targetFace is required to specify which face to add. No targetFace means there is only one face detected in the entire image.", "key": "targetFace", "value": "," }, { "description": "Name of detection model. Detection model is used to detect faces in the submitted image. A detection model name can be provided when performing Face - Detect or (Large)FaceList - Add Face or (Large)PersonGroup - Add Face. The default value is 'detection_01', if another model is needed, please explicitly specify it.", "key": "detectionModel", "value": "detection_01" } ], "variable": [ { "key": "personGroupId" }, { "key": "personId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-ace37780-59e7-4b65-8085-31514a6ee193" } ], "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-4ae92dcd-562c-4717-8ac1-a1555ffae0f8" } ], "id": "d974ec58-ceb9-4a12-b3ac-e33367c96829", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-d974ec58-ceb9-4a12-b3ac-e33367c96829" }, { "name": "Microsoft Azure Delete Persongroups Persongroupid Persons Personid", "id": "3f1fafa4-5b2e-44ef-a06a-afd78b6a120e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/persongroups/:personGroupId/persons/:personId", "host": [ "{{baseUrl}}" ], "path": [ "persongroups", ":personGroupId", "persons", ":personId" ], "variable": [ { "id": "f6cf7da7-3f8c-4038-b714-add35c8213a3", "key": "personGroupId", "value": "p3", "description": "(Required) Id referencing a particular person group." }, { "id": "fa196c9b-e828-4db7-b577-78bf26c50c59", "key": "personId", "value": "", "description": "(Required) Id referencing a particular person." } ] }, "description": "Delete an existing person from a person group. The persistedFaceId, userData, person name and face feature in the person entry will all be deleted." }, "response": [ { "id": "13e69661-ddba-4bba-98bb-3f027109289c", "name": "A successful call returns an empty response body.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/persongroups/:personGroupId/persons/:personId", "host": [ "{{baseUrl}}" ], "path": [ "persongroups", ":personGroupId", "persons", ":personId" ], "variable": [ { "key": "personGroupId" }, { "key": "personId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-13e69661-ddba-4bba-98bb-3f027109289c" }, { "id": "424b9af3-18f0-4e61-9c8f-715096d05bb1", "name": "Error response.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/persongroups/:personGroupId/persons/:personId", "host": [ "{{baseUrl}}" ], "path": [ "persongroups", ":personGroupId", "persons", ":personId" ], "variable": [ { "key": "personGroupId" }, { "key": "personId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-424b9af3-18f0-4e61-9c8f-715096d05bb1" } ], "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-3f1fafa4-5b2e-44ef-a06a-afd78b6a120e" }, { "name": "Microsoft Azure Get Persongroups Persongroupid Persons Personid", "id": "9500431d-b8c2-4f52-a316-050b77b87534", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/persongroups/:personGroupId/persons/:personId", "host": [ "{{baseUrl}}" ], "path": [ "persongroups", ":personGroupId", "persons", ":personId" ], "variable": [ { "id": "6213fb18-2830-4803-bc1e-09e85c3a3160", "key": "personGroupId", "value": "p3", "description": "(Required) Id referencing a particular person group." }, { "id": "697a6792-e4b9-4a20-98f3-890e692b6102", "key": "personId", "value": "", "description": "(Required) Id referencing a particular person." } ] }, "description": "Retrieve a person's information, including registered persisted faces, name and userData." }, "response": [ { "id": "2766d0b5-c663-461f-9d3f-30ea2a61a84f", "name": "A successful call returns the person's information.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/persongroups/:personGroupId/persons/:personId", "host": [ "{{baseUrl}}" ], "path": [ "persongroups", ":personGroupId", "persons", ":personId" ], "variable": [ { "key": "personGroupId" }, { "key": "personId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"personId\": \"urn:uuid:999741a9-b955-d17d-3ee6-e8e4053ecd07\",\n \"persistedFaceIds\": [\n \"ffe92a29-1938-dfa0-f878-1c72e020f27d\",\n \"a0471804-389f-d9d5-959a-6922420cafec\"\n ],\n \"name\": \"\",\n \"userData\": \"\"\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-2766d0b5-c663-461f-9d3f-30ea2a61a84f" }, { "id": "d9912215-dfdc-471c-8cd1-cf15b392476f", "name": "Error response.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/persongroups/:personGroupId/persons/:personId", "host": [ "{{baseUrl}}" ], "path": [ "persongroups", ":personGroupId", "persons", ":personId" ], "variable": [ { "key": "personGroupId" }, { "key": "personId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-d9912215-dfdc-471c-8cd1-cf15b392476f" } ], "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-9500431d-b8c2-4f52-a316-050b77b87534" }, { "name": "Microsoft Azure Patch Persongroups Persongroupid Persons Personid", "id": "75919504-0d94-4d04-ba5d-f99e9967acf9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"userData\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/persongroups/:personGroupId/persons/:personId", "host": [ "{{baseUrl}}" ], "path": [ "persongroups", ":personGroupId", "persons", ":personId" ], "variable": [ { "id": "71c85183-12ec-4ba8-8023-efb44cd44f8e", "key": "personGroupId", "value": "p3", "description": "(Required) Id referencing a particular person group." }, { "id": "6a41d858-7122-4682-8941-146e5cacfa3d", "key": "personId", "value": "", "description": "(Required) Id referencing a particular person." } ] }, "description": "Update name or userData of a person." }, "response": [ { "id": "269fb0a1-6daa-48ad-800b-feb6e313c4de", "name": "A successful call returns an empty response body.", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"userData\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/persongroups/:personGroupId/persons/:personId", "host": [ "{{baseUrl}}" ], "path": [ "persongroups", ":personGroupId", "persons", ":personId" ], "variable": [ { "key": "personGroupId" }, { "key": "personId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-269fb0a1-6daa-48ad-800b-feb6e313c4de" }, { "id": "95dbb64d-8247-44ef-be0c-9309738ba272", "name": "Error response.", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"userData\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/persongroups/:personGroupId/persons/:personId", "host": [ "{{baseUrl}}" ], "path": [ "persongroups", ":personGroupId", "persons", ":personId" ], "variable": [ { "key": "personGroupId" }, { "key": "personId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-95dbb64d-8247-44ef-be0c-9309738ba272" } ], "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-75919504-0d94-4d04-ba5d-f99e9967acf9" } ], "id": "f9371de7-3f60-43fc-8ee5-e076d66f5170", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-f9371de7-3f60-43fc-8ee5-e076d66f5170" }, { "name": "Microsoft Azure Post Persongroups Persongroupid Persons", "id": "3c4edeb7-1523-4cbd-b649-9159baf7875f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"userData\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/persongroups/:personGroupId/persons", "host": [ "{{baseUrl}}" ], "path": [ "persongroups", ":personGroupId", "persons" ], "variable": [ { "id": "18c2722d-8a50-4f4b-81cf-ca0389175c71", "key": "personGroupId", "value": "p3", "description": "(Required) Id referencing a particular person group." } ] }, "description": "Create a new person in a specified person group." }, "response": [ { "id": "093c7bb2-b98d-4c1b-a29a-258ec27672a4", "name": "A successful call returns a new personId created.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"userData\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/persongroups/:personGroupId/persons", "host": [ "{{baseUrl}}" ], "path": [ "persongroups", ":personGroupId", "persons" ], "variable": [ { "key": "personGroupId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"personId\": \"urn:uuid:999741a9-b955-d17d-3ee6-e8e4053ecd07\",\n \"persistedFaceIds\": [\n \"ffe92a29-1938-dfa0-f878-1c72e020f27d\",\n \"a0471804-389f-d9d5-959a-6922420cafec\"\n ],\n \"name\": \"\",\n \"userData\": \"\"\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-093c7bb2-b98d-4c1b-a29a-258ec27672a4" }, { "id": "558ef6a3-eb4a-410d-ae85-95d70e5b0fd4", "name": "Error response.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"userData\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/persongroups/:personGroupId/persons", "host": [ "{{baseUrl}}" ], "path": [ "persongroups", ":personGroupId", "persons" ], "variable": [ { "key": "personGroupId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-558ef6a3-eb4a-410d-ae85-95d70e5b0fd4" } ], "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-3c4edeb7-1523-4cbd-b649-9159baf7875f" }, { "name": "Microsoft Azure Get Persongroups Persongroupid Persons", "id": "a371ad3e-8cea-4ec2-8805-40627fdcb153", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/persongroups/:personGroupId/persons?start=&top=", "host": [ "{{baseUrl}}" ], "path": [ "persongroups", ":personGroupId", "persons" ], "query": [ { "description": "Starting person id to return (used to list a range of persons).", "key": "start", "value": "" }, { "description": "Number of persons to return starting with the person id indicated by the 'start' parameter.", "key": "top", "value": "" } ], "variable": [ { "id": "c80f85f3-d52b-479c-9575-fbb0a5bb4f2c", "key": "personGroupId", "value": "p3", "description": "(Required) Id referencing a particular person group." } ] }, "description": "List all persons in a person group, and retrieve person information (including personId, name, userData and persistedFaceIds of registered faces of the person)." }, "response": [ { "id": "bb7d28ee-b738-4ef2-83f1-a1b561ff3d51", "name": "A successful call returns an array of person information that belong to the person group.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/persongroups/:personGroupId/persons?start=&top=", "host": [ "{{baseUrl}}" ], "path": [ "persongroups", ":personGroupId", "persons" ], "query": [ { "description": "Starting person id to return (used to list a range of persons).", "key": "start", "value": "" }, { "description": "Number of persons to return starting with the person id indicated by the 'start' parameter.", "key": "top", "value": "" } ], "variable": [ { "key": "personGroupId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"personId\": \"0f10a304-b0ba-7384-302d-4503896ae1c8\",\n \"persistedFaceIds\": [\n \"urn:uuid:a69b692a-431e-987a-b650-c07abc0d6b48\",\n \"urn:uuid:45132a46-44ab-4592-efcc-8c9a4c6b5d96\"\n ],\n \"name\": \"\",\n \"userData\": \"\"\n },\n {\n \"personId\": \"801f3908-c9bb-b4c4-9ff4-30937c17f7be\",\n \"persistedFaceIds\": [\n \"feeab8eb-9e5a-d50d-34f2-de17ef69a741\",\n \"a51fc096-14fb-e068-270a-2f677913dbd3\"\n ],\n \"name\": \"\",\n \"userData\": \"\"\n }\n]", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-bb7d28ee-b738-4ef2-83f1-a1b561ff3d51" }, { "id": "dba073a3-aa66-475a-9e7d-5390bac266eb", "name": "Error response.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/persongroups/:personGroupId/persons?start=&top=", "host": [ "{{baseUrl}}" ], "path": [ "persongroups", ":personGroupId", "persons" ], "query": [ { "description": "Starting person id to return (used to list a range of persons).", "key": "start", "value": "" }, { "description": "Number of persons to return starting with the person id indicated by the 'start' parameter.", "key": "top", "value": "" } ], "variable": [ { "key": "personGroupId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-dba073a3-aa66-475a-9e7d-5390bac266eb" } ], "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-a371ad3e-8cea-4ec2-8805-40627fdcb153" } ], "id": "61e1d1a8-6c49-451d-86f8-cca7b0341dd5", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-61e1d1a8-6c49-451d-86f8-cca7b0341dd5" }, { "name": "training", "item": [ { "name": "Microsoft Azure Get Persongroups Persongroupid Training", "id": "4b2faf20-3605-4542-bdb6-be03712378cd", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/persongroups/:personGroupId/training", "host": [ "{{baseUrl}}" ], "path": [ "persongroups", ":personGroupId", "training" ], "variable": [ { "id": "89190203-133e-40e8-83e5-045359e37100", "key": "personGroupId", "value": "p3", "description": "(Required) Id referencing a particular person group." } ] }, "description": "Retrieve the training status of a person group (completed or ongoing)." }, "response": [ { "id": "80c8cf65-80c5-4a34-a1f9-428a9e193387", "name": "A successful call returns the person group's training status.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/persongroups/:personGroupId/training", "host": [ "{{baseUrl}}" ], "path": [ "persongroups", ":personGroupId", "training" ], "variable": [ { "key": "personGroupId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"nonstarted\",\n \"createdDateTime\": \"\",\n \"lastActionDateTime\": \"\",\n \"lastSuccessfulTrainingDateTime\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-80c8cf65-80c5-4a34-a1f9-428a9e193387" }, { "id": "960d13f6-f18f-4ac1-8eb5-d377294f1ee0", "name": "Error response.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/persongroups/:personGroupId/training", "host": [ "{{baseUrl}}" ], "path": [ "persongroups", ":personGroupId", "training" ], "variable": [ { "key": "personGroupId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-960d13f6-f18f-4ac1-8eb5-d377294f1ee0" } ], "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-4b2faf20-3605-4542-bdb6-be03712378cd" } ], "id": "d1ba29b4-e9de-4e1f-b92a-4872964db316", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-d1ba29b4-e9de-4e1f-b92a-4872964db316" }, { "name": "train", "item": [ { "name": "Microsoft Azure Post Persongroups Persongroupid Train", "id": "40d8d92d-1bd2-443c-87d6-3013c074c9de", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/persongroups/:personGroupId/train", "host": [ "{{baseUrl}}" ], "path": [ "persongroups", ":personGroupId", "train" ], "variable": [ { "id": "a4775253-c3be-4ac4-82f5-d8838e0ef4b0", "key": "personGroupId", "value": "p3", "description": "(Required) Id referencing a particular person group." } ] }, "description": "Queue a person group training task, the training task may not be started immediately." }, "response": [ { "id": "81a66e94-7df0-429e-8ab8-5bbc3eabcdfa", "name": "The training task was queued successfully.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/persongroups/:personGroupId/train", "host": [ "{{baseUrl}}" ], "path": [ "persongroups", ":personGroupId", "train" ], "variable": [ { "key": "personGroupId" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-81a66e94-7df0-429e-8ab8-5bbc3eabcdfa" }, { "id": "e179a0ab-4253-4937-95af-19ae731885d6", "name": "Error response.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/persongroups/:personGroupId/train", "host": [ "{{baseUrl}}" ], "path": [ "persongroups", ":personGroupId", "train" ], "variable": [ { "key": "personGroupId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-e179a0ab-4253-4937-95af-19ae731885d6" } ], "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-40d8d92d-1bd2-443c-87d6-3013c074c9de" } ], "id": "f12f0739-66d2-43bc-8ec3-480c3ef44b6a", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-f12f0739-66d2-43bc-8ec3-480c3ef44b6a" }, { "name": "Microsoft Azure Put Persongroups Persongroupid", "id": "cfc399fc-94af-4c7c-9023-cacae311263d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"recognitionModel\": {},\n \"userData\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/persongroups/:personGroupId", "host": [ "{{baseUrl}}" ], "path": [ "persongroups", ":personGroupId" ], "variable": [ { "id": "350c53a2-7c34-46e6-b566-9e09c325ad9d", "key": "personGroupId", "value": "p3", "description": "(Required) Id referencing a particular person group." } ] }, "description": "Create a new person group with specified personGroupId, name, user-provided userData and recognitionModel.
A person group is the container of the uploaded person data, including face recognition features.
After creation, use [PersonGroup Person - Create](https://docs.microsoft.com/rest/api/faceapi/persongroupperson/create) to add persons into the group, and then call [PersonGroup - Train](https://docs.microsoft.com/rest/api/faceapi/persongroup/train) to get this group ready for [Face - Identify](https://docs.microsoft.com/rest/api/faceapi/face/identify).
No image will be stored. Only the person's extracted face features and userData will be stored on server until [PersonGroup Person - Delete](https://docs.microsoft.com/rest/api/faceapi/persongroupperson/delete) or [PersonGroup - Delete](https://docs.microsoft.com/rest/api/faceapi/persongroup/delete) is called.
'recognitionModel' should be specified to associate with this person group. The default value for 'recognitionModel' is 'recognition_01', if the latest model needed, please explicitly specify the model you need in this parameter. New faces that are added to an existing person group will use the recognition model that's already associated with the collection. Existing face features in a person group can't be updated to features extracted by another version of recognition model.

Person group quota:
* Free-tier subscription quota: 1,000 person groups. Each holds up to 1,000 persons.
* S0-tier subscription quota: 1,000,000 person groups. Each holds up to 10,000 persons.
* to handle larger scale face identification problem, please consider using [LargePersonGroup](https://docs.microsoft.com/rest/api/faceapi/largepersongroup)." }, "response": [ { "id": "dfbf3281-8682-4552-b6f1-7dd34b154cfc", "name": "A successful call returns an empty response body.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"recognitionModel\": {},\n \"userData\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/persongroups/:personGroupId", "host": [ "{{baseUrl}}" ], "path": [ "persongroups", ":personGroupId" ], "variable": [ { "key": "personGroupId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-dfbf3281-8682-4552-b6f1-7dd34b154cfc" }, { "id": "d947041b-0522-4901-8b11-5ab94f6b414b", "name": "Error response.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"recognitionModel\": {},\n \"userData\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/persongroups/:personGroupId", "host": [ "{{baseUrl}}" ], "path": [ "persongroups", ":personGroupId" ], "variable": [ { "key": "personGroupId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-d947041b-0522-4901-8b11-5ab94f6b414b" } ], "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-cfc399fc-94af-4c7c-9023-cacae311263d" }, { "name": "Microsoft Azure Delete Persongroups Persongroupid", "id": "5267bfc4-f516-4804-8370-e613b61617dd", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/persongroups/:personGroupId", "host": [ "{{baseUrl}}" ], "path": [ "persongroups", ":personGroupId" ], "variable": [ { "id": "bde81327-d444-4566-983a-d3c8a6c143a7", "key": "personGroupId", "value": "p3", "description": "(Required) Id referencing a particular person group." } ] }, "description": "Delete an existing person group. Persisted face features of all people in the person group will also be deleted." }, "response": [ { "id": "bb71cf19-b4ae-4c8f-bc57-da0d9c28d27e", "name": "A successful call returns an empty response body.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/persongroups/:personGroupId", "host": [ "{{baseUrl}}" ], "path": [ "persongroups", ":personGroupId" ], "variable": [ { "key": "personGroupId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-bb71cf19-b4ae-4c8f-bc57-da0d9c28d27e" }, { "id": "31f25d7e-a5af-41f3-a68c-487d3e2cc96a", "name": "Error response.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/persongroups/:personGroupId", "host": [ "{{baseUrl}}" ], "path": [ "persongroups", ":personGroupId" ], "variable": [ { "key": "personGroupId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-31f25d7e-a5af-41f3-a68c-487d3e2cc96a" } ], "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-5267bfc4-f516-4804-8370-e613b61617dd" }, { "name": "Microsoft Azure Get Persongroups Persongroupid", "id": "625f053f-eb53-4d5e-8872-d60d072747d8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/persongroups/:personGroupId?returnRecognitionModel=false", "host": [ "{{baseUrl}}" ], "path": [ "persongroups", ":personGroupId" ], "query": [ { "description": "A value indicating whether the operation should return 'recognitionModel' in response.", "key": "returnRecognitionModel", "value": "false" } ], "variable": [ { "id": "072d4a1f-4bb2-43b6-9cac-499bfc94c89f", "key": "personGroupId", "value": "p3", "description": "(Required) Id referencing a particular person group." } ] }, "description": "Retrieve person group name, userData and recognitionModel. To get person information under this personGroup, use [PersonGroup Person - List](https://docs.microsoft.com/rest/api/faceapi/persongroupperson/list)." }, "response": [ { "id": "2e3fdc2b-0d17-4f93-bc38-5acff9ea0401", "name": "A successful call returns the person group's information.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/persongroups/:personGroupId?returnRecognitionModel=false", "host": [ "{{baseUrl}}" ], "path": [ "persongroups", ":personGroupId" ], "query": [ { "description": "A value indicating whether the operation should return 'recognitionModel' in response.", "key": "returnRecognitionModel", "value": "false" } ], "variable": [ { "key": "personGroupId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"personGroupId\": \"s4me4\",\n \"name\": \"\",\n \"userData\": \"\",\n \"recognitionModel\": \"recognition_01\"\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-2e3fdc2b-0d17-4f93-bc38-5acff9ea0401" }, { "id": "ae91544c-38e1-46fc-8abb-7f1e17a6644a", "name": "Error response.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/persongroups/:personGroupId?returnRecognitionModel=false", "host": [ "{{baseUrl}}" ], "path": [ "persongroups", ":personGroupId" ], "query": [ { "description": "A value indicating whether the operation should return 'recognitionModel' in response.", "key": "returnRecognitionModel", "value": "false" } ], "variable": [ { "key": "personGroupId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-ae91544c-38e1-46fc-8abb-7f1e17a6644a" } ], "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-625f053f-eb53-4d5e-8872-d60d072747d8" }, { "name": "Microsoft Azure Patch Persongroups Persongroupid", "id": "e29bb8e1-659c-41fe-b242-ab15f6f03f4d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"userData\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/persongroups/:personGroupId", "host": [ "{{baseUrl}}" ], "path": [ "persongroups", ":personGroupId" ], "variable": [ { "id": "8eff333b-f6d1-45b8-8aea-b1817b4dd2a4", "key": "personGroupId", "value": "p3", "description": "(Required) Id referencing a particular person group." } ] }, "description": "Update an existing person group's display name and userData. The properties which does not appear in request body will not be updated." }, "response": [ { "id": "bb8113ca-ffb6-426f-8e6c-917951d2be0a", "name": "A successful call returns an empty response body.", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"userData\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/persongroups/:personGroupId", "host": [ "{{baseUrl}}" ], "path": [ "persongroups", ":personGroupId" ], "variable": [ { "key": "personGroupId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-bb8113ca-ffb6-426f-8e6c-917951d2be0a" }, { "id": "78798125-dd5f-4d7b-ab89-537e1704e9b1", "name": "Error response.", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"userData\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/persongroups/:personGroupId", "host": [ "{{baseUrl}}" ], "path": [ "persongroups", ":personGroupId" ], "variable": [ { "key": "personGroupId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-78798125-dd5f-4d7b-ab89-537e1704e9b1" } ], "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-e29bb8e1-659c-41fe-b242-ab15f6f03f4d" } ], "id": "23e63010-c976-4cec-a3e3-05ca3ee49937", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-23e63010-c976-4cec-a3e3-05ca3ee49937" }, { "name": "Microsoft Azure Get Persongroups", "id": "1d37c6ba-515e-4d49-b8d1-1579bad91340", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/persongroups?start=&top=1000&returnRecognitionModel=false", "host": [ "{{baseUrl}}" ], "path": [ "persongroups" ], "query": [ { "description": "List person groups from the least personGroupId greater than the \"start\".", "key": "start", "value": "" }, { "description": "The number of person groups to list.", "key": "top", "value": "1000" }, { "description": "A value indicating whether the operation should return 'recognitionModel' in response.", "key": "returnRecognitionModel", "value": "false" } ] }, "description": "List person groups\u2019 personGroupId, name, userData and recognitionModel.
* Person groups are stored in alphabetical order of personGroupId.
* \"start\" parameter (string, optional) is a user-provided personGroupId value that returned entries have larger ids by string comparison. \"start\" set to empty to indicate return from the first item.
* \"top\" parameter (int, optional) specifies the number of entries to return. A maximal of 1000 entries can be returned in one call. To fetch more, you can specify \"start\" with the last returned entry\u2019s Id of the current call.

For example, total 5 person groups: \"group1\", ..., \"group5\".
\"start=&top=\" will return all 5 groups.
\"start=&top=2\" will return \"group1\", \"group2\".
\"start=group2&top=3\" will return \"group3\", \"group4\", \"group5\".
" }, "response": [ { "id": "8f08667b-03a1-49a4-8db9-26a35222f911", "name": "A successful call returns an array of person groups and their information.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/persongroups?start=&top=1000&returnRecognitionModel=false", "host": [ "{{baseUrl}}" ], "path": [ "persongroups" ], "query": [ { "description": "List person groups from the least personGroupId greater than the \"start\".", "key": "start", "value": "" }, { "description": "The number of person groups to list.", "key": "top", "value": "1000" }, { "description": "A value indicating whether the operation should return 'recognitionModel' in response.", "key": "returnRecognitionModel", "value": "false" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"personGroupId\": \"2x6-j\",\n \"name\": \"\",\n \"userData\": \"\",\n \"recognitionModel\": \"recognition_01\"\n },\n {\n \"personGroupId\": \"ylqap46w6l\",\n \"name\": \"\",\n \"userData\": \"\",\n \"recognitionModel\": \"recognition_01\"\n }\n]", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-8f08667b-03a1-49a4-8db9-26a35222f911" }, { "id": "54b33e28-c28d-46c3-bd3f-bcdad2227e71", "name": "Error response.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/persongroups?start=&top=1000&returnRecognitionModel=false", "host": [ "{{baseUrl}}" ], "path": [ "persongroups" ], "query": [ { "description": "List person groups from the least personGroupId greater than the \"start\".", "key": "start", "value": "" }, { "description": "The number of person groups to list.", "key": "top", "value": "1000" }, { "description": "A value indicating whether the operation should return 'recognitionModel' in response.", "key": "returnRecognitionModel", "value": "false" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-54b33e28-c28d-46c3-bd3f-bcdad2227e71" } ], "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-1d37c6ba-515e-4d49-b8d1-1579bad91340" } ], "id": "80a537ab-755b-4130-8849-b4b19993869f", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-80a537ab-755b-4130-8849-b4b19993869f" }, { "name": "facelists", "item": [ { "name": "{faceListId}", "item": [ { "name": "persistedfaces", "item": [ { "name": "{persistedFaceId}", "item": [ { "name": "Microsoft Azure Delete Facelists Facelistid Persistedfaces Persistedfaceid", "id": "e1710266-b4d5-4457-82f0-5d87a077858c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/facelists/:faceListId/persistedfaces/:persistedFaceId", "host": [ "{{baseUrl}}" ], "path": [ "facelists", ":faceListId", "persistedfaces", ":persistedFaceId" ], "variable": [ { "id": "20cec12c-3d88-451b-a8aa-1e501885e904", "key": "faceListId", "value": "p3", "description": "(Required) Id referencing a particular face list." }, { "id": "fc24cc62-bcf7-4bde-9231-a3fa76d85fe0", "key": "persistedFaceId", "value": "", "description": "(Required) Id referencing a particular persistedFaceId of an existing face." } ] }, "description": "Delete a face from a face list by specified faceListId and persistedFaceId.
Adding/deleting faces to/from a same face list are processed sequentially and to/from different face lists are in parallel." }, "response": [ { "id": "fb9c4b50-5adc-4499-a9b6-e1df92944d2d", "name": "A successful call returns an empty response body.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/facelists/:faceListId/persistedfaces/:persistedFaceId", "host": [ "{{baseUrl}}" ], "path": [ "facelists", ":faceListId", "persistedfaces", ":persistedFaceId" ], "variable": [ { "key": "faceListId" }, { "key": "persistedFaceId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-fb9c4b50-5adc-4499-a9b6-e1df92944d2d" }, { "id": "ab53c08f-7332-4615-9ec4-c8771cfaa741", "name": "Error response.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/facelists/:faceListId/persistedfaces/:persistedFaceId", "host": [ "{{baseUrl}}" ], "path": [ "facelists", ":faceListId", "persistedfaces", ":persistedFaceId" ], "variable": [ { "key": "faceListId" }, { "key": "persistedFaceId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-ab53c08f-7332-4615-9ec4-c8771cfaa741" } ], "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-e1710266-b4d5-4457-82f0-5d87a077858c" } ], "id": "e8b1019d-16a5-4ef0-b071-a98d1511195c", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-e8b1019d-16a5-4ef0-b071-a98d1511195c" }, { "name": "Microsoft Azure Post Facelists Facelistid Persistedfaces", "id": "cf6e2e1e-d442-4ed7-af49-75ad4caf7e97", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/facelists/:faceListId/persistedfaces?userData=&targetFace=,&detectionModel=detection_01", "host": [ "{{baseUrl}}" ], "path": [ "facelists", ":faceListId", "persistedfaces" ], "query": [ { "description": "User-specified data about the face for any purpose. The maximum length is 1KB.", "key": "userData", "value": "" }, { "description": "A face rectangle to specify the target face to be added to a person in the format of \"targetFace=left,top,width,height\". E.g. \"targetFace=10,10,100,100\". If there is more than one face in the image, targetFace is required to specify which face to add. No targetFace means there is only one face detected in the entire image.", "key": "targetFace", "value": "," }, { "description": "Name of detection model. Detection model is used to detect faces in the submitted image. A detection model name can be provided when performing Face - Detect or (Large)FaceList - Add Face or (Large)PersonGroup - Add Face. The default value is 'detection_01', if another model is needed, please explicitly specify it.", "key": "detectionModel", "value": "detection_01" } ], "variable": [ { "id": "221bdc32-983d-4108-9217-00a056e85bd7", "key": "faceListId", "value": "p3", "description": "(Required) Id referencing a particular face list." } ] }, "description": "Add a face to a specified face list, up to 1,000 faces.
To deal with an image contains multiple faces, input face can be specified as an image with a targetFace rectangle. It returns a persistedFaceId representing the added face. No image will be stored. Only the extracted face feature will be stored on server until [FaceList - Delete Face](https://docs.microsoft.com/rest/api/faceapi/facelist/deleteface) or [FaceList - Delete](https://docs.microsoft.com/rest/api/faceapi/facelist/delete) is called.
Note persistedFaceId is different from faceId generated by [Face - Detect](https://docs.microsoft.com/rest/api/faceapi/face/detectwithurl).
* Higher face image quality means better detection and recognition precision. Please consider high-quality faces: frontal, clear, and face size is 200x200 pixels (100 pixels between eyes) or bigger.
* JPEG, PNG, GIF (the first frame), and BMP format are supported. The allowed image file size is from 1KB to 6MB.
* \"targetFace\" rectangle should contain one face. Zero or multiple faces will be regarded as an error. If the provided \"targetFace\" rectangle is not returned from [Face - Detect](https://docs.microsoft.com/rest/api/faceapi/face/detectwithurl), there\u2019s no guarantee to detect and add the face successfully.
* Out of detectable face size (36x36 - 4096x4096 pixels), large head-pose, or large occlusions will cause failures.
* Adding/deleting faces to/from a same face list are processed sequentially and to/from different face lists are in parallel.
* The minimum detectable face size is 36x36 pixels in an image no larger than 1920x1080 pixels. Images with dimensions higher than 1920x1080 pixels will need a proportionally larger minimum face size.
* Different 'detectionModel' values can be provided. To use and compare different detection models, please refer to [How to specify a detection model](https://docs.microsoft.com/azure/cognitive-services/face/face-api-how-to-topics/specify-detection-model)." }, "response": [ { "id": "613b66c1-6df5-4a0d-bdb1-066f5ba25fe2", "name": "A successful call returns a new persistedFaceId.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/facelists/:faceListId/persistedfaces?userData=&targetFace=,&detectionModel=detection_01", "host": [ "{{baseUrl}}" ], "path": [ "facelists", ":faceListId", "persistedfaces" ], "query": [ { "description": "User-specified data about the face for any purpose. The maximum length is 1KB.", "key": "userData", "value": "" }, { "description": "A face rectangle to specify the target face to be added to a person in the format of \"targetFace=left,top,width,height\". E.g. \"targetFace=10,10,100,100\". If there is more than one face in the image, targetFace is required to specify which face to add. No targetFace means there is only one face detected in the entire image.", "key": "targetFace", "value": "," }, { "description": "Name of detection model. Detection model is used to detect faces in the submitted image. A detection model name can be provided when performing Face - Detect or (Large)FaceList - Add Face or (Large)PersonGroup - Add Face. The default value is 'detection_01', if another model is needed, please explicitly specify it.", "key": "detectionModel", "value": "detection_01" } ], "variable": [ { "key": "faceListId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"persistedFaceId\": \"\",\n \"userData\": \"\"\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-613b66c1-6df5-4a0d-bdb1-066f5ba25fe2" }, { "id": "826af542-862e-4269-875b-94b5af71a487", "name": "Error response.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/facelists/:faceListId/persistedfaces?userData=&targetFace=,&detectionModel=detection_01", "host": [ "{{baseUrl}}" ], "path": [ "facelists", ":faceListId", "persistedfaces" ], "query": [ { "description": "User-specified data about the face for any purpose. The maximum length is 1KB.", "key": "userData", "value": "" }, { "description": "A face rectangle to specify the target face to be added to a person in the format of \"targetFace=left,top,width,height\". E.g. \"targetFace=10,10,100,100\". If there is more than one face in the image, targetFace is required to specify which face to add. No targetFace means there is only one face detected in the entire image.", "key": "targetFace", "value": "," }, { "description": "Name of detection model. Detection model is used to detect faces in the submitted image. A detection model name can be provided when performing Face - Detect or (Large)FaceList - Add Face or (Large)PersonGroup - Add Face. The default value is 'detection_01', if another model is needed, please explicitly specify it.", "key": "detectionModel", "value": "detection_01" } ], "variable": [ { "key": "faceListId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-826af542-862e-4269-875b-94b5af71a487" } ], "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-cf6e2e1e-d442-4ed7-af49-75ad4caf7e97" } ], "id": "b44fce72-2ba1-4773-842a-ef9ad7b05559", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-b44fce72-2ba1-4773-842a-ef9ad7b05559" }, { "name": "Microsoft Azure Put Facelists Facelistid", "id": "7020af63-60be-4912-a579-e98dffb25abc", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"recognitionModel\": {},\n \"userData\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/facelists/:faceListId", "host": [ "{{baseUrl}}" ], "path": [ "facelists", ":faceListId" ], "variable": [ { "id": "09dd9f33-8bad-4bc8-ac22-aeb4a6a55fa0", "key": "faceListId", "value": "p3", "description": "(Required) Id referencing a particular face list." } ] }, "description": "Create an empty face list with user-specified faceListId, name, an optional userData and recognitionModel. Up to 64 face lists are allowed in one subscription.
Face list is a list of faces, up to 1,000 faces, and used by [Face - Find Similar](https://docs.microsoft.com/rest/api/faceapi/face/findsimilar).
After creation, user should use [FaceList - Add Face](https://docs.microsoft.com/rest/api/faceapi/facelist/addfacefromurl) to import the faces. No image will be stored. Only the extracted face features are stored on server until [FaceList - Delete](https://docs.microsoft.com/rest/api/faceapi/facelist/delete) is called.
Find Similar is used for scenario like finding celebrity-like faces, similar face filtering, or as a light way face identification. But if the actual use is to identify person, please use [PersonGroup](https://docs.microsoft.com/rest/api/faceapi/persongroup) / [LargePersonGroup](https://docs.microsoft.com/rest/api/faceapi/largepersongroup) and [Face - Identify](https://docs.microsoft.com/rest/api/faceapi/face/identify).
Please consider [LargeFaceList](https://docs.microsoft.com/rest/api/faceapi/largefacelist) when the face number is large. It can support up to 1,000,000 faces.
'recognitionModel' should be specified to associate with this face list. The default value for 'recognitionModel' is 'recognition_01', if the latest model needed, please explicitly specify the model you need in this parameter. New faces that are added to an existing face list will use the recognition model that's already associated with the collection. Existing face features in a face list can't be updated to features extracted by another version of recognition model.
Please Refer to [Specify a face recognition model](https://docs.microsoft.com/azure/cognitive-services/face/face-api-how-to-topics/specify-recognition-model)." }, "response": [ { "id": "d3d1d8d3-8636-414e-85ff-ea7ece0e08a9", "name": "A successful call returns an empty response body.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"recognitionModel\": {},\n \"userData\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/facelists/:faceListId", "host": [ "{{baseUrl}}" ], "path": [ "facelists", ":faceListId" ], "variable": [ { "key": "faceListId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-d3d1d8d3-8636-414e-85ff-ea7ece0e08a9" }, { "id": "7c985e25-028b-4f9d-84e0-c5fbbaedf771", "name": "Error response.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"recognitionModel\": {},\n \"userData\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/facelists/:faceListId", "host": [ "{{baseUrl}}" ], "path": [ "facelists", ":faceListId" ], "variable": [ { "key": "faceListId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-7c985e25-028b-4f9d-84e0-c5fbbaedf771" } ], "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-7020af63-60be-4912-a579-e98dffb25abc" }, { "name": "Microsoft Azure Get Facelists Facelistid", "id": "80b1e066-ea50-48ce-8d23-cb856822c92d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/facelists/:faceListId?returnRecognitionModel=false", "host": [ "{{baseUrl}}" ], "path": [ "facelists", ":faceListId" ], "query": [ { "description": "A value indicating whether the operation should return 'recognitionModel' in response.", "key": "returnRecognitionModel", "value": "false" } ], "variable": [ { "id": "f8a09f99-e4b6-4579-9f0d-3f886e6c375c", "key": "faceListId", "value": "p3", "description": "(Required) Id referencing a particular face list." } ] }, "description": "Retrieve a face list\u2019s faceListId, name, userData, recognitionModel and faces in the face list.
" }, "response": [ { "id": "3341fe00-9499-436e-a8cc-631cfb02630c", "name": "A successful call returns the face list's information.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/facelists/:faceListId?returnRecognitionModel=false", "host": [ "{{baseUrl}}" ], "path": [ "facelists", ":faceListId" ], "query": [ { "description": "A value indicating whether the operation should return 'recognitionModel' in response.", "key": "returnRecognitionModel", "value": "false" } ], "variable": [ { "key": "faceListId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"faceListId\": \"fh\",\n \"name\": \"\",\n \"userData\": \"\",\n \"recognitionModel\": \"recognition_01\",\n \"persistedFaces\": [\n {\n \"persistedFaceId\": \"\",\n \"userData\": \"\"\n },\n {\n \"persistedFaceId\": \"\",\n \"userData\": \"\"\n }\n ]\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-3341fe00-9499-436e-a8cc-631cfb02630c" }, { "id": "71973f13-6ed2-446e-b642-544a140e56fb", "name": "Error response.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/facelists/:faceListId?returnRecognitionModel=false", "host": [ "{{baseUrl}}" ], "path": [ "facelists", ":faceListId" ], "query": [ { "description": "A value indicating whether the operation should return 'recognitionModel' in response.", "key": "returnRecognitionModel", "value": "false" } ], "variable": [ { "key": "faceListId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-71973f13-6ed2-446e-b642-544a140e56fb" } ], "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-80b1e066-ea50-48ce-8d23-cb856822c92d" }, { "name": "Microsoft Azure Patch Facelists Facelistid", "id": "47d2ce4c-bd6a-4f85-8f83-cd98bda8b5e1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"userData\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/facelists/:faceListId", "host": [ "{{baseUrl}}" ], "path": [ "facelists", ":faceListId" ], "variable": [ { "id": "238e0c31-05fd-42df-ba3f-a1ac9fd71d7b", "key": "faceListId", "value": "p3", "description": "(Required) Id referencing a particular face list." } ] }, "description": "Update information of a face list." }, "response": [ { "id": "0a1dc821-7789-48ca-a508-01b4511074bc", "name": "A successful call returns an empty response body.", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"userData\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/facelists/:faceListId", "host": [ "{{baseUrl}}" ], "path": [ "facelists", ":faceListId" ], "variable": [ { "key": "faceListId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-0a1dc821-7789-48ca-a508-01b4511074bc" }, { "id": "d16f83ae-e8c7-42d5-a5ee-97698a222bc6", "name": "Error response.", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"userData\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/facelists/:faceListId", "host": [ "{{baseUrl}}" ], "path": [ "facelists", ":faceListId" ], "variable": [ { "key": "faceListId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-d16f83ae-e8c7-42d5-a5ee-97698a222bc6" } ], "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-47d2ce4c-bd6a-4f85-8f83-cd98bda8b5e1" }, { "name": "Microsoft Azure Delete Facelists Facelistid", "id": "1eae8dd2-40c1-43c0-a103-e6dcd946269c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/facelists/:faceListId", "host": [ "{{baseUrl}}" ], "path": [ "facelists", ":faceListId" ], "variable": [ { "id": "5d646249-7bba-4560-804a-7ea3f349894c", "key": "faceListId", "value": "p3", "description": "(Required) Id referencing a particular face list." } ] }, "description": "Delete a specified face list." }, "response": [ { "id": "2f975dbe-019e-43c9-bdbd-ddcb05f58b05", "name": "A successful call returns an empty response body.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/facelists/:faceListId", "host": [ "{{baseUrl}}" ], "path": [ "facelists", ":faceListId" ], "variable": [ { "key": "faceListId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-2f975dbe-019e-43c9-bdbd-ddcb05f58b05" }, { "id": "a9da771d-9583-42ae-8ab2-306464a1cb2c", "name": "Error response.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/facelists/:faceListId", "host": [ "{{baseUrl}}" ], "path": [ "facelists", ":faceListId" ], "variable": [ { "key": "faceListId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-a9da771d-9583-42ae-8ab2-306464a1cb2c" } ], "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-1eae8dd2-40c1-43c0-a103-e6dcd946269c" } ], "id": "9702fd4d-ec1e-4a9c-b877-4f5643e852da", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-9702fd4d-ec1e-4a9c-b877-4f5643e852da" }, { "name": "Microsoft Azure Get Facelists", "id": "8fef739e-fe94-49d0-ba92-4218aa1446df", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/facelists?returnRecognitionModel=false", "host": [ "{{baseUrl}}" ], "path": [ "facelists" ], "query": [ { "description": "A value indicating whether the operation should return 'recognitionModel' in response.", "key": "returnRecognitionModel", "value": "false" } ] }, "description": "List face lists\u2019 faceListId, name, userData and recognitionModel.
To get face information inside faceList use [FaceList - Get](https://docs.microsoft.com/rest/api/faceapi/facelist/get)
" }, "response": [ { "id": "df4f2d5c-a5b4-42ad-8b05-dae0dd1e3c9c", "name": "A successful call returns an array of faceList.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/facelists?returnRecognitionModel=false", "host": [ "{{baseUrl}}" ], "path": [ "facelists" ], "query": [ { "description": "A value indicating whether the operation should return 'recognitionModel' in response.", "key": "returnRecognitionModel", "value": "false" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"faceListId\": \"-idz8s1x\",\n \"name\": \"\",\n \"userData\": \"\",\n \"recognitionModel\": \"recognition_01\",\n \"persistedFaces\": [\n {\n \"persistedFaceId\": \"\",\n \"userData\": \"\"\n },\n {\n \"persistedFaceId\": \"\",\n \"userData\": \"\"\n }\n ]\n },\n {\n \"faceListId\": \"4\",\n \"name\": \"\",\n \"userData\": \"\",\n \"recognitionModel\": \"recognition_01\",\n \"persistedFaces\": [\n {\n \"persistedFaceId\": \"\",\n \"userData\": \"\"\n },\n {\n \"persistedFaceId\": \"\",\n \"userData\": \"\"\n }\n ]\n }\n]", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-df4f2d5c-a5b4-42ad-8b05-dae0dd1e3c9c" }, { "id": "83d34bff-df54-4e13-9f54-921d74f6d9f9", "name": "Error response.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/facelists?returnRecognitionModel=false", "host": [ "{{baseUrl}}" ], "path": [ "facelists" ], "query": [ { "description": "A value indicating whether the operation should return 'recognitionModel' in response.", "key": "returnRecognitionModel", "value": "false" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-83d34bff-df54-4e13-9f54-921d74f6d9f9" } ], "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-8fef739e-fe94-49d0-ba92-4218aa1446df" } ], "id": "8d1a67a8-312a-4c6d-9e24-0f4d8868cebc", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-8d1a67a8-312a-4c6d-9e24-0f4d8868cebc" }, { "name": "detect", "item": [ { "name": "Microsoft Azure Post Detect", "id": "87246e4b-cfe6-4b2e-9993-7f0c7868f699", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/detect?returnFaceId=&returnFaceLandmarks=false&returnFaceAttributes=exposure,accessories&recognitionModel=recognition_01&returnRecognitionModel=false&detectionModel=detection_01&faceIdTimeToLive=86400", "host": [ "{{baseUrl}}" ], "path": [ "detect" ], "query": [ { "description": "A value indicating whether the operation should return faceIds of detected faces. Detecting with this value set to true requires additional access approvals at https://aka.ms/facerecognition.", "key": "returnFaceId", "value": "" }, { "description": "A value indicating whether the operation should return landmarks of the detected faces.", "key": "returnFaceLandmarks", "value": "false" }, { "description": "Analyze and return the one or more specified face attributes in the comma-separated string like \"returnFaceAttributes=age,gender\". The available attributes depends on the 'detectionModel' specified. 'detection_01' supports age, gender, headPose, smile, facialHair, glasses, emotion, hair, makeup, occlusion, accessories, blur, exposure, noise, and qualityForRecognition. While 'detection_02' does not support any attributes and 'detection_03' only supports mask and qualityForRecognition. Additionally, qualityForRecognition is only supported when the 'recognitionModel' is specified as 'recognition_03' or 'recognition_04'. Note that each face attribute analysis has additional computational and time cost.", "key": "returnFaceAttributes", "value": "exposure,accessories" }, { "description": "Name of recognition model. Recognition model is used when the face features are extracted and associated with detected faceIds, (Large)FaceList or (Large)PersonGroup. A recognition model name can be provided when performing Face - Detect or (Large)FaceList - Create or (Large)PersonGroup - Create. The default value is 'recognition_01', if latest model needed, please explicitly specify the model you need.", "key": "recognitionModel", "value": "recognition_01" }, { "description": "A value indicating whether the operation should return 'recognitionModel' in response.", "key": "returnRecognitionModel", "value": "false" }, { "description": "Name of detection model. Detection model is used to detect faces in the submitted image. A detection model name can be provided when performing Face - Detect or (Large)FaceList - Add Face or (Large)PersonGroup - Add Face. The default value is 'detection_01', if another model is needed, please explicitly specify it.", "key": "detectionModel", "value": "detection_01" }, { "description": "The number of seconds for the faceId being cached. Supported range from 60 seconds up to 86400 seconds. The default value is 86400 (24 hours).", "key": "faceIdTimeToLive", "value": "86400" } ] }, "description": "Detect human faces in an image, return face rectangles, and optionally with faceIds, landmarks, and attributes.
* No image will be stored. Only the extracted face feature will be stored on server. The faceId is an identifier of the face feature and will be used in [Face - Identify](https://docs.microsoft.com/rest/api/faceapi/face/identify), [Face - Verify](https://docs.microsoft.com/rest/api/faceapi/face/verifyfacetoface), and [Face - Find Similar](https://docs.microsoft.com/rest/api/faceapi/face/findsimilar). The stored face feature(s) will expire and be deleted at the time specified by faceIdTimeToLive after the original detection call.
* Optional parameters include faceId, landmarks, and attributes. Attributes include age, gender, headPose, smile, facialHair, glasses, emotion, hair, makeup, occlusion, accessories, blur, exposure, noise, mask, and qualityForRecognition. Some of the results returned for specific attributes may not be highly accurate.
* JPEG, PNG, GIF (the first frame), and BMP format are supported. The allowed image file size is from 1KB to 6MB.
* Up to 100 faces can be returned for an image. Faces are ranked by face rectangle size from large to small.
* For optimal results when querying [Face - Identify](https://docs.microsoft.com/rest/api/faceapi/face/identify), [Face - Verify](https://docs.microsoft.com/rest/api/faceapi/face/verifyfacetoface), and [Face - Find Similar](https://docs.microsoft.com/rest/api/faceapi/face/findsimilar) ('returnFaceId' is true), please use faces that are: frontal, clear, and with a minimum size of 200x200 pixels (100 pixels between eyes).
* The minimum detectable face size is 36x36 pixels in an image no larger than 1920x1080 pixels. Images with dimensions higher than 1920x1080 pixels will need a proportionally larger minimum face size.
* Different 'detectionModel' values can be provided. To use and compare different detection models, please refer to [How to specify a detection model](https://docs.microsoft.com/azure/cognitive-services/face/face-api-how-to-topics/specify-detection-model).

* Different 'recognitionModel' values are provided. If follow-up operations like Verify, Identify, Find Similar are needed, please specify the recognition model with 'recognitionModel' parameter. The default value for 'recognitionModel' is 'recognition_01', if latest model needed, please explicitly specify the model you need in this parameter. Once specified, the detected faceIds will be associated with the specified recognition model. More details, please refer to [Specify a recognition model](https://docs.microsoft.com/azure/cognitive-services/face/face-api-how-to-topics/specify-recognition-model)." }, "response": [ { "id": "a587be35-d9c6-4a14-bd61-2325a452b173", "name": "A successful call returns an array of face entries ranked by face rectangle size in descending order. An empty response indicates no faces detected.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/detect?returnFaceId=&returnFaceLandmarks=false&returnFaceAttributes=exposure,accessories&recognitionModel=recognition_01&returnRecognitionModel=false&detectionModel=detection_01&faceIdTimeToLive=86400", "host": [ "{{baseUrl}}" ], "path": [ "detect" ], "query": [ { "description": "A value indicating whether the operation should return faceIds of detected faces. Detecting with this value set to true requires additional access approvals at https://aka.ms/facerecognition.", "key": "returnFaceId", "value": "" }, { "description": "A value indicating whether the operation should return landmarks of the detected faces.", "key": "returnFaceLandmarks", "value": "false" }, { "description": "Analyze and return the one or more specified face attributes in the comma-separated string like \"returnFaceAttributes=age,gender\". The available attributes depends on the 'detectionModel' specified. 'detection_01' supports age, gender, headPose, smile, facialHair, glasses, emotion, hair, makeup, occlusion, accessories, blur, exposure, noise, and qualityForRecognition. While 'detection_02' does not support any attributes and 'detection_03' only supports mask and qualityForRecognition. Additionally, qualityForRecognition is only supported when the 'recognitionModel' is specified as 'recognition_03' or 'recognition_04'. Note that each face attribute analysis has additional computational and time cost.", "key": "returnFaceAttributes", "value": "exposure,accessories" }, { "description": "Name of recognition model. Recognition model is used when the face features are extracted and associated with detected faceIds, (Large)FaceList or (Large)PersonGroup. A recognition model name can be provided when performing Face - Detect or (Large)FaceList - Create or (Large)PersonGroup - Create. The default value is 'recognition_01', if latest model needed, please explicitly specify the model you need.", "key": "recognitionModel", "value": "recognition_01" }, { "description": "A value indicating whether the operation should return 'recognitionModel' in response.", "key": "returnRecognitionModel", "value": "false" }, { "description": "Name of detection model. Detection model is used to detect faces in the submitted image. A detection model name can be provided when performing Face - Detect or (Large)FaceList - Add Face or (Large)PersonGroup - Add Face. The default value is 'detection_01', if another model is needed, please explicitly specify it.", "key": "detectionModel", "value": "detection_01" }, { "description": "The number of seconds for the faceId being cached. Supported range from 60 seconds up to 86400 seconds. The default value is 86400 (24 hours).", "key": "faceIdTimeToLive", "value": "86400" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"faceRectangle\": {\n \"width\": \"\",\n \"height\": \"\",\n \"left\": \"\",\n \"top\": \"\"\n },\n \"faceId\": \"\",\n \"recognitionModel\": \"recognition_01\",\n \"faceLandmarks\": {\n \"pupilLeft\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"pupilRight\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"noseTip\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"mouthLeft\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"mouthRight\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"eyebrowLeftOuter\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"eyebrowLeftInner\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"eyeLeftOuter\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"eyeLeftTop\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"eyeLeftBottom\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"eyeLeftInner\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"eyebrowRightInner\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"eyebrowRightOuter\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"eyeRightInner\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"eyeRightTop\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"eyeRightBottom\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"eyeRightOuter\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"noseRootLeft\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"noseRootRight\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"noseLeftAlarTop\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"noseRightAlarTop\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"noseLeftAlarOutTip\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"noseRightAlarOutTip\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"upperLipTop\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"upperLipBottom\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"underLipTop\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"underLipBottom\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n \"faceAttributes\": {\n \"age\": \"\",\n \"gender\": \"male\",\n \"smile\": \"\",\n \"facialHair\": {\n \"moustache\": \"\",\n \"beard\": \"\",\n \"sideburns\": \"\"\n },\n \"glasses\": \"readingGlasses\",\n \"headPose\": {\n \"roll\": \"\",\n \"yaw\": \"\",\n \"pitch\": \"\"\n },\n \"emotion\": {\n \"anger\": \"\",\n \"contempt\": \"\",\n \"disgust\": \"\",\n \"fear\": \"\",\n \"happiness\": \"\",\n \"neutral\": \"\",\n \"sadness\": \"\",\n \"surprise\": \"\"\n },\n \"hair\": {\n \"bald\": \"\",\n \"invisible\": \"\",\n \"hairColor\": [\n {\n \"color\": \"unknown\",\n \"confidence\": \"\"\n },\n {\n \"color\": \"unknown\",\n \"confidence\": \"\"\n }\n ]\n },\n \"makeup\": {\n \"eyeMakeup\": \"\",\n \"lipMakeup\": \"\"\n },\n \"occlusion\": {\n \"foreheadOccluded\": \"\",\n \"eyeOccluded\": \"\",\n \"mouthOccluded\": \"\"\n },\n \"accessories\": [\n {\n \"type\": \"glasses\",\n \"confidence\": \"\"\n },\n {\n \"type\": \"headWear\",\n \"confidence\": \"\"\n }\n ],\n \"blur\": {\n \"blurLevel\": \"Medium\",\n \"value\": \"\"\n },\n \"exposure\": {\n \"exposureLevel\": \"GoodExposure\",\n \"value\": \"\"\n },\n \"noise\": {\n \"noiseLevel\": \"Low\",\n \"value\": \"\"\n },\n \"mask\": {\n \"type\": \"uncertain\",\n \"noseAndMouthCovered\": \"\"\n },\n \"qualityForRecognition\": \"Medium\"\n }\n },\n {\n \"faceRectangle\": {\n \"width\": \"\",\n \"height\": \"\",\n \"left\": \"\",\n \"top\": \"\"\n },\n \"faceId\": \"\",\n \"recognitionModel\": \"recognition_01\",\n \"faceLandmarks\": {\n \"pupilLeft\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"pupilRight\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"noseTip\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"mouthLeft\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"mouthRight\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"eyebrowLeftOuter\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"eyebrowLeftInner\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"eyeLeftOuter\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"eyeLeftTop\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"eyeLeftBottom\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"eyeLeftInner\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"eyebrowRightInner\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"eyebrowRightOuter\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"eyeRightInner\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"eyeRightTop\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"eyeRightBottom\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"eyeRightOuter\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"noseRootLeft\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"noseRootRight\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"noseLeftAlarTop\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"noseRightAlarTop\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"noseLeftAlarOutTip\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"noseRightAlarOutTip\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"upperLipTop\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"upperLipBottom\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"underLipTop\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"underLipBottom\": {\n \"x\": \"\",\n \"y\": \"\"\n }\n },\n \"faceAttributes\": {\n \"age\": \"\",\n \"gender\": \"female\",\n \"smile\": \"\",\n \"facialHair\": {\n \"moustache\": \"\",\n \"beard\": \"\",\n \"sideburns\": \"\"\n },\n \"glasses\": \"sunglasses\",\n \"headPose\": {\n \"roll\": \"\",\n \"yaw\": \"\",\n \"pitch\": \"\"\n },\n \"emotion\": {\n \"anger\": \"\",\n \"contempt\": \"\",\n \"disgust\": \"\",\n \"fear\": \"\",\n \"happiness\": \"\",\n \"neutral\": \"\",\n \"sadness\": \"\",\n \"surprise\": \"\"\n },\n \"hair\": {\n \"bald\": \"\",\n \"invisible\": \"\",\n \"hairColor\": [\n {\n \"color\": \"blond\",\n \"confidence\": \"\"\n },\n {\n \"color\": \"unknown\",\n \"confidence\": \"\"\n }\n ]\n },\n \"makeup\": {\n \"eyeMakeup\": \"\",\n \"lipMakeup\": \"\"\n },\n \"occlusion\": {\n \"foreheadOccluded\": \"\",\n \"eyeOccluded\": \"\",\n \"mouthOccluded\": \"\"\n },\n \"accessories\": [\n {\n \"type\": \"mask\",\n \"confidence\": \"\"\n },\n {\n \"type\": \"mask\",\n \"confidence\": \"\"\n }\n ],\n \"blur\": {\n \"blurLevel\": \"High\",\n \"value\": \"\"\n },\n \"exposure\": {\n \"exposureLevel\": \"UnderExposure\",\n \"value\": \"\"\n },\n \"noise\": {\n \"noiseLevel\": \"Low\",\n \"value\": \"\"\n },\n \"mask\": {\n \"type\": \"faceMask\",\n \"noseAndMouthCovered\": \"\"\n },\n \"qualityForRecognition\": \"Medium\"\n }\n }\n]", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-a587be35-d9c6-4a14-bd61-2325a452b173" }, { "id": "fa3e1363-d246-45ea-9e97-b1f2f6e9ecfe", "name": "Error response.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/detect?returnFaceId=&returnFaceLandmarks=false&returnFaceAttributes=exposure,accessories&recognitionModel=recognition_01&returnRecognitionModel=false&detectionModel=detection_01&faceIdTimeToLive=86400", "host": [ "{{baseUrl}}" ], "path": [ "detect" ], "query": [ { "description": "A value indicating whether the operation should return faceIds of detected faces. Detecting with this value set to true requires additional access approvals at https://aka.ms/facerecognition.", "key": "returnFaceId", "value": "" }, { "description": "A value indicating whether the operation should return landmarks of the detected faces.", "key": "returnFaceLandmarks", "value": "false" }, { "description": "Analyze and return the one or more specified face attributes in the comma-separated string like \"returnFaceAttributes=age,gender\". The available attributes depends on the 'detectionModel' specified. 'detection_01' supports age, gender, headPose, smile, facialHair, glasses, emotion, hair, makeup, occlusion, accessories, blur, exposure, noise, and qualityForRecognition. While 'detection_02' does not support any attributes and 'detection_03' only supports mask and qualityForRecognition. Additionally, qualityForRecognition is only supported when the 'recognitionModel' is specified as 'recognition_03' or 'recognition_04'. Note that each face attribute analysis has additional computational and time cost.", "key": "returnFaceAttributes", "value": "exposure,accessories" }, { "description": "Name of recognition model. Recognition model is used when the face features are extracted and associated with detected faceIds, (Large)FaceList or (Large)PersonGroup. A recognition model name can be provided when performing Face - Detect or (Large)FaceList - Create or (Large)PersonGroup - Create. The default value is 'recognition_01', if latest model needed, please explicitly specify the model you need.", "key": "recognitionModel", "value": "recognition_01" }, { "description": "A value indicating whether the operation should return 'recognitionModel' in response.", "key": "returnRecognitionModel", "value": "false" }, { "description": "Name of detection model. Detection model is used to detect faces in the submitted image. A detection model name can be provided when performing Face - Detect or (Large)FaceList - Add Face or (Large)PersonGroup - Add Face. The default value is 'detection_01', if another model is needed, please explicitly specify it.", "key": "detectionModel", "value": "detection_01" }, { "description": "The number of seconds for the faceId being cached. Supported range from 60 seconds up to 86400 seconds. The default value is 86400 (24 hours).", "key": "faceIdTimeToLive", "value": "86400" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-fa3e1363-d246-45ea-9e97-b1f2f6e9ecfe" } ], "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-87246e4b-cfe6-4b2e-9993-7f0c7868f699" } ], "id": "2e878ffe-7d3a-4fea-a44b-e9e8521473fa", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-2e878ffe-7d3a-4fea-a44b-e9e8521473fa" }, { "name": "largepersongroups", "item": [ { "name": "{largePersonGroupId}", "item": [ { "name": "persons", "item": [ { "name": "{personId}", "item": [ { "name": "persistedfaces", "item": [ { "name": "{persistedFaceId}", "item": [ { "name": "Microsoft Azure Delete Largepersongroups Largepersongroupid Persons Personid Persistedfaces Persistedfaceid", "id": "2966c554-ff03-4151-875b-5ef0eaa14766", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/largepersongroups/:largePersonGroupId/persons/:personId/persistedfaces/:persistedFaceId", "host": [ "{{baseUrl}}" ], "path": [ "largepersongroups", ":largePersonGroupId", "persons", ":personId", "persistedfaces", ":persistedFaceId" ], "variable": [ { "id": "17cbfc52-d36c-423c-9b44-b0e75e59aa22", "key": "largePersonGroupId", "value": "p3", "description": "(Required) Id referencing a particular large person group." }, { "id": "91b32f32-47cc-4ea6-954b-e1872de76a31", "key": "personId", "value": "", "description": "(Required) Id referencing a particular person." }, { "id": "ce818d9b-e3d8-440e-96b3-727faf929f4e", "key": "persistedFaceId", "value": "", "description": "(Required) Id referencing a particular persistedFaceId of an existing face." } ] }, "description": "Delete a face from a person in a large person group by specified largePersonGroupId, personId and persistedFaceId.
Adding/deleting faces to/from a same person will be processed sequentially. Adding/deleting faces to/from different persons are processed in parallel." }, "response": [ { "id": "b5d24489-3a6b-4199-9597-e37e1c768e5d", "name": "A successful call returns an empty response body.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/largepersongroups/:largePersonGroupId/persons/:personId/persistedfaces/:persistedFaceId", "host": [ "{{baseUrl}}" ], "path": [ "largepersongroups", ":largePersonGroupId", "persons", ":personId", "persistedfaces", ":persistedFaceId" ], "variable": [ { "key": "largePersonGroupId" }, { "key": "personId" }, { "key": "persistedFaceId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-b5d24489-3a6b-4199-9597-e37e1c768e5d" }, { "id": "a8a031d1-824c-488e-b084-46faba768ebc", "name": "Error response.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/largepersongroups/:largePersonGroupId/persons/:personId/persistedfaces/:persistedFaceId", "host": [ "{{baseUrl}}" ], "path": [ "largepersongroups", ":largePersonGroupId", "persons", ":personId", "persistedfaces", ":persistedFaceId" ], "variable": [ { "key": "largePersonGroupId" }, { "key": "personId" }, { "key": "persistedFaceId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-a8a031d1-824c-488e-b084-46faba768ebc" } ], "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-2966c554-ff03-4151-875b-5ef0eaa14766" }, { "name": "Microsoft Azure Get Largepersongroups Largepersongroupid Persons Personid Persistedfaces Persistedfaceid", "id": "f66f340e-7c44-4094-89cf-2994a9a1d60b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/largepersongroups/:largePersonGroupId/persons/:personId/persistedfaces/:persistedFaceId", "host": [ "{{baseUrl}}" ], "path": [ "largepersongroups", ":largePersonGroupId", "persons", ":personId", "persistedfaces", ":persistedFaceId" ], "variable": [ { "id": "e97eb69c-8e8b-48c3-887e-35d45537e4d7", "key": "largePersonGroupId", "value": "p3", "description": "(Required) Id referencing a particular large person group." }, { "id": "5c240ba1-f1fa-44a6-a18d-f8c680869470", "key": "personId", "value": "", "description": "(Required) Id referencing a particular person." }, { "id": "99a7af86-0162-42ee-a62c-1bda86723656", "key": "persistedFaceId", "value": "", "description": "(Required) Id referencing a particular persistedFaceId of an existing face." } ] }, "description": "Retrieve information about a persisted face (specified by persistedFaceId, personId and its belonging largePersonGroupId)." }, "response": [ { "id": "606d8afc-8439-4c9b-86e0-cc5ae08dced3", "name": "A successful call returns target persisted face's information (persistedFaceId and userData).", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/largepersongroups/:largePersonGroupId/persons/:personId/persistedfaces/:persistedFaceId", "host": [ "{{baseUrl}}" ], "path": [ "largepersongroups", ":largePersonGroupId", "persons", ":personId", "persistedfaces", ":persistedFaceId" ], "variable": [ { "key": "largePersonGroupId" }, { "key": "personId" }, { "key": "persistedFaceId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"persistedFaceId\": \"\",\n \"userData\": \"\"\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-606d8afc-8439-4c9b-86e0-cc5ae08dced3" }, { "id": "69744cfd-c948-4e59-81f9-125a1ede7896", "name": "Error response.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/largepersongroups/:largePersonGroupId/persons/:personId/persistedfaces/:persistedFaceId", "host": [ "{{baseUrl}}" ], "path": [ "largepersongroups", ":largePersonGroupId", "persons", ":personId", "persistedfaces", ":persistedFaceId" ], "variable": [ { "key": "largePersonGroupId" }, { "key": "personId" }, { "key": "persistedFaceId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-69744cfd-c948-4e59-81f9-125a1ede7896" } ], "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-f66f340e-7c44-4094-89cf-2994a9a1d60b" }, { "name": "Microsoft Azure Patch Largepersongroups Largepersongroupid Persons Personid Persistedfaces Persistedfaceid", "id": "ac9581f8-dc70-4e67-8af6-a82f537423b4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"userData\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/largepersongroups/:largePersonGroupId/persons/:personId/persistedfaces/:persistedFaceId", "host": [ "{{baseUrl}}" ], "path": [ "largepersongroups", ":largePersonGroupId", "persons", ":personId", "persistedfaces", ":persistedFaceId" ], "variable": [ { "id": "e2babf29-5ed6-4753-af1f-e4a34ce52cf9", "key": "largePersonGroupId", "value": "p3", "description": "(Required) Id referencing a particular large person group." }, { "id": "8929fa53-7556-4d15-a631-e3e87c460dcc", "key": "personId", "value": "", "description": "(Required) Id referencing a particular person." }, { "id": "d2a673ea-802d-442f-a1fc-1caf411f02ab", "key": "persistedFaceId", "value": "", "description": "(Required) Id referencing a particular persistedFaceId of an existing face." } ] }, "description": "Update a person persisted face's userData field." }, "response": [ { "id": "98eef2d3-44e2-4a33-8859-bb49c772b6e7", "name": "A successful call returns an empty response body.", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"userData\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/largepersongroups/:largePersonGroupId/persons/:personId/persistedfaces/:persistedFaceId", "host": [ "{{baseUrl}}" ], "path": [ "largepersongroups", ":largePersonGroupId", "persons", ":personId", "persistedfaces", ":persistedFaceId" ], "variable": [ { "key": "largePersonGroupId" }, { "key": "personId" }, { "key": "persistedFaceId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-98eef2d3-44e2-4a33-8859-bb49c772b6e7" }, { "id": "073308f5-8bef-45da-ba26-101a543a5a40", "name": "Error response.", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"userData\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/largepersongroups/:largePersonGroupId/persons/:personId/persistedfaces/:persistedFaceId", "host": [ "{{baseUrl}}" ], "path": [ "largepersongroups", ":largePersonGroupId", "persons", ":personId", "persistedfaces", ":persistedFaceId" ], "variable": [ { "key": "largePersonGroupId" }, { "key": "personId" }, { "key": "persistedFaceId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-073308f5-8bef-45da-ba26-101a543a5a40" } ], "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-ac9581f8-dc70-4e67-8af6-a82f537423b4" } ], "id": "04765316-720f-4fb5-8616-df6cc5618c8b", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-04765316-720f-4fb5-8616-df6cc5618c8b" }, { "name": "Microsoft Azure Post Largepersongroups Largepersongroupid Persons Personid Persistedfaces", "id": "dc22644d-d64f-4ddf-bdfb-b6c35e919224", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/largepersongroups/:largePersonGroupId/persons/:personId/persistedfaces?userData=&targetFace=,&detectionModel=detection_01", "host": [ "{{baseUrl}}" ], "path": [ "largepersongroups", ":largePersonGroupId", "persons", ":personId", "persistedfaces" ], "query": [ { "description": "User-specified data about the face for any purpose. The maximum length is 1KB.", "key": "userData", "value": "" }, { "description": "A face rectangle to specify the target face to be added to a person in the format of \"targetFace=left,top,width,height\". E.g. \"targetFace=10,10,100,100\". If there is more than one face in the image, targetFace is required to specify which face to add. No targetFace means there is only one face detected in the entire image.", "key": "targetFace", "value": "," }, { "description": "Name of detection model. Detection model is used to detect faces in the submitted image. A detection model name can be provided when performing Face - Detect or (Large)FaceList - Add Face or (Large)PersonGroup - Add Face. The default value is 'detection_01', if another model is needed, please explicitly specify it.", "key": "detectionModel", "value": "detection_01" } ], "variable": [ { "id": "78b94e28-99bc-4a54-9074-c4e6612a675f", "key": "largePersonGroupId", "value": "p3", "description": "(Required) Id referencing a particular large person group." }, { "id": "cc838df2-a71f-4f6e-a2d7-959f2683b53f", "key": "personId", "value": "", "description": "(Required) Id referencing a particular person." } ] }, "description": "Add a face to a person into a large person group for face identification or verification. To deal with an image contains multiple faces, input face can be specified as an image with a targetFace rectangle. It returns a persistedFaceId representing the added face. No image will be stored. Only the extracted face feature will be stored on server until [LargePersonGroup PersonFace - Delete](https://docs.microsoft.com/rest/api/faceapi/largepersongroupperson/deleteface), [LargePersonGroup Person - Delete](https://docs.microsoft.com/rest/api/faceapi/largepersongroupperson/delete) or [LargePersonGroup - Delete](https://docs.microsoft.com/rest/api/faceapi/largepersongroup/delete) is called.
Note persistedFaceId is different from faceId generated by [Face - Detect](https://docs.microsoft.com/rest/api/faceapi/face/detectwithurl).
* Higher face image quality means better recognition precision. Please consider high-quality faces: frontal, clear, and face size is 200x200 pixels (100 pixels between eyes) or bigger.
* Each person entry can hold up to 248 faces.
* JPEG, PNG, GIF (the first frame), and BMP format are supported. The allowed image file size is from 1KB to 6MB.
* \"targetFace\" rectangle should contain one face. Zero or multiple faces will be regarded as an error. If the provided \"targetFace\" rectangle is not returned from [Face - Detect](https://docs.microsoft.com/rest/api/faceapi/face/detectwithurl), there\u2019s no guarantee to detect and add the face successfully.
* Out of detectable face size (36x36 - 4096x4096 pixels), large head-pose, or large occlusions will cause failures.
* Adding/deleting faces to/from a same person will be processed sequentially. Adding/deleting faces to/from different persons are processed in parallel.
* The minimum detectable face size is 36x36 pixels in an image no larger than 1920x1080 pixels. Images with dimensions higher than 1920x1080 pixels will need a proportionally larger minimum face size.
* Different 'detectionModel' values can be provided. To use and compare different detection models, please refer to [How to specify a detection model](https://docs.microsoft.com/azure/cognitive-services/face/face-api-how-to-topics/specify-detection-model)" }, "response": [ { "id": "d0793e36-1f8b-439e-b5b3-2d70ac738761", "name": "A successful call returns the new persistedFaceId.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/largepersongroups/:largePersonGroupId/persons/:personId/persistedfaces?userData=&targetFace=,&detectionModel=detection_01", "host": [ "{{baseUrl}}" ], "path": [ "largepersongroups", ":largePersonGroupId", "persons", ":personId", "persistedfaces" ], "query": [ { "description": "User-specified data about the face for any purpose. The maximum length is 1KB.", "key": "userData", "value": "" }, { "description": "A face rectangle to specify the target face to be added to a person in the format of \"targetFace=left,top,width,height\". E.g. \"targetFace=10,10,100,100\". If there is more than one face in the image, targetFace is required to specify which face to add. No targetFace means there is only one face detected in the entire image.", "key": "targetFace", "value": "," }, { "description": "Name of detection model. Detection model is used to detect faces in the submitted image. A detection model name can be provided when performing Face - Detect or (Large)FaceList - Add Face or (Large)PersonGroup - Add Face. The default value is 'detection_01', if another model is needed, please explicitly specify it.", "key": "detectionModel", "value": "detection_01" } ], "variable": [ { "key": "largePersonGroupId" }, { "key": "personId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"persistedFaceId\": \"\",\n \"userData\": \"\"\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-d0793e36-1f8b-439e-b5b3-2d70ac738761" }, { "id": "e89ecc2f-ea1d-4991-9013-d3518602ff5e", "name": "Error response.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/largepersongroups/:largePersonGroupId/persons/:personId/persistedfaces?userData=&targetFace=,&detectionModel=detection_01", "host": [ "{{baseUrl}}" ], "path": [ "largepersongroups", ":largePersonGroupId", "persons", ":personId", "persistedfaces" ], "query": [ { "description": "User-specified data about the face for any purpose. The maximum length is 1KB.", "key": "userData", "value": "" }, { "description": "A face rectangle to specify the target face to be added to a person in the format of \"targetFace=left,top,width,height\". E.g. \"targetFace=10,10,100,100\". If there is more than one face in the image, targetFace is required to specify which face to add. No targetFace means there is only one face detected in the entire image.", "key": "targetFace", "value": "," }, { "description": "Name of detection model. Detection model is used to detect faces in the submitted image. A detection model name can be provided when performing Face - Detect or (Large)FaceList - Add Face or (Large)PersonGroup - Add Face. The default value is 'detection_01', if another model is needed, please explicitly specify it.", "key": "detectionModel", "value": "detection_01" } ], "variable": [ { "key": "largePersonGroupId" }, { "key": "personId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-e89ecc2f-ea1d-4991-9013-d3518602ff5e" } ], "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-dc22644d-d64f-4ddf-bdfb-b6c35e919224" } ], "id": "07df5daf-1c34-460f-8d82-5b336f984c9d", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-07df5daf-1c34-460f-8d82-5b336f984c9d" }, { "name": "Microsoft Azure Delete Largepersongroups Largepersongroupid Persons Personid", "id": "4dcffb7d-deed-450f-8bd5-32e7b3a705f5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/largepersongroups/:largePersonGroupId/persons/:personId", "host": [ "{{baseUrl}}" ], "path": [ "largepersongroups", ":largePersonGroupId", "persons", ":personId" ], "variable": [ { "id": "d2f1b227-dcc5-46d4-affe-61621d82667e", "key": "largePersonGroupId", "value": "p3", "description": "(Required) Id referencing a particular large person group." }, { "id": "deea89f7-1fc5-4605-8c82-cd4b5a9ec51f", "key": "personId", "value": "", "description": "(Required) Id referencing a particular person." } ] }, "description": "Delete an existing person from a large person group. The persistedFaceId, userData, person name and face feature in the person entry will all be deleted." }, "response": [ { "id": "0d96476a-4cc8-4043-8d26-0ebff207f804", "name": "A successful call returns an empty response body.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/largepersongroups/:largePersonGroupId/persons/:personId", "host": [ "{{baseUrl}}" ], "path": [ "largepersongroups", ":largePersonGroupId", "persons", ":personId" ], "variable": [ { "key": "largePersonGroupId" }, { "key": "personId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-0d96476a-4cc8-4043-8d26-0ebff207f804" }, { "id": "e3c507b2-6336-42a5-bfca-8d7091444995", "name": "Error response.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/largepersongroups/:largePersonGroupId/persons/:personId", "host": [ "{{baseUrl}}" ], "path": [ "largepersongroups", ":largePersonGroupId", "persons", ":personId" ], "variable": [ { "key": "largePersonGroupId" }, { "key": "personId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-e3c507b2-6336-42a5-bfca-8d7091444995" } ], "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-4dcffb7d-deed-450f-8bd5-32e7b3a705f5" }, { "name": "Microsoft Azure Get Largepersongroups Largepersongroupid Persons Personid", "id": "9d25d23a-fe7f-47f5-9a26-5d0f0bec9fab", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/largepersongroups/:largePersonGroupId/persons/:personId", "host": [ "{{baseUrl}}" ], "path": [ "largepersongroups", ":largePersonGroupId", "persons", ":personId" ], "variable": [ { "id": "64f7c528-11a8-42ef-ba55-f1b6f96fe48b", "key": "largePersonGroupId", "value": "p3", "description": "(Required) Id referencing a particular large person group." }, { "id": "a8daecfd-04bd-4e67-a4ed-bb240d6fe95c", "key": "personId", "value": "", "description": "(Required) Id referencing a particular person." } ] }, "description": "Retrieve a person's name and userData, and the persisted faceIds representing the registered person face feature." }, "response": [ { "id": "b393a20b-1a82-4522-a09b-1bf1dfc854b4", "name": "A successful call returns the person's information.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/largepersongroups/:largePersonGroupId/persons/:personId", "host": [ "{{baseUrl}}" ], "path": [ "largepersongroups", ":largePersonGroupId", "persons", ":personId" ], "variable": [ { "key": "largePersonGroupId" }, { "key": "personId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"personId\": \"urn:uuid:999741a9-b955-d17d-3ee6-e8e4053ecd07\",\n \"persistedFaceIds\": [\n \"ffe92a29-1938-dfa0-f878-1c72e020f27d\",\n \"a0471804-389f-d9d5-959a-6922420cafec\"\n ],\n \"name\": \"\",\n \"userData\": \"\"\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-b393a20b-1a82-4522-a09b-1bf1dfc854b4" }, { "id": "c34a8d38-3d35-4834-b34d-c7357e6b4ecf", "name": "Error response.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/largepersongroups/:largePersonGroupId/persons/:personId", "host": [ "{{baseUrl}}" ], "path": [ "largepersongroups", ":largePersonGroupId", "persons", ":personId" ], "variable": [ { "key": "largePersonGroupId" }, { "key": "personId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-c34a8d38-3d35-4834-b34d-c7357e6b4ecf" } ], "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-9d25d23a-fe7f-47f5-9a26-5d0f0bec9fab" }, { "name": "Microsoft Azure Patch Largepersongroups Largepersongroupid Persons Personid", "id": "4af097b3-5749-47b5-a210-1c1407506b41", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"userData\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/largepersongroups/:largePersonGroupId/persons/:personId", "host": [ "{{baseUrl}}" ], "path": [ "largepersongroups", ":largePersonGroupId", "persons", ":personId" ], "variable": [ { "id": "b37305e8-86b8-4024-848f-5eb685091a85", "key": "largePersonGroupId", "value": "p3", "description": "(Required) Id referencing a particular large person group." }, { "id": "1768dddd-029c-493a-83ac-4c410e5ea95e", "key": "personId", "value": "", "description": "(Required) Id referencing a particular person." } ] }, "description": "Update name or userData of a person." }, "response": [ { "id": "de6a3f01-498f-4cdd-8a3d-d2e224facbe5", "name": "A successful call returns an empty response body.", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"userData\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/largepersongroups/:largePersonGroupId/persons/:personId", "host": [ "{{baseUrl}}" ], "path": [ "largepersongroups", ":largePersonGroupId", "persons", ":personId" ], "variable": [ { "key": "largePersonGroupId" }, { "key": "personId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-de6a3f01-498f-4cdd-8a3d-d2e224facbe5" }, { "id": "0d0e6a0d-df69-4e7c-bea8-77915f170350", "name": "Error response.", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"userData\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/largepersongroups/:largePersonGroupId/persons/:personId", "host": [ "{{baseUrl}}" ], "path": [ "largepersongroups", ":largePersonGroupId", "persons", ":personId" ], "variable": [ { "key": "largePersonGroupId" }, { "key": "personId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-0d0e6a0d-df69-4e7c-bea8-77915f170350" } ], "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-4af097b3-5749-47b5-a210-1c1407506b41" } ], "id": "09945f0a-b625-4b33-8a55-680256002653", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-09945f0a-b625-4b33-8a55-680256002653" }, { "name": "Microsoft Azure Post Largepersongroups Largepersongroupid Persons", "id": "6b91b865-499f-4bb5-8dae-157906cc865b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"userData\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/largepersongroups/:largePersonGroupId/persons", "host": [ "{{baseUrl}}" ], "path": [ "largepersongroups", ":largePersonGroupId", "persons" ], "variable": [ { "id": "56df31b2-cf9e-467b-a967-875feecb7d77", "key": "largePersonGroupId", "value": "p3", "description": "(Required) Id referencing a particular large person group." } ] }, "description": "Create a new person in a specified large person group." }, "response": [ { "id": "0e60d53b-33dc-42df-be80-7430231d1e16", "name": "A successful call returns a new personId created.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"userData\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/largepersongroups/:largePersonGroupId/persons", "host": [ "{{baseUrl}}" ], "path": [ "largepersongroups", ":largePersonGroupId", "persons" ], "variable": [ { "key": "largePersonGroupId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"personId\": \"urn:uuid:999741a9-b955-d17d-3ee6-e8e4053ecd07\",\n \"persistedFaceIds\": [\n \"ffe92a29-1938-dfa0-f878-1c72e020f27d\",\n \"a0471804-389f-d9d5-959a-6922420cafec\"\n ],\n \"name\": \"\",\n \"userData\": \"\"\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-0e60d53b-33dc-42df-be80-7430231d1e16" }, { "id": "1ecf3201-17c0-4c3f-ae36-2b191a51f124", "name": "Error response.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"userData\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/largepersongroups/:largePersonGroupId/persons", "host": [ "{{baseUrl}}" ], "path": [ "largepersongroups", ":largePersonGroupId", "persons" ], "variable": [ { "key": "largePersonGroupId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-1ecf3201-17c0-4c3f-ae36-2b191a51f124" } ], "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-6b91b865-499f-4bb5-8dae-157906cc865b" }, { "name": "Microsoft Azure Get Largepersongroups Largepersongroupid Persons", "id": "10549dcc-53cd-4860-bc21-1a52b9871e32", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/largepersongroups/:largePersonGroupId/persons?start=&top=", "host": [ "{{baseUrl}}" ], "path": [ "largepersongroups", ":largePersonGroupId", "persons" ], "query": [ { "description": "Starting person id to return (used to list a range of persons).", "key": "start", "value": "" }, { "description": "Number of persons to return starting with the person id indicated by the 'start' parameter.", "key": "top", "value": "" } ], "variable": [ { "id": "12dbb764-25b8-4f9d-92bb-1452cd2feb46", "key": "largePersonGroupId", "value": "p3", "description": "(Required) Id referencing a particular large person group." } ] }, "description": "List all persons in a large person group, and retrieve person information (including personId, name, userData and persistedFaceIds of registered faces of the person)." }, "response": [ { "id": "2cff6e07-c36e-4f28-861d-3eb96e65746e", "name": "A successful call returns an array of person information that belong to the large person group.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/largepersongroups/:largePersonGroupId/persons?start=&top=", "host": [ "{{baseUrl}}" ], "path": [ "largepersongroups", ":largePersonGroupId", "persons" ], "query": [ { "description": "Starting person id to return (used to list a range of persons).", "key": "start", "value": "" }, { "description": "Number of persons to return starting with the person id indicated by the 'start' parameter.", "key": "top", "value": "" } ], "variable": [ { "key": "largePersonGroupId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"personId\": \"0f10a304-b0ba-7384-302d-4503896ae1c8\",\n \"persistedFaceIds\": [\n \"urn:uuid:a69b692a-431e-987a-b650-c07abc0d6b48\",\n \"urn:uuid:45132a46-44ab-4592-efcc-8c9a4c6b5d96\"\n ],\n \"name\": \"\",\n \"userData\": \"\"\n },\n {\n \"personId\": \"801f3908-c9bb-b4c4-9ff4-30937c17f7be\",\n \"persistedFaceIds\": [\n \"feeab8eb-9e5a-d50d-34f2-de17ef69a741\",\n \"a51fc096-14fb-e068-270a-2f677913dbd3\"\n ],\n \"name\": \"\",\n \"userData\": \"\"\n }\n]", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-2cff6e07-c36e-4f28-861d-3eb96e65746e" }, { "id": "a8511552-3caa-47a9-a447-a7d61fb829a4", "name": "Error response.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/largepersongroups/:largePersonGroupId/persons?start=&top=", "host": [ "{{baseUrl}}" ], "path": [ "largepersongroups", ":largePersonGroupId", "persons" ], "query": [ { "description": "Starting person id to return (used to list a range of persons).", "key": "start", "value": "" }, { "description": "Number of persons to return starting with the person id indicated by the 'start' parameter.", "key": "top", "value": "" } ], "variable": [ { "key": "largePersonGroupId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-a8511552-3caa-47a9-a447-a7d61fb829a4" } ], "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-10549dcc-53cd-4860-bc21-1a52b9871e32" } ], "id": "1d900023-bc06-42a6-9930-5c011168d13d", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-1d900023-bc06-42a6-9930-5c011168d13d" }, { "name": "training", "item": [ { "name": "Microsoft Azure Get Largepersongroups Largepersongroupid Training", "id": "0d7417ea-21b6-4b49-ae2e-91bc1a2584a8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/largepersongroups/:largePersonGroupId/training", "host": [ "{{baseUrl}}" ], "path": [ "largepersongroups", ":largePersonGroupId", "training" ], "variable": [ { "id": "adce187e-c43d-49db-9098-3d789d860641", "key": "largePersonGroupId", "value": "p3", "description": "(Required) Id referencing a particular large person group." } ] }, "description": "Retrieve the training status of a large person group (completed or ongoing)." }, "response": [ { "id": "37efd1e3-d9ae-4b58-86ad-ec7bed3369e0", "name": "A successful call returns the large person group's training status.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/largepersongroups/:largePersonGroupId/training", "host": [ "{{baseUrl}}" ], "path": [ "largepersongroups", ":largePersonGroupId", "training" ], "variable": [ { "key": "largePersonGroupId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"nonstarted\",\n \"createdDateTime\": \"\",\n \"lastActionDateTime\": \"\",\n \"lastSuccessfulTrainingDateTime\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-37efd1e3-d9ae-4b58-86ad-ec7bed3369e0" }, { "id": "f9aedfec-6d71-43f0-8c39-db385050f235", "name": "Error response.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/largepersongroups/:largePersonGroupId/training", "host": [ "{{baseUrl}}" ], "path": [ "largepersongroups", ":largePersonGroupId", "training" ], "variable": [ { "key": "largePersonGroupId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-f9aedfec-6d71-43f0-8c39-db385050f235" } ], "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-0d7417ea-21b6-4b49-ae2e-91bc1a2584a8" } ], "id": "89fe84bd-c056-45f2-ade1-5b959ae77105", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-89fe84bd-c056-45f2-ade1-5b959ae77105" }, { "name": "train", "item": [ { "name": "Microsoft Azure Post Largepersongroups Largepersongroupid Train", "id": "c91ed032-c5fa-4d27-a038-71b5fa87b51c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/largepersongroups/:largePersonGroupId/train", "host": [ "{{baseUrl}}" ], "path": [ "largepersongroups", ":largePersonGroupId", "train" ], "variable": [ { "id": "4984ef82-99e2-47a0-a8d8-63b6479c44e5", "key": "largePersonGroupId", "value": "p3", "description": "(Required) Id referencing a particular large person group." } ] }, "description": "Queue a large person group training task, the training task may not be started immediately." }, "response": [ { "id": "b188c75c-5da3-4861-a9c6-00e7f8d80ce3", "name": "The training task was queued successfully.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/largepersongroups/:largePersonGroupId/train", "host": [ "{{baseUrl}}" ], "path": [ "largepersongroups", ":largePersonGroupId", "train" ], "variable": [ { "key": "largePersonGroupId" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-b188c75c-5da3-4861-a9c6-00e7f8d80ce3" }, { "id": "2ac765e8-998e-4419-a31e-f159b279934a", "name": "Error response.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/largepersongroups/:largePersonGroupId/train", "host": [ "{{baseUrl}}" ], "path": [ "largepersongroups", ":largePersonGroupId", "train" ], "variable": [ { "key": "largePersonGroupId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-2ac765e8-998e-4419-a31e-f159b279934a" } ], "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-c91ed032-c5fa-4d27-a038-71b5fa87b51c" } ], "id": "f055cc4b-e1f2-4d9e-8b5c-07fd465d8f16", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-f055cc4b-e1f2-4d9e-8b5c-07fd465d8f16" }, { "name": "Microsoft Azure Put Largepersongroups Largepersongroupid", "id": "ff01e103-4065-491b-bfb0-f34b35ff10d5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"recognitionModel\": {},\n \"userData\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/largepersongroups/:largePersonGroupId", "host": [ "{{baseUrl}}" ], "path": [ "largepersongroups", ":largePersonGroupId" ], "variable": [ { "id": "92aedd1e-6050-4148-aa0d-3ce1d8d6ad2b", "key": "largePersonGroupId", "value": "p3", "description": "(Required) Id referencing a particular large person group." } ] }, "description": "Create a new large person group with user-specified largePersonGroupId, name, an optional userData and recognitionModel.
A large person group is the container of the uploaded person data, including face recognition feature, and up to 1,000,000
people.
After creation, use [LargePersonGroup Person - Create](https://docs.microsoft.com/rest/api/faceapi/largepersongroupperson/create) to add person into the group, and call [LargePersonGroup - Train](https://docs.microsoft.com/rest/api/faceapi/largepersongroup/train) to get this group ready for [Face - Identify](https://docs.microsoft.com/rest/api/faceapi/face/identify).
No image will be stored. Only the person's extracted face features and userData will be stored on server until [LargePersonGroup Person - Delete](https://docs.microsoft.com/rest/api/faceapi/largepersongroupperson/delete) or [LargePersonGroup - Delete](https://docs.microsoft.com/rest/api/faceapi/largepersongroup/delete) is called.
'recognitionModel' should be specified to associate with this large person group. The default value for 'recognitionModel' is 'recognition_01', if the latest model needed, please explicitly specify the model you need in this parameter. New faces that are added to an existing large person group will use the recognition model that's already associated with the collection. Existing face features in a large person group can't be updated to features extracted by another version of recognition model. Please refer to [Specify a face recognition model](https://docs.microsoft.com/azure/cognitive-services/face/face-api-how-to-topics/specify-recognition-model).

Large person group quota:
* Free-tier subscription quota: 1,000 large person groups.
* S0-tier subscription quota: 1,000,000 large person groups." }, "response": [ { "id": "b881d681-1bca-42a9-b5ed-1d442742151e", "name": "A successful call returns an empty response body.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"recognitionModel\": {},\n \"userData\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/largepersongroups/:largePersonGroupId", "host": [ "{{baseUrl}}" ], "path": [ "largepersongroups", ":largePersonGroupId" ], "variable": [ { "key": "largePersonGroupId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-b881d681-1bca-42a9-b5ed-1d442742151e" }, { "id": "fed3a440-cc85-4e11-8035-f18421b4591f", "name": "Error response.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"recognitionModel\": {},\n \"userData\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/largepersongroups/:largePersonGroupId", "host": [ "{{baseUrl}}" ], "path": [ "largepersongroups", ":largePersonGroupId" ], "variable": [ { "key": "largePersonGroupId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-fed3a440-cc85-4e11-8035-f18421b4591f" } ], "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-ff01e103-4065-491b-bfb0-f34b35ff10d5" }, { "name": "Microsoft Azure Delete Largepersongroups Largepersongroupid", "id": "a1b165ae-de69-42d1-a855-42122a8cda5b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/largepersongroups/:largePersonGroupId", "host": [ "{{baseUrl}}" ], "path": [ "largepersongroups", ":largePersonGroupId" ], "variable": [ { "id": "20097eeb-a362-483e-b5f0-70da095efc89", "key": "largePersonGroupId", "value": "p3", "description": "(Required) Id referencing a particular large person group." } ] }, "description": "Delete an existing large person group. Persisted face features of all people in the large person group will also be deleted." }, "response": [ { "id": "8c0673da-2c4a-451b-a8a0-db77fba90f00", "name": "A successful call returns an empty response body.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/largepersongroups/:largePersonGroupId", "host": [ "{{baseUrl}}" ], "path": [ "largepersongroups", ":largePersonGroupId" ], "variable": [ { "key": "largePersonGroupId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-8c0673da-2c4a-451b-a8a0-db77fba90f00" }, { "id": "1438c64d-ba9f-4d45-98a0-95e84e9e3e26", "name": "Error response.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/largepersongroups/:largePersonGroupId", "host": [ "{{baseUrl}}" ], "path": [ "largepersongroups", ":largePersonGroupId" ], "variable": [ { "key": "largePersonGroupId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-1438c64d-ba9f-4d45-98a0-95e84e9e3e26" } ], "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-a1b165ae-de69-42d1-a855-42122a8cda5b" }, { "name": "Microsoft Azure Get Largepersongroups Largepersongroupid", "id": "6909e568-6022-46c8-94b4-1159d650dc99", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/largepersongroups/:largePersonGroupId?returnRecognitionModel=false", "host": [ "{{baseUrl}}" ], "path": [ "largepersongroups", ":largePersonGroupId" ], "query": [ { "description": "A value indicating whether the operation should return 'recognitionModel' in response.", "key": "returnRecognitionModel", "value": "false" } ], "variable": [ { "id": "109cd4aa-cbf2-4d7d-9158-7f42e93593d4", "key": "largePersonGroupId", "value": "p3", "description": "(Required) Id referencing a particular large person group." } ] }, "description": "Retrieve the information of a large person group, including its name, userData and recognitionModel. This API returns large person group information only, use [LargePersonGroup Person - List](https://docs.microsoft.com/rest/api/faceapi/largepersongroupperson/list) instead to retrieve person information under the large person group.
" }, "response": [ { "id": "c00a8acc-014c-4410-a506-c3df9c14b04d", "name": "A successful call returns the large person group's information.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/largepersongroups/:largePersonGroupId?returnRecognitionModel=false", "host": [ "{{baseUrl}}" ], "path": [ "largepersongroups", ":largePersonGroupId" ], "query": [ { "description": "A value indicating whether the operation should return 'recognitionModel' in response.", "key": "returnRecognitionModel", "value": "false" } ], "variable": [ { "key": "largePersonGroupId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"largePersonGroupId\": \"i273q5\",\n \"name\": \"\",\n \"userData\": \"\",\n \"recognitionModel\": \"recognition_01\"\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-c00a8acc-014c-4410-a506-c3df9c14b04d" }, { "id": "f56aaf21-747f-4756-9ab9-4f43dd3e48af", "name": "Error response.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/largepersongroups/:largePersonGroupId?returnRecognitionModel=false", "host": [ "{{baseUrl}}" ], "path": [ "largepersongroups", ":largePersonGroupId" ], "query": [ { "description": "A value indicating whether the operation should return 'recognitionModel' in response.", "key": "returnRecognitionModel", "value": "false" } ], "variable": [ { "key": "largePersonGroupId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-f56aaf21-747f-4756-9ab9-4f43dd3e48af" } ], "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-6909e568-6022-46c8-94b4-1159d650dc99" }, { "name": "Microsoft Azure Patch Largepersongroups Largepersongroupid", "id": "9b85d7f4-7a3a-4c9d-870c-690693055625", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"userData\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/largepersongroups/:largePersonGroupId", "host": [ "{{baseUrl}}" ], "path": [ "largepersongroups", ":largePersonGroupId" ], "variable": [ { "id": "4254506b-196b-438c-8034-a8f1133f8065", "key": "largePersonGroupId", "value": "p3", "description": "(Required) Id referencing a particular large person group." } ] }, "description": "Update an existing large person group's display name and userData. The properties which does not appear in request body will not be updated." }, "response": [ { "id": "4b549fbc-d448-481b-9692-aee83d169144", "name": "A successful call returns an empty response body.", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"userData\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/largepersongroups/:largePersonGroupId", "host": [ "{{baseUrl}}" ], "path": [ "largepersongroups", ":largePersonGroupId" ], "variable": [ { "key": "largePersonGroupId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-4b549fbc-d448-481b-9692-aee83d169144" }, { "id": "3d4193ac-d0e3-4708-84a5-9a120689d59f", "name": "Error response.", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"userData\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/largepersongroups/:largePersonGroupId", "host": [ "{{baseUrl}}" ], "path": [ "largepersongroups", ":largePersonGroupId" ], "variable": [ { "key": "largePersonGroupId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-3d4193ac-d0e3-4708-84a5-9a120689d59f" } ], "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-9b85d7f4-7a3a-4c9d-870c-690693055625" } ], "id": "1e5186dc-11d8-4821-8247-c0c71ce74c03", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-1e5186dc-11d8-4821-8247-c0c71ce74c03" }, { "name": "Microsoft Azure Get Largepersongroups", "id": "a1a300f6-5848-4dc1-b660-32d821edf727", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/largepersongroups?start=&top=1000&returnRecognitionModel=false", "host": [ "{{baseUrl}}" ], "path": [ "largepersongroups" ], "query": [ { "description": "List large person groups from the least largePersonGroupId greater than the \"start\".", "key": "start", "value": "" }, { "description": "The number of large person groups to list.", "key": "top", "value": "1000" }, { "description": "A value indicating whether the operation should return 'recognitionModel' in response.", "key": "returnRecognitionModel", "value": "false" } ] }, "description": "List all existing large person groups\u2019 largePersonGroupId, name, userData and recognitionModel.
* Large person groups are stored in alphabetical order of largePersonGroupId.
* \"start\" parameter (string, optional) is a user-provided largePersonGroupId value that returned entries have larger ids by string comparison. \"start\" set to empty to indicate return from the first item.
* \"top\" parameter (int, optional) specifies the number of entries to return. A maximal of 1000 entries can be returned in one call. To fetch more, you can specify \"start\" with the last returned entry\u2019s Id of the current call.

For example, total 5 large person groups: \"group1\", ..., \"group5\".
\"start=&top=\" will return all 5 groups.
\"start=&top=2\" will return \"group1\", \"group2\".
\"start=group2&top=3\" will return \"group3\", \"group4\", \"group5\".
" }, "response": [ { "id": "40d026da-c955-40c1-848d-9ab2d852c422", "name": "A successful call returns an array of large person groups and their information.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/largepersongroups?start=&top=1000&returnRecognitionModel=false", "host": [ "{{baseUrl}}" ], "path": [ "largepersongroups" ], "query": [ { "description": "List large person groups from the least largePersonGroupId greater than the \"start\".", "key": "start", "value": "" }, { "description": "The number of large person groups to list.", "key": "top", "value": "1000" }, { "description": "A value indicating whether the operation should return 'recognitionModel' in response.", "key": "returnRecognitionModel", "value": "false" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"largePersonGroupId\": \"aksp\",\n \"name\": \"\",\n \"userData\": \"\",\n \"recognitionModel\": \"recognition_01\"\n },\n {\n \"largePersonGroupId\": \"7li27flx1\",\n \"name\": \"\",\n \"userData\": \"\",\n \"recognitionModel\": \"recognition_01\"\n }\n]", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-40d026da-c955-40c1-848d-9ab2d852c422" }, { "id": "399a6af3-d47d-474f-9acc-c1e82029e767", "name": "Error response.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/largepersongroups?start=&top=1000&returnRecognitionModel=false", "host": [ "{{baseUrl}}" ], "path": [ "largepersongroups" ], "query": [ { "description": "List large person groups from the least largePersonGroupId greater than the \"start\".", "key": "start", "value": "" }, { "description": "The number of large person groups to list.", "key": "top", "value": "1000" }, { "description": "A value indicating whether the operation should return 'recognitionModel' in response.", "key": "returnRecognitionModel", "value": "false" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-399a6af3-d47d-474f-9acc-c1e82029e767" } ], "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-a1a300f6-5848-4dc1-b660-32d821edf727" } ], "id": "e234674a-1707-4129-afcb-7551f9b9bf58", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-e234674a-1707-4129-afcb-7551f9b9bf58" }, { "name": "largefacelists", "item": [ { "name": "{largeFaceListId}", "item": [ { "name": "training", "item": [ { "name": "Microsoft Azure Get Largefacelists Largefacelistid Training", "id": "9a965618-a12e-48bd-9719-704308c2b14a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/largefacelists/:largeFaceListId/training", "host": [ "{{baseUrl}}" ], "path": [ "largefacelists", ":largeFaceListId", "training" ], "variable": [ { "id": "edcfb7f7-95f1-47d3-9cee-46de7ef01868", "key": "largeFaceListId", "value": "p3", "description": "(Required) Id referencing a particular large face list." } ] }, "description": "Retrieve the training status of a large face list (completed or ongoing)." }, "response": [ { "id": "1824ff4b-b9ea-4600-bc76-82ef432385ba", "name": "A successful call returns the large face list's training status.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/largefacelists/:largeFaceListId/training", "host": [ "{{baseUrl}}" ], "path": [ "largefacelists", ":largeFaceListId", "training" ], "variable": [ { "key": "largeFaceListId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"nonstarted\",\n \"createdDateTime\": \"\",\n \"lastActionDateTime\": \"\",\n \"lastSuccessfulTrainingDateTime\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-1824ff4b-b9ea-4600-bc76-82ef432385ba" }, { "id": "2d5468af-009b-40bf-b9d2-cbb90dcaf01e", "name": "Error response.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/largefacelists/:largeFaceListId/training", "host": [ "{{baseUrl}}" ], "path": [ "largefacelists", ":largeFaceListId", "training" ], "variable": [ { "key": "largeFaceListId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-2d5468af-009b-40bf-b9d2-cbb90dcaf01e" } ], "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-9a965618-a12e-48bd-9719-704308c2b14a" } ], "id": "2839e014-c062-46ba-bfe8-84a9f79f6593", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-2839e014-c062-46ba-bfe8-84a9f79f6593" }, { "name": "train", "item": [ { "name": "Microsoft Azure Post Largefacelists Largefacelistid Train", "id": "3f2db924-914a-4e22-9bf5-7373b1c4d5b3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/largefacelists/:largeFaceListId/train", "host": [ "{{baseUrl}}" ], "path": [ "largefacelists", ":largeFaceListId", "train" ], "variable": [ { "id": "59960fce-d311-4377-a113-7825f6e944be", "key": "largeFaceListId", "value": "p3", "description": "(Required) Id referencing a particular large face list." } ] }, "description": "Queue a large face list training task, the training task may not be started immediately." }, "response": [ { "id": "c2e87ecb-05ac-4050-b6f4-457d3cd9d7db", "name": "The training task was queued successfully.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/largefacelists/:largeFaceListId/train", "host": [ "{{baseUrl}}" ], "path": [ "largefacelists", ":largeFaceListId", "train" ], "variable": [ { "key": "largeFaceListId" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-c2e87ecb-05ac-4050-b6f4-457d3cd9d7db" }, { "id": "e5bc9ea1-85e2-4be8-949e-88a254c0314b", "name": "Error response.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/largefacelists/:largeFaceListId/train", "host": [ "{{baseUrl}}" ], "path": [ "largefacelists", ":largeFaceListId", "train" ], "variable": [ { "key": "largeFaceListId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-e5bc9ea1-85e2-4be8-949e-88a254c0314b" } ], "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-3f2db924-914a-4e22-9bf5-7373b1c4d5b3" } ], "id": "fc6971cc-78d8-4288-bf46-d7bdf30aa154", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-fc6971cc-78d8-4288-bf46-d7bdf30aa154" }, { "name": "persistedfaces", "item": [ { "name": "{persistedFaceId}", "item": [ { "name": "Microsoft Azure Delete Largefacelists Largefacelistid Persistedfaces Persistedfaceid", "id": "ae1085fb-0b96-4ca4-bdb4-20bc3759edf1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/largefacelists/:largeFaceListId/persistedfaces/:persistedFaceId", "host": [ "{{baseUrl}}" ], "path": [ "largefacelists", ":largeFaceListId", "persistedfaces", ":persistedFaceId" ], "variable": [ { "id": "e09a2570-5420-45ac-8f58-8561ef3851b9", "key": "largeFaceListId", "value": "p3", "description": "(Required) Id referencing a particular large face list." }, { "id": "0bda5260-e8b3-40b4-af76-1fc511070ba3", "key": "persistedFaceId", "value": "", "description": "(Required) Id referencing a particular persistedFaceId of an existing face." } ] }, "description": "Delete a face from a large face list by specified largeFaceListId and persistedFaceId.
Adding/deleting faces to/from a same large face list are processed sequentially and to/from different large face lists are in parallel." }, "response": [ { "id": "4532060b-978e-4f89-bb61-0568e6eb6929", "name": "A successful call returns an empty response body.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/largefacelists/:largeFaceListId/persistedfaces/:persistedFaceId", "host": [ "{{baseUrl}}" ], "path": [ "largefacelists", ":largeFaceListId", "persistedfaces", ":persistedFaceId" ], "variable": [ { "key": "largeFaceListId" }, { "key": "persistedFaceId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-4532060b-978e-4f89-bb61-0568e6eb6929" }, { "id": "18d750ea-1625-4d55-b326-a504f8abd348", "name": "Error response.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/largefacelists/:largeFaceListId/persistedfaces/:persistedFaceId", "host": [ "{{baseUrl}}" ], "path": [ "largefacelists", ":largeFaceListId", "persistedfaces", ":persistedFaceId" ], "variable": [ { "key": "largeFaceListId" }, { "key": "persistedFaceId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-18d750ea-1625-4d55-b326-a504f8abd348" } ], "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-ae1085fb-0b96-4ca4-bdb4-20bc3759edf1" }, { "name": "Microsoft Azure Get Largefacelists Largefacelistid Persistedfaces Persistedfaceid", "id": "83f8b2d6-43e4-4127-95b4-a10b61586129", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/largefacelists/:largeFaceListId/persistedfaces/:persistedFaceId", "host": [ "{{baseUrl}}" ], "path": [ "largefacelists", ":largeFaceListId", "persistedfaces", ":persistedFaceId" ], "variable": [ { "id": "82601907-a7ef-4201-9d65-7f039a762a33", "key": "largeFaceListId", "value": "p3", "description": "(Required) Id referencing a particular large face list." }, { "id": "3dae402d-dbe1-4090-a051-88270219875e", "key": "persistedFaceId", "value": "", "description": "(Required) Id referencing a particular persistedFaceId of an existing face." } ] }, "description": "Retrieve information about a persisted face (specified by persistedFaceId and its belonging largeFaceListId)." }, "response": [ { "id": "db4274b0-b2f4-482a-90fa-c6acf031a3ce", "name": "A successful call returns target persisted face's information (persistedFaceId and userData).", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/largefacelists/:largeFaceListId/persistedfaces/:persistedFaceId", "host": [ "{{baseUrl}}" ], "path": [ "largefacelists", ":largeFaceListId", "persistedfaces", ":persistedFaceId" ], "variable": [ { "key": "largeFaceListId" }, { "key": "persistedFaceId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"persistedFaceId\": \"\",\n \"userData\": \"\"\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-db4274b0-b2f4-482a-90fa-c6acf031a3ce" }, { "id": "7ffaef68-cf07-4851-954f-dba691300df4", "name": "Error response.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/largefacelists/:largeFaceListId/persistedfaces/:persistedFaceId", "host": [ "{{baseUrl}}" ], "path": [ "largefacelists", ":largeFaceListId", "persistedfaces", ":persistedFaceId" ], "variable": [ { "key": "largeFaceListId" }, { "key": "persistedFaceId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-7ffaef68-cf07-4851-954f-dba691300df4" } ], "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-83f8b2d6-43e4-4127-95b4-a10b61586129" }, { "name": "Microsoft Azure Patch Largefacelists Largefacelistid Persistedfaces Persistedfaceid", "id": "32f0fd46-4f26-4b42-a82c-7a76ad4eb779", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"userData\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/largefacelists/:largeFaceListId/persistedfaces/:persistedFaceId", "host": [ "{{baseUrl}}" ], "path": [ "largefacelists", ":largeFaceListId", "persistedfaces", ":persistedFaceId" ], "variable": [ { "id": "3c275184-ce44-42c1-9b18-67a282948541", "key": "largeFaceListId", "value": "p3", "description": "(Required) Id referencing a particular large face list." }, { "id": "3a174099-007a-436a-a7e9-2728f8005f36", "key": "persistedFaceId", "value": "", "description": "(Required) Id referencing a particular persistedFaceId of an existing face." } ] }, "description": "Update a persisted face's userData field." }, "response": [ { "id": "495b7f97-43eb-4eae-a7a5-75d18e97fc57", "name": "A successful call returns an empty response body.", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"userData\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/largefacelists/:largeFaceListId/persistedfaces/:persistedFaceId", "host": [ "{{baseUrl}}" ], "path": [ "largefacelists", ":largeFaceListId", "persistedfaces", ":persistedFaceId" ], "variable": [ { "key": "largeFaceListId" }, { "key": "persistedFaceId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-495b7f97-43eb-4eae-a7a5-75d18e97fc57" }, { "id": "fd0cded9-68b2-4658-a9bb-d80e4db9aa98", "name": "Error response.", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"userData\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/largefacelists/:largeFaceListId/persistedfaces/:persistedFaceId", "host": [ "{{baseUrl}}" ], "path": [ "largefacelists", ":largeFaceListId", "persistedfaces", ":persistedFaceId" ], "variable": [ { "key": "largeFaceListId" }, { "key": "persistedFaceId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-fd0cded9-68b2-4658-a9bb-d80e4db9aa98" } ], "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-32f0fd46-4f26-4b42-a82c-7a76ad4eb779" } ], "id": "f6c9bf3b-56e6-48de-af4e-9e6747dadb81", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-f6c9bf3b-56e6-48de-af4e-9e6747dadb81" }, { "name": "Microsoft Azure Post Largefacelists Largefacelistid Persistedfaces", "id": "f5052450-4b64-4fc6-9771-7a761da8f468", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/largefacelists/:largeFaceListId/persistedfaces?userData=&targetFace=,&detectionModel=detection_01", "host": [ "{{baseUrl}}" ], "path": [ "largefacelists", ":largeFaceListId", "persistedfaces" ], "query": [ { "description": "User-specified data about the face for any purpose. The maximum length is 1KB.", "key": "userData", "value": "" }, { "description": "A face rectangle to specify the target face to be added to a person in the format of \"targetFace=left,top,width,height\". E.g. \"targetFace=10,10,100,100\". If there is more than one face in the image, targetFace is required to specify which face to add. No targetFace means there is only one face detected in the entire image.", "key": "targetFace", "value": "," }, { "description": "Name of detection model. Detection model is used to detect faces in the submitted image. A detection model name can be provided when performing Face - Detect or (Large)FaceList - Add Face or (Large)PersonGroup - Add Face. The default value is 'detection_01', if another model is needed, please explicitly specify it.", "key": "detectionModel", "value": "detection_01" } ], "variable": [ { "id": "61d0a919-ab2f-43ce-a730-2aa8f888b0fd", "key": "largeFaceListId", "value": "p3", "description": "(Required) Id referencing a particular large face list." } ] }, "description": "Add a face to a specified large face list, up to 1,000,000 faces.
To deal with an image contains multiple faces, input face can be specified as an image with a targetFace rectangle. It returns a persistedFaceId representing the added face. No image will be stored. Only the extracted face feature will be stored on server until [LargeFaceList Face - Delete](https://docs.microsoft.com/rest/api/faceapi/largefacelist/deleteface) or [LargeFaceList - Delete](https://docs.microsoft.com/rest/api/faceapi/largefacelist/delete) is called.
Note persistedFaceId is different from faceId generated by [Face - Detect](https://docs.microsoft.com/rest/api/faceapi/face/detectwithurl).
* Higher face image quality means better recognition precision. Please consider high-quality faces: frontal, clear, and face size is 200x200 pixels (100 pixels between eyes) or bigger.
* JPEG, PNG, GIF (the first frame), and BMP format are supported. The allowed image file size is from 1KB to 6MB.
* \"targetFace\" rectangle should contain one face. Zero or multiple faces will be regarded as an error. If the provided \"targetFace\" rectangle is not returned from [Face - Detect](https://docs.microsoft.com/rest/api/faceapi/face/detectwithurl), there\u2019s no guarantee to detect and add the face successfully.
* Out of detectable face size (36x36 - 4096x4096 pixels), large head-pose, or large occlusions will cause failures.
* Adding/deleting faces to/from a same face list are processed sequentially and to/from different face lists are in parallel.
* The minimum detectable face size is 36x36 pixels in an image no larger than 1920x1080 pixels. Images with dimensions higher than 1920x1080 pixels will need a proportionally larger minimum face size.
* Different 'detectionModel' values can be provided. To use and compare different detection models, please refer to [How to specify a detection model](https://docs.microsoft.com/azure/cognitive-services/face/face-api-how-to-topics/specify-detection-model)

Quota:
* Free-tier subscription quota: 1,000 faces per large face list.
* S0-tier subscription quota: 1,000,000 faces per large face list." }, "response": [ { "id": "da5d8ea3-6e0f-4723-b944-57a68e632af8", "name": "A successful call returns a new persistedFaceId.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/largefacelists/:largeFaceListId/persistedfaces?userData=&targetFace=,&detectionModel=detection_01", "host": [ "{{baseUrl}}" ], "path": [ "largefacelists", ":largeFaceListId", "persistedfaces" ], "query": [ { "description": "User-specified data about the face for any purpose. The maximum length is 1KB.", "key": "userData", "value": "" }, { "description": "A face rectangle to specify the target face to be added to a person in the format of \"targetFace=left,top,width,height\". E.g. \"targetFace=10,10,100,100\". If there is more than one face in the image, targetFace is required to specify which face to add. No targetFace means there is only one face detected in the entire image.", "key": "targetFace", "value": "," }, { "description": "Name of detection model. Detection model is used to detect faces in the submitted image. A detection model name can be provided when performing Face - Detect or (Large)FaceList - Add Face or (Large)PersonGroup - Add Face. The default value is 'detection_01', if another model is needed, please explicitly specify it.", "key": "detectionModel", "value": "detection_01" } ], "variable": [ { "key": "largeFaceListId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"persistedFaceId\": \"\",\n \"userData\": \"\"\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-da5d8ea3-6e0f-4723-b944-57a68e632af8" }, { "id": "a662a11e-ac42-4633-94fe-98568b008f7e", "name": "Error response.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/largefacelists/:largeFaceListId/persistedfaces?userData=&targetFace=,&detectionModel=detection_01", "host": [ "{{baseUrl}}" ], "path": [ "largefacelists", ":largeFaceListId", "persistedfaces" ], "query": [ { "description": "User-specified data about the face for any purpose. The maximum length is 1KB.", "key": "userData", "value": "" }, { "description": "A face rectangle to specify the target face to be added to a person in the format of \"targetFace=left,top,width,height\". E.g. \"targetFace=10,10,100,100\". If there is more than one face in the image, targetFace is required to specify which face to add. No targetFace means there is only one face detected in the entire image.", "key": "targetFace", "value": "," }, { "description": "Name of detection model. Detection model is used to detect faces in the submitted image. A detection model name can be provided when performing Face - Detect or (Large)FaceList - Add Face or (Large)PersonGroup - Add Face. The default value is 'detection_01', if another model is needed, please explicitly specify it.", "key": "detectionModel", "value": "detection_01" } ], "variable": [ { "key": "largeFaceListId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-a662a11e-ac42-4633-94fe-98568b008f7e" } ], "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-f5052450-4b64-4fc6-9771-7a761da8f468" }, { "name": "Microsoft Azure Get Largefacelists Largefacelistid Persistedfaces", "id": "7b507e87-ec47-46d1-9040-0aa45c46786d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/largefacelists/:largeFaceListId/persistedfaces?start=&top=", "host": [ "{{baseUrl}}" ], "path": [ "largefacelists", ":largeFaceListId", "persistedfaces" ], "query": [ { "description": "Starting face id to return (used to list a range of faces).", "key": "start", "value": "" }, { "description": "Number of faces to return starting with the face id indicated by the 'start' parameter.", "key": "top", "value": "" } ], "variable": [ { "id": "1f8abbe9-b207-449d-b9a6-224927d8a4f6", "key": "largeFaceListId", "value": "p3", "description": "(Required) Id referencing a particular large face list." } ] }, "description": "List all faces in a large face list, and retrieve face information (including userData and persistedFaceIds of registered faces of the face)." }, "response": [ { "id": "91dcc158-7659-44b1-a2ad-3d974245af89", "name": "A successful call returns an array of face information that belong to the large face list.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/largefacelists/:largeFaceListId/persistedfaces?start=&top=", "host": [ "{{baseUrl}}" ], "path": [ "largefacelists", ":largeFaceListId", "persistedfaces" ], "query": [ { "description": "Starting face id to return (used to list a range of faces).", "key": "start", "value": "" }, { "description": "Number of faces to return starting with the face id indicated by the 'start' parameter.", "key": "top", "value": "" } ], "variable": [ { "key": "largeFaceListId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"persistedFaceId\": \"\",\n \"userData\": \"\"\n },\n {\n \"persistedFaceId\": \"\",\n \"userData\": \"\"\n }\n]", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-91dcc158-7659-44b1-a2ad-3d974245af89" }, { "id": "619ce9f7-8877-410c-8aa6-48c5fa595938", "name": "Error response.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/largefacelists/:largeFaceListId/persistedfaces?start=&top=", "host": [ "{{baseUrl}}" ], "path": [ "largefacelists", ":largeFaceListId", "persistedfaces" ], "query": [ { "description": "Starting face id to return (used to list a range of faces).", "key": "start", "value": "" }, { "description": "Number of faces to return starting with the face id indicated by the 'start' parameter.", "key": "top", "value": "" } ], "variable": [ { "key": "largeFaceListId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-619ce9f7-8877-410c-8aa6-48c5fa595938" } ], "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-7b507e87-ec47-46d1-9040-0aa45c46786d" } ], "id": "0b93d95c-b770-4eba-aaef-f5f457c1553d", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-0b93d95c-b770-4eba-aaef-f5f457c1553d" }, { "name": "Microsoft Azure Put Largefacelists Largefacelistid", "id": "4def7c78-0526-478b-8ac2-7c391c0017eb", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"recognitionModel\": {},\n \"userData\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/largefacelists/:largeFaceListId", "host": [ "{{baseUrl}}" ], "path": [ "largefacelists", ":largeFaceListId" ], "variable": [ { "id": "0a2c3379-1584-49e2-81aa-f45c154c3ed8", "key": "largeFaceListId", "value": "p3", "description": "(Required) Id referencing a particular large face list." } ] }, "description": "Create an empty large face list with user-specified largeFaceListId, name, an optional userData and recognitionModel.
Large face list is a list of faces, up to 1,000,000 faces, and used by [Face - Find Similar](https://docs.microsoft.com/rest/api/faceapi/face/findsimilar).
After creation, user should use [LargeFaceList Face - Add](https://docs.microsoft.com/rest/api/faceapi/largefacelist/addfacefromurl) to import the faces and [LargeFaceList - Train](https://docs.microsoft.com/rest/api/faceapi/largefacelist/train) to make it ready for [Face - Find Similar](https://docs.microsoft.com/rest/api/faceapi/face/findsimilar). No image will be stored. Only the extracted face features are stored on server until [LargeFaceList - Delete](https://docs.microsoft.com/rest/api/faceapi/largefacelist/delete) is called.
Find Similar is used for scenario like finding celebrity-like faces, similar face filtering, or as a light way face identification. But if the actual use is to identify person, please use [PersonGroup](https://docs.microsoft.com/rest/api/faceapi/persongroup) / [LargePersonGroup](https://docs.microsoft.com/rest/api/faceapi/largepersongroup) and [Face - Identify](https://docs.microsoft.com/rest/api/faceapi/face/identify).
'recognitionModel' should be specified to associate with this large face list. The default value for 'recognitionModel' is 'recognition_01', if the latest model needed, please explicitly specify the model you need in this parameter. New faces that are added to an existing large face list will use the recognition model that's already associated with the collection. Existing face features in a large face list can't be updated to features extracted by another version of recognition model. Please refer to [Specify a recognition model](https://docs.microsoft.com/azure/cognitive-services/face/face-api-how-to-topics/specify-recognition-model).

Large face list quota:
* Free-tier subscription quota: 64 large face lists.
* S0-tier subscription quota: 1,000,000 large face lists." }, "response": [ { "id": "9427085a-2337-4a2b-a4ed-129447b5f7d7", "name": "A successful call returns an empty response body.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"recognitionModel\": {},\n \"userData\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/largefacelists/:largeFaceListId", "host": [ "{{baseUrl}}" ], "path": [ "largefacelists", ":largeFaceListId" ], "variable": [ { "key": "largeFaceListId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-9427085a-2337-4a2b-a4ed-129447b5f7d7" }, { "id": "3b5fea97-7507-48de-821f-a65603a8c41b", "name": "Error response.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"recognitionModel\": {},\n \"userData\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/largefacelists/:largeFaceListId", "host": [ "{{baseUrl}}" ], "path": [ "largefacelists", ":largeFaceListId" ], "variable": [ { "key": "largeFaceListId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-3b5fea97-7507-48de-821f-a65603a8c41b" } ], "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-4def7c78-0526-478b-8ac2-7c391c0017eb" }, { "name": "Microsoft Azure Get Largefacelists Largefacelistid", "id": "207c5074-c1e4-4c35-b4e7-26118b0edb04", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/largefacelists/:largeFaceListId?returnRecognitionModel=false", "host": [ "{{baseUrl}}" ], "path": [ "largefacelists", ":largeFaceListId" ], "query": [ { "description": "A value indicating whether the operation should return 'recognitionModel' in response.", "key": "returnRecognitionModel", "value": "false" } ], "variable": [ { "id": "79649767-267a-454e-b61c-4544164ebe47", "key": "largeFaceListId", "value": "p3", "description": "(Required) Id referencing a particular large face list." } ] }, "description": "Retrieve a large face list\u2019s largeFaceListId, name, userData and recognitionModel." }, "response": [ { "id": "5c82fac7-85ff-4da9-b63a-c1ea3bef2ba5", "name": "A successful call returns the large face list's information.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/largefacelists/:largeFaceListId?returnRecognitionModel=false", "host": [ "{{baseUrl}}" ], "path": [ "largefacelists", ":largeFaceListId" ], "query": [ { "description": "A value indicating whether the operation should return 'recognitionModel' in response.", "key": "returnRecognitionModel", "value": "false" } ], "variable": [ { "key": "largeFaceListId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"largeFaceListId\": \"bei1ggx1s\",\n \"name\": \"\",\n \"userData\": \"\",\n \"recognitionModel\": \"recognition_01\"\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-5c82fac7-85ff-4da9-b63a-c1ea3bef2ba5" }, { "id": "293cc6d4-48aa-4650-b1f3-e0a3e1946383", "name": "Error response.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/largefacelists/:largeFaceListId?returnRecognitionModel=false", "host": [ "{{baseUrl}}" ], "path": [ "largefacelists", ":largeFaceListId" ], "query": [ { "description": "A value indicating whether the operation should return 'recognitionModel' in response.", "key": "returnRecognitionModel", "value": "false" } ], "variable": [ { "key": "largeFaceListId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-293cc6d4-48aa-4650-b1f3-e0a3e1946383" } ], "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-207c5074-c1e4-4c35-b4e7-26118b0edb04" }, { "name": "Microsoft Azure Patch Largefacelists Largefacelistid", "id": "270e9abf-9ab6-4834-913c-9c5d7f5e8b9e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"userData\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/largefacelists/:largeFaceListId", "host": [ "{{baseUrl}}" ], "path": [ "largefacelists", ":largeFaceListId" ], "variable": [ { "id": "4f0470a1-57b9-4f3d-b3af-c6fb542f5c60", "key": "largeFaceListId", "value": "p3", "description": "(Required) Id referencing a particular large face list." } ] }, "description": "Update information of a large face list." }, "response": [ { "id": "f6745533-dfb0-4742-b744-defc67fa76fd", "name": "A successful call returns an empty response body.", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"userData\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/largefacelists/:largeFaceListId", "host": [ "{{baseUrl}}" ], "path": [ "largefacelists", ":largeFaceListId" ], "variable": [ { "key": "largeFaceListId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-f6745533-dfb0-4742-b744-defc67fa76fd" }, { "id": "4b489c7b-4699-44ab-a805-9d40f7829afa", "name": "Error response.", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"userData\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/largefacelists/:largeFaceListId", "host": [ "{{baseUrl}}" ], "path": [ "largefacelists", ":largeFaceListId" ], "variable": [ { "key": "largeFaceListId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-4b489c7b-4699-44ab-a805-9d40f7829afa" } ], "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-270e9abf-9ab6-4834-913c-9c5d7f5e8b9e" }, { "name": "Microsoft Azure Delete Largefacelists Largefacelistid", "id": "aacaf196-a91d-4891-9dde-af748f8d9df4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/largefacelists/:largeFaceListId", "host": [ "{{baseUrl}}" ], "path": [ "largefacelists", ":largeFaceListId" ], "variable": [ { "id": "f73787b7-2a5a-46ec-b6ec-a947e2a58b05", "key": "largeFaceListId", "value": "p3", "description": "(Required) Id referencing a particular large face list." } ] }, "description": "Delete a specified large face list." }, "response": [ { "id": "49777bfa-bb6e-46ae-bb8a-0e72a98ecac6", "name": "A successful call returns an empty response body.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/largefacelists/:largeFaceListId", "host": [ "{{baseUrl}}" ], "path": [ "largefacelists", ":largeFaceListId" ], "variable": [ { "key": "largeFaceListId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-49777bfa-bb6e-46ae-bb8a-0e72a98ecac6" }, { "id": "05f9c0db-35aa-4868-bf98-c46901dfab93", "name": "Error response.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/largefacelists/:largeFaceListId", "host": [ "{{baseUrl}}" ], "path": [ "largefacelists", ":largeFaceListId" ], "variable": [ { "key": "largeFaceListId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-05f9c0db-35aa-4868-bf98-c46901dfab93" } ], "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-aacaf196-a91d-4891-9dde-af748f8d9df4" } ], "id": "7cb74126-1b64-4d71-a9f7-6e853bd8aab9", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-7cb74126-1b64-4d71-a9f7-6e853bd8aab9" }, { "name": "Microsoft Azure Get Largefacelists", "id": "7d21c5d5-c1b4-40fb-99d9-02f65e7d6d0b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/largefacelists?returnRecognitionModel=false&start=&top=", "host": [ "{{baseUrl}}" ], "path": [ "largefacelists" ], "query": [ { "description": "A value indicating whether the operation should return 'recognitionModel' in response.", "key": "returnRecognitionModel", "value": "false" }, { "description": "Starting large face list id to return (used to list a range of large face lists).", "key": "start", "value": "" }, { "description": "Number of large face lists to return starting with the large face list id indicated by the 'start' parameter.", "key": "top", "value": "" } ] }, "description": "List large face lists\u2019 information of largeFaceListId, name, userData and recognitionModel.
To get face information inside largeFaceList use [LargeFaceList Face - Get](https://docs.microsoft.com/rest/api/faceapi/largefacelist/getface)
* Large face lists are stored in alphabetical order of largeFaceListId.
* \"start\" parameter (string, optional) is a user-provided largeFaceListId value that returned entries have larger ids by string comparison. \"start\" set to empty to indicate return from the first item.
* \"top\" parameter (int, optional) specifies the number of entries to return. A maximal of 1000 entries can be returned in one call. To fetch more, you can specify \"start\" with the last returned entry\u2019s Id of the current call.

For example, total 5 large person lists: \"list1\", ..., \"list5\".
\"start=&top=\" will return all 5 lists.
\"start=&top=2\" will return \"list1\", \"list2\".
\"start=list2&top=3\" will return \"list3\", \"list4\", \"list5\".
" }, "response": [ { "id": "704749b0-b30e-461b-89df-15d02ad968e0", "name": "A successful call returns an array of largeFaceList.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/largefacelists?returnRecognitionModel=false&start=&top=", "host": [ "{{baseUrl}}" ], "path": [ "largefacelists" ], "query": [ { "description": "A value indicating whether the operation should return 'recognitionModel' in response.", "key": "returnRecognitionModel", "value": "false" }, { "description": "Starting large face list id to return (used to list a range of large face lists).", "key": "start", "value": "" }, { "description": "Number of large face lists to return starting with the large face list id indicated by the 'start' parameter.", "key": "top", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"largeFaceListId\": \"j8cx6xflv7\",\n \"name\": \"\",\n \"userData\": \"\",\n \"recognitionModel\": \"recognition_01\"\n },\n {\n \"largeFaceListId\": \"m2up2\",\n \"name\": \"\",\n \"userData\": \"\",\n \"recognitionModel\": \"recognition_01\"\n }\n]", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-704749b0-b30e-461b-89df-15d02ad968e0" }, { "id": "b5e22af0-22a4-4bc3-9057-1e575318812d", "name": "Error response.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/largefacelists?returnRecognitionModel=false&start=&top=", "host": [ "{{baseUrl}}" ], "path": [ "largefacelists" ], "query": [ { "description": "A value indicating whether the operation should return 'recognitionModel' in response.", "key": "returnRecognitionModel", "value": "false" }, { "description": "Starting large face list id to return (used to list a range of large face lists).", "key": "start", "value": "" }, { "description": "Number of large face lists to return starting with the large face list id indicated by the 'start' parameter.", "key": "top", "value": "" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-b5e22af0-22a4-4bc3-9057-1e575318812d" } ], "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-7d21c5d5-c1b4-40fb-99d9-02f65e7d6d0b" } ], "id": "1f854c8b-ca92-4eaf-a4a3-a556006c6906", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-1f854c8b-ca92-4eaf-a4a3-a556006c6906" }, { "name": "snapshots", "item": [ { "name": "{snapshotId}", "item": [ { "name": "apply", "item": [ { "name": "Microsoft Azure Post Snapshots Snapshotid Apply", "id": "7df1e720-5607-4ba1-8232-2f1901b6f05b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"objectId\": \"tr_m_g\",\n \"mode\": \"CreateNew\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/snapshots/:snapshotId/apply", "host": [ "{{baseUrl}}" ], "path": [ "snapshots", ":snapshotId", "apply" ], "variable": [ { "id": "75f073c6-8482-4924-8a2a-75122653e66a", "key": "snapshotId", "value": "", "description": "(Required) Id referencing a particular snapshot." } ] }, "description": "Submit an operation to apply a snapshot to current subscription. For each snapshot, only subscriptions included in the applyScope of Snapshot - Take can apply it.
The snapshot interfaces are for users to backup and restore their face data from one face subscription to another, inside same region or across regions. The workflow contains two phases, user first calls Snapshot - Take to create a copy of the source object and store it as a snapshot, then calls Snapshot - Apply to paste the snapshot to target subscription. The snapshots are stored in a centralized location (per Azure instance), so that they can be applied cross accounts and regions.
Applying snapshot is an asynchronous operation. An operation id can be obtained from the \"Operation-Location\" field in response header, to be used in OperationStatus - Get for tracking the progress of applying the snapshot. The target object id will be included in the \"resourceLocation\" field in OperationStatus - Get response when the operation status is \"succeeded\".
Snapshot applying time depends on the number of person and face entries in the snapshot object. It could be in seconds, or up to 1 hour for 1,000,000 persons with multiple faces.
Snapshots will be automatically expired and cleaned in 48 hours after it is created by Snapshot - Take. So the target subscription is required to apply the snapshot in 48 hours since its creation.
Applying a snapshot will not block any other operations against the target object, however it is not recommended because the correctness cannot be guaranteed during snapshot applying. After snapshot applying is completed, all operations towards the target object can work as normal. Snapshot also includes the training results of the source object, which means target subscription the snapshot applied to does not need re-train the target object before calling Identify/FindSimilar.
One snapshot can be applied multiple times in parallel, while currently only CreateNew apply mode is supported, which means the apply operation will fail if target subscription already contains an object of same type and using the same objectId. Users can specify the \"objectId\" in request body to avoid such conflicts.
* Free-tier subscription quota: 100 apply operations per month.
* S0-tier subscription quota: 100 apply operations per day." }, "response": [ { "id": "b9ca593e-888f-4e85-b843-81ba3bf7d2b4", "name": "The snapshot applying task was queued successfully.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"objectId\": \"tr_m_g\",\n \"mode\": \"CreateNew\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/snapshots/:snapshotId/apply", "host": [ "{{baseUrl}}" ], "path": [ "snapshots", ":snapshotId", "apply" ], "variable": [ { "key": "snapshotId" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "text", "header": [ { "disabled": false, "description": { "content": "Operation location with an operation id used to track the progress of applying the snapshot by OperationStatus - Get.", "type": "text/plain" }, "key": "Operation-Location", "value": "" } ], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-b9ca593e-888f-4e85-b843-81ba3bf7d2b4" }, { "id": "70ae8aaf-3c6a-471e-b1a5-a26464519f13", "name": "Error response.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"objectId\": \"tr_m_g\",\n \"mode\": \"CreateNew\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/snapshots/:snapshotId/apply", "host": [ "{{baseUrl}}" ], "path": [ "snapshots", ":snapshotId", "apply" ], "variable": [ { "key": "snapshotId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-70ae8aaf-3c6a-471e-b1a5-a26464519f13" } ], "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-7df1e720-5607-4ba1-8232-2f1901b6f05b" } ], "id": "a3036785-66db-4b95-b70b-67c39c48f0b6", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-a3036785-66db-4b95-b70b-67c39c48f0b6" }, { "name": "Microsoft Azure Get Snapshots Snapshotid", "id": "6c880a59-b1ac-40e3-b2a6-16b190adce3a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/snapshots/:snapshotId", "host": [ "{{baseUrl}}" ], "path": [ "snapshots", ":snapshotId" ], "variable": [ { "id": "00756feb-6ee5-4246-8d8d-faab6ef9d903", "key": "snapshotId", "value": "", "description": "(Required) Id referencing a particular snapshot." } ] }, "description": "Retrieve information about a snapshot. Snapshot is only accessible to the source subscription who took it, and target subscriptions included in the applyScope in Snapshot - Take." }, "response": [ { "id": "62bb3497-af70-4850-943d-13f25bda8ca1", "name": "A successful call returns the snapshot's information.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/snapshots/:snapshotId", "host": [ "{{baseUrl}}" ], "path": [ "snapshots", ":snapshotId" ], "variable": [ { "key": "snapshotId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"account\": \"\",\n \"type\": \"PersonGroup\",\n \"applyScope\": [\n \"\",\n \"\"\n ],\n \"createdTime\": \"\",\n \"lastUpdateTime\": \"\",\n \"userData\": \"\"\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-62bb3497-af70-4850-943d-13f25bda8ca1" }, { "id": "f4fe3acd-4c72-4a77-9869-3b0f1d65701d", "name": "Error response.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/snapshots/:snapshotId", "host": [ "{{baseUrl}}" ], "path": [ "snapshots", ":snapshotId" ], "variable": [ { "key": "snapshotId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-f4fe3acd-4c72-4a77-9869-3b0f1d65701d" } ], "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-6c880a59-b1ac-40e3-b2a6-16b190adce3a" }, { "name": "Microsoft Azure Patch Snapshots Snapshotid", "id": "5ad6f769-23ea-4692-a7cd-fe2e07183730", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"applyScope\": [\n \"\",\n \"\"\n ],\n \"userData\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/snapshots/:snapshotId", "host": [ "{{baseUrl}}" ], "path": [ "snapshots", ":snapshotId" ], "variable": [ { "id": "5602b26e-50da-49f9-8b7f-6db03aa89ebd", "key": "snapshotId", "value": "", "description": "(Required) Id referencing a particular snapshot." } ] }, "description": "Update the information of a snapshot. Only the source subscription who took the snapshot can update the snapshot." }, "response": [ { "id": "6201deb7-c0aa-4be0-9eb0-95caf9fb08f3", "name": "A successful call returns an empty response body.", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"applyScope\": [\n \"\",\n \"\"\n ],\n \"userData\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/snapshots/:snapshotId", "host": [ "{{baseUrl}}" ], "path": [ "snapshots", ":snapshotId" ], "variable": [ { "key": "snapshotId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-6201deb7-c0aa-4be0-9eb0-95caf9fb08f3" }, { "id": "027d74fd-6434-487f-a996-75f9a7de8330", "name": "Error response.", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"applyScope\": [\n \"\",\n \"\"\n ],\n \"userData\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/snapshots/:snapshotId", "host": [ "{{baseUrl}}" ], "path": [ "snapshots", ":snapshotId" ], "variable": [ { "key": "snapshotId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-027d74fd-6434-487f-a996-75f9a7de8330" } ], "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-5ad6f769-23ea-4692-a7cd-fe2e07183730" }, { "name": "Microsoft Azure Delete Snapshots Snapshotid", "id": "9d481528-8aa6-4e11-94b7-19c0c88820df", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/snapshots/:snapshotId", "host": [ "{{baseUrl}}" ], "path": [ "snapshots", ":snapshotId" ], "variable": [ { "id": "7c360e65-76a4-4170-9e53-51f7e4b3505c", "key": "snapshotId", "value": "", "description": "(Required) Id referencing a particular snapshot." } ] }, "description": "Delete an existing snapshot according to the snapshotId. All object data and information in the snapshot will also be deleted. Only the source subscription who took the snapshot can delete the snapshot. If the user does not delete a snapshot with this API, the snapshot will still be automatically deleted in 48 hours after creation." }, "response": [ { "id": "6be3795d-0441-4154-bc5a-df909dd2a07e", "name": "A successful call returns an empty response body.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/snapshots/:snapshotId", "host": [ "{{baseUrl}}" ], "path": [ "snapshots", ":snapshotId" ], "variable": [ { "key": "snapshotId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-6be3795d-0441-4154-bc5a-df909dd2a07e" }, { "id": "c2cffa4f-555b-47f0-9f5c-320e8bc0f84d", "name": "Error response.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/snapshots/:snapshotId", "host": [ "{{baseUrl}}" ], "path": [ "snapshots", ":snapshotId" ], "variable": [ { "key": "snapshotId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-c2cffa4f-555b-47f0-9f5c-320e8bc0f84d" } ], "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-9d481528-8aa6-4e11-94b7-19c0c88820df" } ], "id": "9a97dbe3-544b-4277-b28e-d386c216cd32", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-9a97dbe3-544b-4277-b28e-d386c216cd32" }, { "name": "Microsoft Azure Post Snapshots", "id": "aba2a732-cc8f-4a9f-a7a8-ea191f1c613f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"FaceList\",\n \"objectId\": \"bg-8fq\",\n \"applyScope\": [\n \"\",\n \"\"\n ],\n \"userData\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/snapshots", "host": [ "{{baseUrl}}" ], "path": [ "snapshots" ] }, "description": "Submit an operation to take a snapshot of face list, large face list, person group or large person group, with user-specified snapshot type, source object id, apply scope and an optional user data.
The snapshot interfaces are for users to backup and restore their face data from one face subscription to another, inside same region or across regions. The workflow contains two phases, user first calls Snapshot - Take to create a copy of the source object and store it as a snapshot, then calls Snapshot - Apply to paste the snapshot to target subscription. The snapshots are stored in a centralized location (per Azure instance), so that they can be applied cross accounts and regions.
Taking snapshot is an asynchronous operation. An operation id can be obtained from the \"Operation-Location\" field in response header, to be used in OperationStatus - Get for tracking the progress of creating the snapshot. The snapshot id will be included in the \"resourceLocation\" field in OperationStatus - Get response when the operation status is \"succeeded\".
Snapshot taking time depends on the number of person and face entries in the source object. It could be in seconds, or up to several hours for 1,000,000 persons with multiple faces.
Snapshots will be automatically expired and cleaned in 48 hours after it is created by Snapshot - Take. User can delete the snapshot using Snapshot - Delete by themselves any time before expiration.
Taking snapshot for a certain object will not block any other operations against the object. All read-only operations (Get/List and Identify/FindSimilar/Verify) can be conducted as usual. For all writable operations, including Add/Update/Delete the source object or its persons/faces and Train, they are not blocked but not recommended because writable updates may not be reflected on the snapshot during its taking. After snapshot taking is completed, all readable and writable operations can work as normal. Snapshot will also include the training results of the source object, which means target subscription the snapshot applied to does not need re-train the target object before calling Identify/FindSimilar.
* Free-tier subscription quota: 100 take operations per month.
* S0-tier subscription quota: 100 take operations per day." }, "response": [ { "id": "8784d3e0-f047-41ec-a9b7-be8c4a7dd687", "name": "The snapshot taking task was queued successfully.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"FaceList\",\n \"objectId\": \"bg-8fq\",\n \"applyScope\": [\n \"\",\n \"\"\n ],\n \"userData\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/snapshots", "host": [ "{{baseUrl}}" ], "path": [ "snapshots" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "text", "header": [ { "disabled": false, "description": { "content": "Operation location with an operation id used to track the progress of taking snapshot. The returned id is the operation id, rather than snapshot id. Snapshot id can be obtained only when the operation status becomes \"succeeded\" in OperationStatus - Get.", "type": "text/plain" }, "key": "Operation-Location", "value": "" } ], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-8784d3e0-f047-41ec-a9b7-be8c4a7dd687" }, { "id": "ecda0b32-e9da-4329-98f9-9193379daed0", "name": "Error response.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"FaceList\",\n \"objectId\": \"bg-8fq\",\n \"applyScope\": [\n \"\",\n \"\"\n ],\n \"userData\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/snapshots", "host": [ "{{baseUrl}}" ], "path": [ "snapshots" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-ecda0b32-e9da-4329-98f9-9193379daed0" } ], "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-aba2a732-cc8f-4a9f-a7a8-ea191f1c613f" }, { "name": "Microsoft Azure Get Snapshots", "id": "2e7835b7-39f5-46c8-866a-1ce4387d3930", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/snapshots?type=LargeFaceList&applyScope=,", "host": [ "{{baseUrl}}" ], "path": [ "snapshots" ], "query": [ { "description": "User specified object type as a search filter.", "key": "type", "value": "LargeFaceList" }, { "description": "User specified snapshot apply scopes as a search filter. ApplyScope is an array of the target Azure subscription ids for the snapshot, specified by the user who created the snapshot by Snapshot - Take.", "key": "applyScope", "value": "," } ] }, "description": "List all accessible snapshots with related information, including snapshots that were taken by the user, or snapshots to be applied to the user (subscription id was included in the applyScope in Snapshot - Take)." }, "response": [ { "id": "945d44dc-0c1a-4c35-9d22-bb65b971bbf6", "name": "A successful call returns an array of snapshots with snapshot information.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/snapshots?type=LargeFaceList&applyScope=,", "host": [ "{{baseUrl}}" ], "path": [ "snapshots" ], "query": [ { "description": "User specified object type as a search filter.", "key": "type", "value": "LargeFaceList" }, { "description": "User specified snapshot apply scopes as a search filter. ApplyScope is an array of the target Azure subscription ids for the snapshot, specified by the user who created the snapshot by Snapshot - Take.", "key": "applyScope", "value": "," } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"account\": \"\",\n \"type\": \"LargeFaceList\",\n \"applyScope\": [\n \"\",\n \"\"\n ],\n \"createdTime\": \"\",\n \"lastUpdateTime\": \"\",\n \"userData\": \"\"\n },\n {\n \"id\": \"\",\n \"account\": \"\",\n \"type\": \"PersonGroup\",\n \"applyScope\": [\n \"\",\n \"\"\n ],\n \"createdTime\": \"\",\n \"lastUpdateTime\": \"\",\n \"userData\": \"\"\n }\n]", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-945d44dc-0c1a-4c35-9d22-bb65b971bbf6" }, { "id": "86c5a20e-548c-48cb-9bb2-a8d6e997b28f", "name": "Error response.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/snapshots?type=LargeFaceList&applyScope=,", "host": [ "{{baseUrl}}" ], "path": [ "snapshots" ], "query": [ { "description": "User specified object type as a search filter.", "key": "type", "value": "LargeFaceList" }, { "description": "User specified snapshot apply scopes as a search filter. ApplyScope is an array of the target Azure subscription ids for the snapshot, specified by the user who created the snapshot by Snapshot - Take.", "key": "applyScope", "value": "," } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-86c5a20e-548c-48cb-9bb2-a8d6e997b28f" } ], "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-2e7835b7-39f5-46c8-866a-1ce4387d3930" } ], "id": "317afe92-6da4-4769-ab89-42054e29090c", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-317afe92-6da4-4769-ab89-42054e29090c" }, { "name": "operations", "item": [ { "name": "{operationId}", "item": [ { "name": "Microsoft Azure Get Operations Operationid", "id": "f89e439b-08a7-49d3-9bbc-1d73befb0076", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/operations/:operationId", "host": [ "{{baseUrl}}" ], "path": [ "operations", ":operationId" ], "variable": [ { "id": "0218cc42-fa48-4347-b53d-8a2422f87554", "key": "operationId", "value": "", "description": "(Required) Id referencing a particular take/apply snapshot operation." } ] }, "description": "Get status of a long running operation." }, "response": [ { "id": "538174ca-1a4d-458c-b654-7bed23073335", "name": "A successful call returns the operation's status.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/operations/:operationId", "host": [ "{{baseUrl}}" ], "path": [ "operations", ":operationId" ], "variable": [ { "key": "operationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"failed\",\n \"createdTime\": \"\",\n \"lastActionTime\": \"\",\n \"finishedTime\": \"\",\n \"resourceLocation\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-538174ca-1a4d-458c-b654-7bed23073335" }, { "id": "b0b94893-5dc5-4bbf-8821-4808b8f134a0", "name": "Error response.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/operations/:operationId", "host": [ "{{baseUrl}}" ], "path": [ "operations", ":operationId" ], "variable": [ { "key": "operationId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-b0b94893-5dc5-4bbf-8821-4808b8f134a0" } ], "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-f89e439b-08a7-49d3-9bbc-1d73befb0076" } ], "id": "a5a59973-7114-4272-988a-dfe071f0b420", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-a5a59973-7114-4272-988a-dfe071f0b420" } ], "id": "852e7c88-7c81-4ff3-abc5-4b3aed31bd9f", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-852e7c88-7c81-4ff3-abc5-4b3aed31bd9f" }, { "name": "persons", "item": [ { "name": "{personId}", "item": [ { "name": "recognitionModels", "item": [ { "name": "{recognitionModel}", "item": [ { "name": "persistedFaces", "item": [ { "name": "{persistedFaceId}", "item": [ { "name": "Microsoft Azure Delete An Existing Person Face From Person Directory \r\nthe Persistedfaceid, Userdata, And Face Feature In The Person Entry Will All Be Deleted", "id": "b83e3b35-f3de-4813-b388-86084ae16354", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/persons/:personId/recognitionModels/:recognitionModel/persistedFaces/:persistedFaceId", "host": [ "{{baseUrl}}" ], "path": [ "persons", ":personId", "recognitionModels", ":recognitionModel", "persistedFaces", ":persistedFaceId" ], "variable": [ { "id": "dbc1743d-36be-41b1-8779-1906b6bc12d1", "key": "personId", "value": "", "description": "(Required) Person id." }, { "id": "37d6662d-bb31-4119-b427-4afa58ca40a0", "key": "recognitionModel", "value": "", "description": "(Required) Recognition model string." }, { "id": "a93d889b-109a-45e8-8b7b-fdd3d2a10efa", "key": "persistedFaceId", "value": "", "description": "(Required) Persisted face id to delete." } ] }, "description": "Needs a more full description created." }, "response": [ { "id": "ae1aabcb-482d-4dad-a42e-bb6d30251bdd", "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/persons/:personId/recognitionModels/:recognitionModel/persistedFaces/:persistedFaceId", "host": [ "{{baseUrl}}" ], "path": [ "persons", ":personId", "recognitionModels", ":recognitionModel", "persistedFaces", ":persistedFaceId" ], "variable": [ { "key": "personId" }, { "key": "recognitionModel" }, { "key": "persistedFaceId" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "text", "header": [ { "disabled": false, "description": { "content": "Operation location with an operation id used to track the progress of person creation.", "type": "text/plain" }, "key": "Operation-Location", "value": "" } ], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-ae1aabcb-482d-4dad-a42e-bb6d30251bdd" }, { "id": "892f33be-112d-4378-9f01-0704359169f4", "name": "Response entity accompanying non-successful responses containing additional details about the error.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/persons/:personId/recognitionModels/:recognitionModel/persistedFaces/:persistedFaceId", "host": [ "{{baseUrl}}" ], "path": [ "persons", ":personId", "recognitionModels", ":recognitionModel", "persistedFaces", ":persistedFaceId" ], "variable": [ { "key": "personId" }, { "key": "recognitionModel" }, { "key": "persistedFaceId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-892f33be-112d-4378-9f01-0704359169f4" } ], "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-b83e3b35-f3de-4813-b388-86084ae16354" }, { "name": "Microsoft Azure Retrieve Person Face Information The Persisted Person Face Is Specified By Its Personid And Persistedfaceid", "id": "f21e35f5-b7c7-4806-8809-ade830b63118", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/persons/:personId/recognitionModels/:recognitionModel/persistedFaces/:persistedFaceId", "host": [ "{{baseUrl}}" ], "path": [ "persons", ":personId", "recognitionModels", ":recognitionModel", "persistedFaces", ":persistedFaceId" ], "variable": [ { "id": "70751a8e-337c-48aa-9e29-a3cf5da980b4", "key": "personId", "value": "", "description": "(Required) Target person to get face from." }, { "id": "db8d1132-70ca-412b-b53e-265a10dd0083", "key": "recognitionModel", "value": "", "description": "(Required) The 'recognitionModel' associated with this persisted face." }, { "id": "ecbaea8b-283e-47c1-83ff-b812975e99a9", "key": "persistedFaceId", "value": "", "description": "(Required) Target person face id to get." } ] }, "description": "Needs a more full description created." }, "response": [ { "id": "dc2f4da1-eea2-4ba5-8ec4-eb9c19b092e7", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/persons/:personId/recognitionModels/:recognitionModel/persistedFaces/:persistedFaceId", "host": [ "{{baseUrl}}" ], "path": [ "persons", ":personId", "recognitionModels", ":recognitionModel", "persistedFaces", ":persistedFaceId" ], "variable": [ { "key": "personId" }, { "key": "recognitionModel" }, { "key": "persistedFaceId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"persistedFaceId\": \"\",\n \"userData\": \"\"\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-dc2f4da1-eea2-4ba5-8ec4-eb9c19b092e7" }, { "id": "e6768c1e-b753-4241-859a-0ef58597ffa0", "name": "Response entity accompanying non-successful responses containing additional details about the error.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/persons/:personId/recognitionModels/:recognitionModel/persistedFaces/:persistedFaceId", "host": [ "{{baseUrl}}" ], "path": [ "persons", ":personId", "recognitionModels", ":recognitionModel", "persistedFaces", ":persistedFaceId" ], "variable": [ { "key": "personId" }, { "key": "recognitionModel" }, { "key": "persistedFaceId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-e6768c1e-b753-4241-859a-0ef58597ffa0" } ], "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-f21e35f5-b7c7-4806-8809-ade830b63118" }, { "name": "Microsoft Azure Update The Data Of A Person Face", "id": "fdd9bab0-a605-4930-bd34-13f06193fc66", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"detectionModel\": \"detection_03\",\n \"faceFeature\": \"\",\n \"persistedFaceId\": \"\",\n \"userData\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/persons/:personId/recognitionModels/:recognitionModel/persistedFaces/:persistedFaceId", "host": [ "{{baseUrl}}" ], "path": [ "persons", ":personId", "recognitionModels", ":recognitionModel", "persistedFaces", ":persistedFaceId" ], "variable": [ { "id": "c2e048de-be42-4848-8dc8-bfa4fe806c23", "key": "personId", "value": "", "description": "(Required) Target person to update face from." }, { "id": "4f5ba0f8-5581-4215-b5d7-23eb2ba60b2c", "key": "recognitionModel", "value": "", "description": "(Required) The 'recognitionModel' associated with this persisted face." }, { "id": "9a166538-3be9-4f41-a578-2a6c9355c3e1", "key": "persistedFaceId", "value": "", "description": "(Required) PersistedFaceId created from Person Face Create" } ] }, "description": "Needs a more full description created." }, "response": [ { "id": "9c55c9ab-d36c-4273-bd95-6daa2a9a8931", "name": "Success", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"detectionModel\": \"detection_03\",\n \"faceFeature\": \"\",\n \"persistedFaceId\": \"\",\n \"userData\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/persons/:personId/recognitionModels/:recognitionModel/persistedFaces/:persistedFaceId", "host": [ "{{baseUrl}}" ], "path": [ "persons", ":personId", "recognitionModels", ":recognitionModel", "persistedFaces", ":persistedFaceId" ], "variable": [ { "key": "personId" }, { "key": "recognitionModel" }, { "key": "persistedFaceId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-9c55c9ab-d36c-4273-bd95-6daa2a9a8931" }, { "id": "94404488-0a76-4014-abfa-b3900494d9ce", "name": "Response entity accompanying non-successful responses containing additional details about the error.", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"detectionModel\": \"detection_03\",\n \"faceFeature\": \"\",\n \"persistedFaceId\": \"\",\n \"userData\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/persons/:personId/recognitionModels/:recognitionModel/persistedFaces/:persistedFaceId", "host": [ "{{baseUrl}}" ], "path": [ "persons", ":personId", "recognitionModels", ":recognitionModel", "persistedFaces", ":persistedFaceId" ], "variable": [ { "key": "personId" }, { "key": "recognitionModel" }, { "key": "persistedFaceId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-94404488-0a76-4014-abfa-b3900494d9ce" } ], "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-fdd9bab0-a605-4930-bd34-13f06193fc66" } ], "id": "7f482fa9-3b96-4eb8-83b4-46c9891e2335", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-7f482fa9-3b96-4eb8-83b4-46c9891e2335" }, { "name": "Microsoft Azure Add A New Face To Person", "id": "f38486a6-5c11-45fd-965d-f3567487a511", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/persons/:personId/recognitionModels/:recognitionModel/persistedFaces?detectionModel=&userData=&targetFace=", "host": [ "{{baseUrl}}" ], "path": [ "persons", ":personId", "recognitionModels", ":recognitionModel", "persistedFaces" ], "query": [ { "description": "Detection model string.", "key": "detectionModel", "value": "" }, { "description": "User data of person face.", "key": "userData", "value": "" }, { "description": "Target face.", "key": "targetFace", "value": "" } ], "variable": [ { "id": "b35b8138-eeaa-41da-8635-d4b914f225a5", "key": "personId", "value": "", "description": "(Required) Person id." }, { "id": "c600a87d-d9e3-4577-bf91-c9da9a16ed4f", "key": "recognitionModel", "value": "", "description": "(Required) Recognition model string." } ] }, "description": "Needs a more full description created." }, "response": [ { "id": "b48b06a4-97b6-4778-8487-62b34be66bf9", "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/persons/:personId/recognitionModels/:recognitionModel/persistedFaces?detectionModel=&userData=&targetFace=", "host": [ "{{baseUrl}}" ], "path": [ "persons", ":personId", "recognitionModels", ":recognitionModel", "persistedFaces" ], "query": [ { "description": "Detection model string.", "key": "detectionModel", "value": "" }, { "description": "User data of person face.", "key": "userData", "value": "" }, { "description": "Target face.", "key": "targetFace", "value": "" } ], "variable": [ { "key": "personId" }, { "key": "recognitionModel" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Operation location with an operation id used to track the progress of person creation.", "type": "text/plain" }, "key": "Operation-Location", "value": "" } ], "cookie": [], "responseTime": null, "body": "{\n \"persistedFaceId\": \"\",\n \"recognitionModel\": \"\",\n \"userData\": \"\"\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-b48b06a4-97b6-4778-8487-62b34be66bf9" }, { "id": "d9297424-5323-4e77-b53a-f3310305e7ce", "name": "Response entity accompanying non-successful responses containing additional details about the error.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/persons/:personId/recognitionModels/:recognitionModel/persistedFaces?detectionModel=&userData=&targetFace=", "host": [ "{{baseUrl}}" ], "path": [ "persons", ":personId", "recognitionModels", ":recognitionModel", "persistedFaces" ], "query": [ { "description": "Detection model string.", "key": "detectionModel", "value": "" }, { "description": "User data of person face.", "key": "userData", "value": "" }, { "description": "Target face.", "key": "targetFace", "value": "" } ], "variable": [ { "key": "personId" }, { "key": "recognitionModel" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-d9297424-5323-4e77-b53a-f3310305e7ce" } ], "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-f38486a6-5c11-45fd-965d-f3567487a511" }, { "name": "Microsoft Azure Retrieve Person Face Information The Persisted Person Face Is Specified By Its Personid And Persistedfaceid", "id": "ee7ba251-9014-43c3-bda6-ee9695be5a13", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/persons/:personId/recognitionModels/:recognitionModel/persistedFaces", "host": [ "{{baseUrl}}" ], "path": [ "persons", ":personId", "recognitionModels", ":recognitionModel", "persistedFaces" ], "variable": [ { "id": "a18b8dc5-0dd4-428d-9466-922443bdd1b1", "key": "personId", "value": "", "description": "(Required) Target person to get persistedFaceIds from." }, { "id": "1f196f68-bafd-484f-bbec-3cba2bfced09", "key": "recognitionModel", "value": "", "description": "(Required) The 'recognitionModel' associated with this persisted face." } ] }, "description": "Needs a more full description created." }, "response": [ { "id": "51a8db33-bded-4a08-92d5-8bd46e3a34f9", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/persons/:personId/recognitionModels/:recognitionModel/persistedFaces", "host": [ "{{baseUrl}}" ], "path": [ "persons", ":personId", "recognitionModels", ":recognitionModel", "persistedFaces" ], "variable": [ { "key": "personId" }, { "key": "recognitionModel" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"personId\": \"\",\n \"persistedFaceIds\": [\n \"\",\n \"\"\n ],\n \"name\": \"\",\n \"userData\": \"\"\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-51a8db33-bded-4a08-92d5-8bd46e3a34f9" }, { "id": "df47e4ad-cf0b-4399-82df-4d990b2e9c9a", "name": "Response entity accompanying non-successful responses containing additional details about the error.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/persons/:personId/recognitionModels/:recognitionModel/persistedFaces", "host": [ "{{baseUrl}}" ], "path": [ "persons", ":personId", "recognitionModels", ":recognitionModel", "persistedFaces" ], "variable": [ { "key": "personId" }, { "key": "recognitionModel" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-df47e4ad-cf0b-4399-82df-4d990b2e9c9a" } ], "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-ee7ba251-9014-43c3-bda6-ee9695be5a13" } ], "id": "84e1f442-d5fc-4e46-af6b-3caf9ab6c78b", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-84e1f442-d5fc-4e46-af6b-3caf9ab6c78b" } ], "id": "23b956e0-3baf-4d6a-9a30-900d50830805", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-23b956e0-3baf-4d6a-9a30-900d50830805" } ], "id": "a1aaa465-fb73-4c61-9b5b-fa9c8265e8e2", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-a1aaa465-fb73-4c61-9b5b-fa9c8265e8e2" }, { "name": "dynamicPersonGroupReferences", "item": [ { "name": "Microsoft Azure List The Dynamic Person Groups That A Person Has Been Referenced In", "id": "942402d6-1c2c-4bd2-91c6-3c2710feb6da", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/persons/:personId/dynamicPersonGroupReferences?start=&top=", "host": [ "{{baseUrl}}" ], "path": [ "persons", ":personId", "dynamicPersonGroupReferences" ], "query": [ { "description": "List dynamic person group id from the least dynamicPersonGroupId greater than the \"start\". It contains no more than 64 characters. Default is empty.", "key": "start", "value": "" }, { "description": "The number of dynamicPersonGroupId to list, ranging in [1, 1000]. Default is 1000.", "key": "top", "value": "" } ], "variable": [ { "id": "7725c3a9-2f74-457e-8949-952b457969b1", "key": "personId", "value": "", "description": "(Required) Valid PersonId created from Person Create." } ] }, "description": "Needs a more full description created." }, "response": [ { "id": "52b77873-f73b-4b79-bb02-b2f268891996", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/persons/:personId/dynamicPersonGroupReferences?start=&top=", "host": [ "{{baseUrl}}" ], "path": [ "persons", ":personId", "dynamicPersonGroupReferences" ], "query": [ { "description": "List dynamic person group id from the least dynamicPersonGroupId greater than the \"start\". It contains no more than 64 characters. Default is empty.", "key": "start", "value": "" }, { "description": "The number of dynamicPersonGroupId to list, ranging in [1, 1000]. Default is 1000.", "key": "top", "value": "" } ], "variable": [ { "key": "personId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"personId\": \"\",\n \"dynamicPersonGroupIds\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-52b77873-f73b-4b79-bb02-b2f268891996" }, { "id": "0173cfe0-ed1f-425b-8cf2-a8bc80bda0c7", "name": "Response entity accompanying non-successful responses containing additional details about the error.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/persons/:personId/dynamicPersonGroupReferences?start=&top=", "host": [ "{{baseUrl}}" ], "path": [ "persons", ":personId", "dynamicPersonGroupReferences" ], "query": [ { "description": "List dynamic person group id from the least dynamicPersonGroupId greater than the \"start\". It contains no more than 64 characters. Default is empty.", "key": "start", "value": "" }, { "description": "The number of dynamicPersonGroupId to list, ranging in [1, 1000]. Default is 1000.", "key": "top", "value": "" } ], "variable": [ { "key": "personId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-0173cfe0-ed1f-425b-8cf2-a8bc80bda0c7" } ], "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-942402d6-1c2c-4bd2-91c6-3c2710feb6da" } ], "id": "5a703e48-3b67-4708-a77b-085ca35b2017", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-5a703e48-3b67-4708-a77b-085ca35b2017" }, { "name": "Microsoft Azure Update Name Or Userdata Of A Person", "id": "02bbd6f8-2143-4d7f-9620-8e1fb7a9fbbe", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"userData\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/persons/:personId", "host": [ "{{baseUrl}}" ], "path": [ "persons", ":personId" ], "variable": [ { "id": "63806c4a-a456-40c1-8493-0a3946ac29c5", "key": "personId", "value": "", "description": "(Required) Person id to update." } ] }, "description": "Needs a more full description created." }, "response": [ { "id": "7edc5eb5-4cfa-4a7f-98a4-cff380b41992", "name": "Success", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"userData\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/persons/:personId", "host": [ "{{baseUrl}}" ], "path": [ "persons", ":personId" ], "variable": [ { "key": "personId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-7edc5eb5-4cfa-4a7f-98a4-cff380b41992" }, { "id": "4019bc00-7bc0-4d51-afe9-c3a95b3ef154", "name": "Response entity accompanying non-successful responses containing additional details about the error.", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"userData\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/persons/:personId", "host": [ "{{baseUrl}}" ], "path": [ "persons", ":personId" ], "variable": [ { "key": "personId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-4019bc00-7bc0-4d51-afe9-c3a95b3ef154" } ], "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-02bbd6f8-2143-4d7f-9620-8e1fb7a9fbbe" }, { "name": "Microsoft Azure Delete An Existing Person From Person Directory \r\nthe Persistedfaceid, Userdata, Person Name And Face Feature S In The Person Entry Will All Be Deleted", "id": "f40d9b56-52fc-4f3b-a6a2-fa9b4338904e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/persons/:personId", "host": [ "{{baseUrl}}" ], "path": [ "persons", ":personId" ], "variable": [ { "id": "2fb2576b-349f-4e15-a203-59499ad1b2cf", "key": "personId", "value": "", "description": "(Required) Person id to delete." } ] }, "description": "Needs a more full description created." }, "response": [ { "id": "2067736d-82a7-4a38-a293-57aac26b7d18", "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/persons/:personId", "host": [ "{{baseUrl}}" ], "path": [ "persons", ":personId" ], "variable": [ { "key": "personId" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "text", "header": [ { "disabled": false, "description": { "content": "Operation location with an operation id used to track the progress of person creation.", "type": "text/plain" }, "key": "Operation-Location", "value": "" } ], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-2067736d-82a7-4a38-a293-57aac26b7d18" }, { "id": "558dcae4-6a96-4475-8581-ef29787fd76e", "name": "Response entity accompanying non-successful responses containing additional details about the error.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/persons/:personId", "host": [ "{{baseUrl}}" ], "path": [ "persons", ":personId" ], "variable": [ { "key": "personId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-558dcae4-6a96-4475-8581-ef29787fd76e" } ], "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-f40d9b56-52fc-4f3b-a6a2-fa9b4338904e" }, { "name": "Microsoft Azure Retrieve A Person S Name And Userdata, And The Persisted Faceids Representing The Registered Person Face Feature S", "id": "411c64c6-fa0b-48c6-a6f9-cf4bfcb79922", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/persons/:personId", "host": [ "{{baseUrl}}" ], "path": [ "persons", ":personId" ], "variable": [ { "id": "da71c75c-b215-4720-91ba-0c741298a03e", "key": "personId", "value": "", "description": "(Required) Person id." } ] }, "description": "Needs a more full description created." }, "response": [ { "id": "119b6a2a-1e3d-4432-a21f-555114a13905", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/persons/:personId", "host": [ "{{baseUrl}}" ], "path": [ "persons", ":personId" ], "variable": [ { "key": "personId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"personId\": \"\",\n \"name\": \"\",\n \"userData\": \"\"\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-119b6a2a-1e3d-4432-a21f-555114a13905" }, { "id": "57c47885-3d43-44dc-8b7c-1cb506c0f747", "name": "Response entity accompanying non-successful responses containing additional details about the error.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/persons/:personId", "host": [ "{{baseUrl}}" ], "path": [ "persons", ":personId" ], "variable": [ { "key": "personId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-57c47885-3d43-44dc-8b7c-1cb506c0f747" } ], "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-411c64c6-fa0b-48c6-a6f9-cf4bfcb79922" } ], "id": "8121b772-9baf-43c3-8c29-18e14b2cf4b6", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-8121b772-9baf-43c3-8c29-18e14b2cf4b6" }, { "name": "Microsoft Azure Retrieve List Of Person Information In Person Directory", "id": "91cbd971-6523-4149-a562-324922d7dd72", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/persons?start=&top=", "host": [ "{{baseUrl}}" ], "path": [ "persons" ], "query": [ { "description": "List persons from the least personId greater than the \"start\". It contains no more than 64 characters. Default is empty.", "key": "start", "value": "" }, { "description": "The number of persons to list, ranging in [1, 1000]. Default is 1000.", "key": "top", "value": "" } ] }, "description": "Needs a more full description created." }, "response": [ { "id": "a5047946-688f-48b4-9dd3-82295cdc34b5", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/persons?start=&top=", "host": [ "{{baseUrl}}" ], "path": [ "persons" ], "query": [ { "description": "List persons from the least personId greater than the \"start\". It contains no more than 64 characters. Default is empty.", "key": "start", "value": "" }, { "description": "The number of persons to list, ranging in [1, 1000]. Default is 1000.", "key": "top", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"personId\": \"\",\n \"name\": \"\",\n \"userData\": \"\"\n },\n {\n \"personId\": \"\",\n \"name\": \"\",\n \"userData\": \"\"\n }\n]", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-a5047946-688f-48b4-9dd3-82295cdc34b5" }, { "id": "eefdd220-6d53-4ac9-b008-c03f4fc3da17", "name": "Response entity accompanying non-successful responses containing additional details about the error.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/persons?start=&top=", "host": [ "{{baseUrl}}" ], "path": [ "persons" ], "query": [ { "description": "List persons from the least personId greater than the \"start\". It contains no more than 64 characters. Default is empty.", "key": "start", "value": "" }, { "description": "The number of persons to list, ranging in [1, 1000]. Default is 1000.", "key": "top", "value": "" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-eefdd220-6d53-4ac9-b008-c03f4fc3da17" } ], "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-91cbd971-6523-4149-a562-324922d7dd72" }, { "name": "Microsoft Azure Creates A New Person In Person Directory", "id": "3aba2bc7-6cc1-4f7d-878f-5420fb659fae", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"userData\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/persons", "host": [ "{{baseUrl}}" ], "path": [ "persons" ] }, "description": "Needs a more full description created." }, "response": [ { "id": "88cacaf2-9ed7-4bfa-bf1c-28d2d90b9069", "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"userData\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/persons", "host": [ "{{baseUrl}}" ], "path": [ "persons" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Operation location with an operation id used to track the progress of person creation.", "type": "text/plain" }, "key": "Operation-Location", "value": "" } ], "cookie": [], "responseTime": null, "body": "{\n \"personId\": \"\"\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-88cacaf2-9ed7-4bfa-bf1c-28d2d90b9069" }, { "id": "e36d1724-325a-442a-a85b-ffca9f3aa240", "name": "Response entity accompanying non-successful responses containing additional details about the error.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"userData\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/persons", "host": [ "{{baseUrl}}" ], "path": [ "persons" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-e36d1724-325a-442a-a85b-ffca9f3aa240" } ], "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-3aba2bc7-6cc1-4f7d-878f-5420fb659fae" } ], "id": "79c2c69b-ef87-42bb-bd23-e33009c6bec5", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-79c2c69b-ef87-42bb-bd23-e33009c6bec5" }, { "name": "dynamicpersongroups", "item": [ { "name": "{dynamicPersonGroupId}", "item": [ { "name": "persons", "item": [ { "name": "Microsoft Azure Retrieve List Of Persons Referenced In A Given Dynamicpersongroup Person Directory", "id": "62284c3c-4c81-43a4-98f6-c52bb5a80f1c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/dynamicpersongroups/:dynamicPersonGroupId/persons?start=&top=", "host": [ "{{baseUrl}}" ], "path": [ "dynamicpersongroups", ":dynamicPersonGroupId", "persons" ], "query": [ { "description": "List persons from the least personId greater than the \"start\". It contains no more than 64 characters. Default is empty.", "key": "start", "value": "" }, { "description": "The number of persons to list, ranging in [1, 1000]. Default is 1000.", "key": "top", "value": "" } ], "variable": [ { "id": "6d364a0f-7f76-4d5e-97b7-810f0585f227", "key": "dynamicPersonGroupId", "value": "", "description": "(Required) Dynamic person group Id to list persons from" } ] }, "description": "Needs a more full description created." }, "response": [ { "id": "6d268073-b709-4d37-918c-fc2693b91a2c", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/dynamicpersongroups/:dynamicPersonGroupId/persons?start=&top=", "host": [ "{{baseUrl}}" ], "path": [ "dynamicpersongroups", ":dynamicPersonGroupId", "persons" ], "query": [ { "description": "List persons from the least personId greater than the \"start\". It contains no more than 64 characters. Default is empty.", "key": "start", "value": "" }, { "description": "The number of persons to list, ranging in [1, 1000]. Default is 1000.", "key": "top", "value": "" } ], "variable": [ { "key": "dynamicPersonGroupId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"personIds\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-6d268073-b709-4d37-918c-fc2693b91a2c" }, { "id": "b0aad6c7-c36a-4aa8-8abc-1a20fe58059e", "name": "Response entity accompanying non-successful responses containing additional details about the error.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/dynamicpersongroups/:dynamicPersonGroupId/persons?start=&top=", "host": [ "{{baseUrl}}" ], "path": [ "dynamicpersongroups", ":dynamicPersonGroupId", "persons" ], "query": [ { "description": "List persons from the least personId greater than the \"start\". It contains no more than 64 characters. Default is empty.", "key": "start", "value": "" }, { "description": "The number of persons to list, ranging in [1, 1000]. Default is 1000.", "key": "top", "value": "" } ], "variable": [ { "key": "dynamicPersonGroupId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-b0aad6c7-c36a-4aa8-8abc-1a20fe58059e" } ], "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-62284c3c-4c81-43a4-98f6-c52bb5a80f1c" } ], "id": "b27f84b5-46e5-4904-8814-c845ca0eaa74", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-b27f84b5-46e5-4904-8814-c845ca0eaa74" }, { "name": "Microsoft Azure Creates A New Dynamic Person Group With Specified Dynamicpersongroupid, Name, And User Provided Userdata \r\na Dynamic Person Group Is A Container That References Persons \r\nafter Creation, Use \"dynamicpersongroup Update\" To Add Remove Perso", "id": "c4fc8c4b-21a0-480a-8049-b9e2d1e08b99", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"userData\": \"\",\n \"addPersonIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/dynamicpersongroups/:dynamicPersonGroupId", "host": [ "{{baseUrl}}" ], "path": [ "dynamicpersongroups", ":dynamicPersonGroupId" ], "variable": [ { "id": "3d18be58-e264-4dc5-9f77-0c9e9e00c281", "key": "dynamicPersonGroupId", "value": "", "description": "(Required) User provided dynamic person group Id. Valid format should be a string composed by numbers, English letters in lower case, '-', '_', and no longer than 64 characters." } ] }, "description": "Needs a more full description created." }, "response": [ { "id": "78402ee5-c61f-4434-a744-36b4b5ac6b93", "name": "Success", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"userData\": \"\",\n \"addPersonIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/dynamicpersongroups/:dynamicPersonGroupId", "host": [ "{{baseUrl}}" ], "path": [ "dynamicpersongroups", ":dynamicPersonGroupId" ], "variable": [ { "key": "dynamicPersonGroupId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-78402ee5-c61f-4434-a744-36b4b5ac6b93" }, { "id": "f842182b-0d33-4cd0-ac87-b2bd23302ee3", "name": "Success", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"userData\": \"\",\n \"addPersonIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/dynamicpersongroups/:dynamicPersonGroupId", "host": [ "{{baseUrl}}" ], "path": [ "dynamicpersongroups", ":dynamicPersonGroupId" ], "variable": [ { "key": "dynamicPersonGroupId" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "text", "header": [ { "disabled": false, "description": { "content": "Operation location with an operation id used to track the progress of person creation.", "type": "text/plain" }, "key": "Operation-Location", "value": "" } ], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-f842182b-0d33-4cd0-ac87-b2bd23302ee3" }, { "id": "c50995fb-5f43-4f11-8eae-52fa64e8f5f5", "name": "Response entity accompanying non-successful responses containing additional details about the error.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"userData\": \"\",\n \"addPersonIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/dynamicpersongroups/:dynamicPersonGroupId", "host": [ "{{baseUrl}}" ], "path": [ "dynamicpersongroups", ":dynamicPersonGroupId" ], "variable": [ { "key": "dynamicPersonGroupId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-c50995fb-5f43-4f11-8eae-52fa64e8f5f5" } ], "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-c4fc8c4b-21a0-480a-8049-b9e2d1e08b99" }, { "name": "Microsoft Azure Updates An Existing Dynamic Person Group With Specified Dynamicpersongroupid, Name, And User Provided Userdata", "id": "5e0137d7-4768-431f-a226-76d4f4dde9c3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"userData\": \"\",\n \"addPersonIds\": [\n \"\",\n \"\"\n ],\n \"removePersonIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/dynamicpersongroups/:dynamicPersonGroupId", "host": [ "{{baseUrl}}" ], "path": [ "dynamicpersongroups", ":dynamicPersonGroupId" ], "variable": [ { "id": "dd998b92-e1f6-452b-9697-33b5f9ba7a38", "key": "dynamicPersonGroupId", "value": "", "description": "(Required) User provided dynamic person group Id." } ] }, "description": "Needs a more full description created." }, "response": [ { "id": "62e9d762-f067-4a4d-99fe-46fec051d5dc", "name": "Success", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"userData\": \"\",\n \"addPersonIds\": [\n \"\",\n \"\"\n ],\n \"removePersonIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/dynamicpersongroups/:dynamicPersonGroupId", "host": [ "{{baseUrl}}" ], "path": [ "dynamicpersongroups", ":dynamicPersonGroupId" ], "variable": [ { "key": "dynamicPersonGroupId" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "text", "header": [ { "disabled": false, "description": { "content": "Operation location with an operation id used to track the progress of person creation.", "type": "text/plain" }, "key": "Operation-Location", "value": "" } ], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-62e9d762-f067-4a4d-99fe-46fec051d5dc" }, { "id": "010a20ef-d488-4f0d-9653-bd803757fec0", "name": "Response entity accompanying non-successful responses containing additional details about the error.", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"userData\": \"\",\n \"addPersonIds\": [\n \"\",\n \"\"\n ],\n \"removePersonIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/dynamicpersongroups/:dynamicPersonGroupId", "host": [ "{{baseUrl}}" ], "path": [ "dynamicpersongroups", ":dynamicPersonGroupId" ], "variable": [ { "key": "dynamicPersonGroupId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-010a20ef-d488-4f0d-9653-bd803757fec0" } ], "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-5e0137d7-4768-431f-a226-76d4f4dde9c3" }, { "name": "Microsoft Azure Get Metadata On A Dynamic Person Group", "id": "02553808-0831-47ee-868d-634afca664f0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/dynamicpersongroups/:dynamicPersonGroupId", "host": [ "{{baseUrl}}" ], "path": [ "dynamicpersongroups", ":dynamicPersonGroupId" ], "variable": [ { "id": "e6d25354-18bb-4151-9c63-39b44ef56d58", "key": "dynamicPersonGroupId", "value": "", "description": "(Required) User provided dynamic person group id" } ] }, "description": "Needs a more full description created." }, "response": [ { "id": "c364aa53-33d6-4085-ad7b-b6ac7333135c", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/dynamicpersongroups/:dynamicPersonGroupId", "host": [ "{{baseUrl}}" ], "path": [ "dynamicpersongroups", ":dynamicPersonGroupId" ], "variable": [ { "key": "dynamicPersonGroupId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"dynamicPersonGroupId\": \"\",\n \"name\": \"\",\n \"userData\": \"\"\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-c364aa53-33d6-4085-ad7b-b6ac7333135c" }, { "id": "818c7aa3-3848-4a8b-b752-efc051144505", "name": "Response entity accompanying non-successful responses containing additional details about the error.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/dynamicpersongroups/:dynamicPersonGroupId", "host": [ "{{baseUrl}}" ], "path": [ "dynamicpersongroups", ":dynamicPersonGroupId" ], "variable": [ { "key": "dynamicPersonGroupId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-818c7aa3-3848-4a8b-b752-efc051144505" } ], "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-02553808-0831-47ee-868d-634afca664f0" }, { "name": "Microsoft Azure Delete An Existing Dynamic Person Group \r\nnote That Persons Are Not Deleted With This Operation To Delete Person Call Person Delete", "id": "a0da5c09-1328-4245-bcb5-0a0e415eab30", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/dynamicpersongroups/:dynamicPersonGroupId", "host": [ "{{baseUrl}}" ], "path": [ "dynamicpersongroups", ":dynamicPersonGroupId" ], "variable": [ { "id": "00c02073-792c-4074-b7e1-355a6797f70c", "key": "dynamicPersonGroupId", "value": "", "description": "(Required) User provided dynamic person group Id." } ] }, "description": "Needs a more full description created." }, "response": [ { "id": "377b14c4-10e1-41f2-ad73-990a4ab3f5f4", "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/dynamicpersongroups/:dynamicPersonGroupId", "host": [ "{{baseUrl}}" ], "path": [ "dynamicpersongroups", ":dynamicPersonGroupId" ], "variable": [ { "key": "dynamicPersonGroupId" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "text", "header": [ { "disabled": false, "description": { "content": "Operation location with an operation id used to track the progress of person creation.", "type": "text/plain" }, "key": "Operation-Location", "value": "" } ], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-377b14c4-10e1-41f2-ad73-990a4ab3f5f4" }, { "id": "7f28c15e-016c-4c30-b384-194863a37c79", "name": "Response entity accompanying non-successful responses containing additional details about the error.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/dynamicpersongroups/:dynamicPersonGroupId", "host": [ "{{baseUrl}}" ], "path": [ "dynamicpersongroups", ":dynamicPersonGroupId" ], "variable": [ { "key": "dynamicPersonGroupId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-7f28c15e-016c-4c30-b384-194863a37c79" } ], "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-a0da5c09-1328-4245-bcb5-0a0e415eab30" } ], "id": "38246a64-435d-4099-a972-313c61ae29ca", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-38246a64-435d-4099-a972-313c61ae29ca" }, { "name": "Microsoft Azure Retrieve List Of Dynamic Person Groups In Person Directory", "id": "2a0923de-51c0-4417-b134-a2e4b534fca7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/dynamicpersongroups?start=&top=", "host": [ "{{baseUrl}}" ], "path": [ "dynamicpersongroups" ], "query": [ { "description": "List dynamicPersonGroupId from the least dynamicPersonGroupId greater than the \"start\". It contains no more than 64 characters. Default is empty.", "key": "start", "value": "" }, { "description": "The number of dynamicPersonGroups to list, ranging in [1, 1000]. Default is 1000.", "key": "top", "value": "" } ] }, "description": "Needs a more full description created." }, "response": [ { "id": "075642bf-5d89-4d54-a107-02ac909fa9fc", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/dynamicpersongroups?start=&top=", "host": [ "{{baseUrl}}" ], "path": [ "dynamicpersongroups" ], "query": [ { "description": "List dynamicPersonGroupId from the least dynamicPersonGroupId greater than the \"start\". It contains no more than 64 characters. Default is empty.", "key": "start", "value": "" }, { "description": "The number of dynamicPersonGroups to list, ranging in [1, 1000]. Default is 1000.", "key": "top", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"dynamicPersonGroupId\": \"\",\n \"name\": \"\",\n \"userData\": \"\"\n },\n {\n \"dynamicPersonGroupId\": \"\",\n \"name\": \"\",\n \"userData\": \"\"\n }\n]", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-075642bf-5d89-4d54-a107-02ac909fa9fc" }, { "id": "87d81d5e-d8cd-4100-8367-96fbe6e1de30", "name": "Response entity accompanying non-successful responses containing additional details about the error.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Ocp-Apim-Subscription-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/dynamicpersongroups?start=&top=", "host": [ "{{baseUrl}}" ], "path": [ "dynamicpersongroups" ], "query": [ { "description": "List dynamicPersonGroupId from the least dynamicPersonGroupId greater than the \"start\". It contains no more than 64 characters. Default is empty.", "key": "start", "value": "" }, { "description": "The number of dynamicPersonGroups to list, ranging in [1, 1000]. Default is 1000.", "key": "top", "value": "" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-87d81d5e-d8cd-4100-8367-96fbe6e1de30" } ], "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-2a0923de-51c0-4417-b134-a2e4b534fca7" } ], "id": "d94597ac-1582-422a-a6b7-bf109ab6eb59", "createdAt": "2026-06-05T15:18:14.000Z", "updatedAt": "2026-06-05T15:18:14.000Z", "uid": "35240-d94597ac-1582-422a-a6b7-bf109ab6eb59" } ], "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Ocp-Apim-Subscription-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "variable": [ { "key": "Endpoint", "value": "none" }, { "key": "baseUrl", "value": "{{Endpoint}}/face/v1.0-preview" } ] }