/
AZ
azure
Search skmtc…
⌘K
Docs
Sign in
Docs
History
Schema
Generate
Filter operations
post
/detect
Detect human faces in an image, return face rectangles, and optionally with faceIds, landmarks, and attributes.
post
/detectLiveness-sessions
Create a new detect liveness session.
get
/detectLiveness-sessions/{sessionId}
delete
/detectLiveness-sessions/{sessionId}
Delete all session related information for matching the specified session id.
post
/detectLivenessWithVerify-sessions
Create a new liveness session with verify. Provide the verify image during session creation.
get
/detectLivenessWithVerify-sessions/{sessionId}
delete
/detectLivenessWithVerify-sessions/{sessionId}
Delete all session related information for matching the specified session id.
get
/facelists
get
/facelists/{faceListId}
put
/facelists/{faceListId}
Create an empty Face List with user-specified faceListId, name, an optional userData and recognitionModel.
delete
/facelists/{faceListId}
patch
/facelists/{faceListId}
post
/facelists/{faceListId}/persistedfaces
Add a face to a specified Face List, up to 1,000 faces.
delete
/facelists/{faceListId}/persistedfaces/{persistedFaceId}
Delete a face from a Face List by specified faceListId and persistedFaceId.
post
/findsimilars
Given query face's faceId, to search the similar-looking faces from a faceId array. A faceId array contains the faces created by Detect.
post
/group
Divide candidate faces into groups based on face similarity.
post
/identify
1-to-many identification to find the closest matches of the specific query person face from a Person Group.
get
/largefacelists
List Large Face Lists' information of largeFaceListId, name, userData and recognitionModel.
get
/largefacelists/{largeFaceListId}
put
/largefacelists/{largeFaceListId}
Create an empty Large Face List with user-specified largeFaceListId, name, an optional userData and recognitionModel.
delete
/largefacelists/{largeFaceListId}
Delete a face from a Large Face List by specified largeFaceListId and persistedFaceId.
patch
/largefacelists/{largeFaceListId}
get
/largefacelists/{largeFaceListId}/persistedfaces
List faces' persistedFaceId and userData in a specified Large Face List.
post
/largefacelists/{largeFaceListId}/persistedfaces
Add a face to a specified Large Face List, up to 1,000,000 faces.
get
/largefacelists/{largeFaceListId}/persistedfaces/{persistedFaceId}
delete
/largefacelists/{largeFaceListId}/persistedfaces/{persistedFaceId}
patch
/largefacelists/{largeFaceListId}/persistedfaces/{persistedFaceId}
post
/largefacelists/{largeFaceListId}/train
Submit a Large Face List training task.
get
/largefacelists/{largeFaceListId}/training
get
/largepersongroups
List all existing Large Person Groups' largePersonGroupId, name, userData and recognitionModel.
get
/largepersongroups/{largePersonGroupId}
put
/largepersongroups/{largePersonGroupId}
Create a new Large Person Group with user-specified largePersonGroupId, name, an optional userData and recognitionModel.
delete
/largepersongroups/{largePersonGroupId}
patch
/largepersongroups/{largePersonGroupId}
get
/largepersongroups/{largePersonGroupId}/persons
List all persons' information in the specified Large Person Group, including personId, name, userData and persistedFaceIds of registered person faces.
post
/largepersongroups/{largePersonGroupId}/persons
Create a new person in a specified Large Person Group. To add face to this person, please call "Add Large Person Group Person Face".
get
/largepersongroups/{largePersonGroupId}/persons/{personId}
delete
/largepersongroups/{largePersonGroupId}/persons/{personId}
patch
/largepersongroups/{largePersonGroupId}/persons/{personId}
post
/largepersongroups/{largePersonGroupId}/persons/{personId}/persistedfaces
Add a face to a person into a Large Person Group for face identification or verification.
get
/largepersongroups/{largePersonGroupId}/persons/{personId}/persistedfaces/{persistedFaceId}
delete
/largepersongroups/{largePersonGroupId}/persons/{personId}/persistedfaces/{persistedFaceId}
Delete a face from a person in a Large Person Group by specified largePersonGroupId, personId and persistedFaceId.
patch
/largepersongroups/{largePersonGroupId}/persons/{personId}/persistedfaces/{persistedFaceId}
post
/largepersongroups/{largePersonGroupId}/train
Submit a Large Person Group training task. Training is a crucial step that only a trained Large Person Group can be used by "Identify From Large Person Group".
get
/largepersongroups/{largePersonGroupId}/training
To check Large Person Group training status completed or still ongoing. Large Person Group training is an asynchronous operation triggered by "Train Large Person Group" API.
get
/persongroups
List Person Groups' personGroupId, name, userData and recognitionModel.
get
/persongroups/{personGroupId}
put
/persongroups/{personGroupId}
Create a new Person Group with specified personGroupId, name, user-provided userData and recognitionModel.
delete
/persongroups/{personGroupId}
patch
/persongroups/{personGroupId}
get
/persongroups/{personGroupId}/persons
List all persons' information in the specified Person Group, including personId, name, userData and persistedFaceIds of registered person faces.
post
/persongroups/{personGroupId}/persons
Create a new person in a specified Person Group. To add face to this person, please call "Add Person Group Person Face".
get
/persongroups/{personGroupId}/persons/{personId}
delete
/persongroups/{personGroupId}/persons/{personId}
patch
/persongroups/{personGroupId}/persons/{personId}
post
/persongroups/{personGroupId}/persons/{personId}/persistedfaces
Add a face to a person into a Person Group for face identification or verification.
get
/persongroups/{personGroupId}/persons/{personId}/persistedfaces/{persistedFaceId}
delete
/persongroups/{personGroupId}/persons/{personId}/persistedfaces/{persistedFaceId}
Delete a face from a person in a Person Group by specified personGroupId, personId and persistedFaceId.
patch
/persongroups/{personGroupId}/persons/{personId}/persistedfaces/{persistedFaceId}
post
/persongroups/{personGroupId}/train
Submit a Person Group training task. Training is a crucial step that only a trained Person Group can be used by "Identify From Person Group".
get
/persongroups/{personGroupId}/training
get
/sessionImages/{sessionImageId}
get
/settings
patch
/settings
get
/settings/getClientAssetsAccessToken
post
/verify
Verify whether two faces belong to a same person.
Copy
Copy Markdown
Copy Markdown
Copying…
Copied
Copy failed
Changes to Create a new detect liveness session.
post
/detectLiveness-sessions
Jul 13, 2026
e9a68c525be6
Revision changes
info
endpoint added
Jul 13, 2026
44e2cf82becd
Revision changes
breaking
api path removed without deprecation
Jul 13, 2026
5375faa8d134
Revision changes
info
endpoint added