Skip to content

Create Face API v1.3 preview.1 Version#34429

Merged
nabilat merged 14 commits into
mainfrom
user/nabilat/face-v1.3-preview.1
Jul 25, 2025
Merged

Create Face API v1.3 preview.1 Version#34429
nabilat merged 14 commits into
mainfrom
user/nabilat/face-v1.3-preview.1

Adding expectedClientIpAddress to response.

42daa4a
Select commit
Loading
Failed to load commit list.
openapi-pipeline-app / Breaking Change(Cross-Version) succeeded Jul 24, 2025 in 3m 14s

Check `Breaking Change(Cross-Version)` succeeded

CrossVersionBreakingChange
View Azure DevOps build log for more details.

Important

To see the full list of breaking changes messages, with all the details available:
In the relevant ADO build (see the link above), find the job CrossVersionBreakingChange, then the task within, also called CrossVersionBreakingChange.
In the task's build log, search for Full list of messages.

Details

Compared specs (v0.10.13) new version base version
Face.json v1.3-preview.1(42daa4a) v1.2(main)
Face.json v1.3-preview.1(42daa4a) v1.2-preview.1(main)

The following breaking changes have been detected in comparison to the latest stable version

⚠️ 1038 - AddedPath

Displaying 2 out of 2 occurrences.

Index Description
1 The new version is adding a path that was not found in the old version.
New: Face/preview/v1.3-preview.1/Face.json#L3610:5
paths./settings
2 The new version is adding a path that was not found in the old version.
New: Face/preview/v1.3-preview.1/Face.json#L3682:5
paths./settings/getClientAssetsAccessToken

💬 1041 - AddedPropertyInResponse

Displaying 8 out of 8 occurrences.

Index Description
1 The new version has a new property 'abuseMonitoringResult' in response that was not found in the old version.
New: Face/preview/v1.3-preview.1/Face.json#L6641:7
definitions.LivenessSessionAttempt.properties
Old: Face/stable/v1.2/Face.json#L6422:7
2 The new version has a new property 'abuseMonitoringResult' in response that was not found in the old version.
New: Face/preview/v1.3-preview.1/Face.json#L6814:7
definitions.LivenessWithVerifySessionAttempt.properties
Old: Face/stable/v1.2/Face.json#L6576:7
3 The new version has a new property 'clientInformation' in response that was not found in the old version.
New: Face/preview/v1.3-preview.1/Face.json#L6641:7
definitions.LivenessSessionAttempt.properties
Old: Face/stable/v1.2/Face.json#L6422:7
4 The new version has a new property 'clientInformation' in response that was not found in the old version.
New: Face/preview/v1.3-preview.1/Face.json#L6814:7
definitions.LivenessWithVerifySessionAttempt.properties
Old: Face/stable/v1.2/Face.json#L6576:7
5 The new version has a new property 'expectedClientIpAddress' in response that was not found in the old version.
New: Face/preview/v1.3-preview.1/Face.json#L6600:7
definitions.LivenessSession.properties
Old: Face/stable/v1.2/Face.json#L6389:7
6 The new version has a new property 'expectedClientIpAddress' in response that was not found in the old version.
New: Face/preview/v1.3-preview.1/Face.json#L6773:7
definitions.LivenessWithVerifySession.properties
Old: Face/stable/v1.2/Face.json#L6543:7
7 The new version has a new property 'isAbuseMonitoringEnabled' in response that was not found in the old version.
New: Face/preview/v1.3-preview.1/Face.json#L6600:7
definitions.LivenessSession.properties
Old: Face/stable/v1.2/Face.json#L6389:7
8 The new version has a new property 'isAbuseMonitoringEnabled' in response that was not found in the old version.
New: Face/preview/v1.3-preview.1/Face.json#L6773:7
definitions.LivenessWithVerifySession.properties
Old: Face/stable/v1.2/Face.json#L6543:7

💬 1043 - AddingOptionalParameter

Displaying 1 out of 1 occurrences.

Index Description
1 The optional parameter 'numberOfClientAttemptsAllowed' was added in the new version.
New: Face/preview/v1.3-preview.1/Face.json#L578:11
paths./detectLivenessWithVerify-sessions.post.parameters[9]

💬 1045 - AddedOptionalProperty

Displaying 4 out of 4 occurrences.

Index Description
1 The new version has a new optional property 'expectedClientIpAddress' that was not found in the old version.
New: Face/preview/v1.3-preview.1/Face.json#L5440:7
definitions.CreateLivenessSessionContent.properties
Old: Face/stable/v1.2/Face.json#L5268:7
2 The new version has a new optional property 'numberOfClientAttemptsAllowed' that was not found in the old version.
New: Face/preview/v1.3-preview.1/Face.json#L5440:7
definitions.CreateLivenessSessionContent.properties
Old: Face/stable/v1.2/Face.json#L5268:7
3 The new version has a new optional property 'userCorrelationId' that was not found in the old version.
New: Face/preview/v1.3-preview.1/Face.json#L5440:7
definitions.CreateLivenessSessionContent.properties
Old: Face/stable/v1.2/Face.json#L5268:7
4 The new version has a new optional property 'userCorrelationIdSetInClient' that was not found in the old version.
New: Face/preview/v1.3-preview.1/Face.json#L5440:7
definitions.CreateLivenessSessionContent.properties
Old: Face/stable/v1.2/Face.json#L5268:7

The following breaking changes have been detected in comparison to the latest preview version

⚠️ 1005 - RemovedPath

Displaying 20 out of 20 occurrences.

Index Description
1 The new version is missing a path that was found in the old version. Was path '/detectLiveness/singleModal/sessions' removed or restructured?
Old: Face/preview/v1.2-preview.1/Face.json#L348:5
paths./detectLiveness/singleModal/sessions
2 The new version is missing a path that was found in the old version. Was path '/detectLiveness/singleModal/sessions/{sessionId}' removed or restructured?
Old: Face/preview/v1.2-preview.1/Face.json#L444:5
paths./detectLiveness/singleModal/sessions/{sessionId}
3 The new version is missing a path that was found in the old version. Was path '/detectLiveness/singleModal/sessions/{sessionId}/audit' removed or restructured?
Old: Face/preview/v1.2-preview.1/Face.json#L520:5
paths./detectLiveness/singleModal/sessions/{sessionId}/audit
4 The new version is missing a path that was found in the old version. Was path '/detectLivenessWithVerify/singleModal/sessions?_overload=createLivenessWithVerifySession' removed or restructured?
Old: Face/preview/v1.2-preview.1/Face.json#L5486:5
paths./detectLivenessWithVerify/singleModal/sessions?_overload=createLivenessWithVerifySession
5 The new version is missing a path that was found in the old version. Was path '/detectLivenessWithVerify/singleModal/sessions' removed or restructured?
Old: Face/preview/v1.2-preview.1/Face.json#L581:5
paths./detectLivenessWithVerify/singleModal/sessions
6 The new version is missing a path that was found in the old version. Was path '/detectLivenessWithVerify/singleModal/sessions/{sessionId}' removed or restructured?
Old: Face/preview/v1.2-preview.1/Face.json#L685:5
paths./detectLivenessWithVerify/singleModal/sessions/{sessionId}
7 The new version is missing a path that was found in the old version. Was path '/detectLivenessWithVerify/singleModal/sessions/{sessionId}/audit' removed or restructured?
Old: Face/preview/v1.2-preview.1/Face.json#L761:5
paths./detectLivenessWithVerify/singleModal/sessions/{sessionId}/audit
8 The new version is missing a path that was found in the old version. Was path '/dynamicpersongroups' removed or restructured?
Old: Face/preview/v1.2-preview.1/Face.json#L822:5
paths./dynamicpersongroups
9 The new version is missing a path that was found in the old version. Was path '/dynamicpersongroups/{dynamicPersonGroupId}?_overload=createDynamicPersonGroup' removed or restructured?
Old: Face/preview/v1.2-preview.1/Face.json#L5529:5
paths./dynamicpersongroups/{dynamicPersonGroupId}?_overload=createDynamicPersonGroup
10 The new version is missing a path that was found in the old version. Was path '/dynamicpersongroups/{dynamicPersonGroupId}?_overload=updateDynamicPersonGroup' removed or restructured?
Old: Face/preview/v1.2-preview.1/Face.json#L5578:5
paths./dynamicpersongroups/{dynamicPersonGroupId}?_overload=updateDynamicPersonGroup
11 The new version is missing a path that was found in the old version. Was path '/dynamicpersongroups/{dynamicPersonGroupId}' removed or restructured?
Old: Face/preview/v1.2-preview.1/Face.json#L877:5
paths./dynamicpersongroups/{dynamicPersonGroupId}
12 The new version is missing a path that was found in the old version. Was path '/dynamicpersongroups/{dynamicPersonGroupId}/persons' removed or restructured?
Old: Face/preview/v1.2-preview.1/Face.json#L1130:5
paths./dynamicpersongroups/{dynamicPersonGroupId}/persons
13 The new version is missing a path that was found in the old version. Was path '/operations/{operationId}' removed or restructured?
Old: Face/preview/v1.2-preview.1/Face.json#L3218:5
paths./operations/{operationId}
14 The new version is missing a path that was found in the old version. Was path '/persons' removed or restructured?
Old: Face/preview/v1.2-preview.1/Face.json#L4107:5
paths./persons
15 The new version is missing a path that was found in the old version. Was path '/persons/{personId}' removed or restructured?
Old: Face/preview/v1.2-preview.1/Face.json#L4214:5
paths./persons/{personId}
16 The new version is missing a path that was found in the old version. Was path '/persons/{personId}/dynamicPersonGroupReferences' removed or restructured?
Old: Face/preview/v1.2-preview.1/Face.json#L4343:5
paths./persons/{personId}/dynamicPersonGroupReferences
17 The new version is missing a path that was found in the old version. Was path '/persons/{personId}/recognitionModels/{recognitionModel}/persistedfaces?_overload=addPersonFaceFromUrl' removed or restructured?
Old: Face/preview/v1.2-preview.1/Face.json#L6305:5
paths./persons/{personId}/recognitionModels/{recognitionModel}/persistedfaces?_overload=addPersonFaceFromUrl
18 The new version is missing a path that was found in the old version. Was path '/persons/{personId}/recognitionModels/{recognitionModel}/persistedfaces' removed or restructured?
Old: Face/preview/v1.2-preview.1/Face.json#L4403:5
paths./persons/{personId}/recognitionModels/{recognitionModel}/persistedfaces
19 The new version is missing a path that was found in the old version. Was path '/persons/{personId}/recognitionModels/{recognitionModel}/persistedfaces/{persistedFaceId}' removed or restructured?
Old: Face/preview/v1.2-preview.1/Face.json#L4597:5
paths./persons/{personId}/recognitionModels/{recognitionModel}/persistedfaces/{persistedFaceId}
20 The new version is missing a path that was found in the old version. Was path '/session/sessionImages/{sessionImageId}' removed or restructured?
Old: Face/preview/v1.2-preview.1/Face.json#L4868:5
paths./session/sessionImages/{sessionImageId}

⚠️ 1006 - RemovedDefinition

Displaying 1 out of 1 occurrences.

Index Description
1 The new version is missing a definition that was found in the old version. Was 'CreateLivenessWithVerifySessionJsonContent' removed or renamed?
New: Face/preview/v1.3-preview.1/Face.json#L5145:3
definitions
Old: Face/preview/v1.2-preview.1/Face.json#L6605:3

⚠️ 1017 - ReferenceRedirection

Displaying 2 out of 2 occurrences.

Index Description
1 The '$ref' property points to different models in the old and new versions.
New: Face/preview/v1.3-preview.1/Face.json#L6610:9
definitions.LivenessSession.properties.status
Old: Face/preview/v1.2-preview.1/Face.json#L8202:9
2 The '$ref' property points to different models in the old and new versions.
New: Face/preview/v1.3-preview.1/Face.json#L6783:9
definitions.LivenessWithVerifySession.properties.status
Old: Face/preview/v1.2-preview.1/Face.json#L8397:9

⚠️ 1019 - RemovedEnumValue

Displaying 3 out of 3 occurrences.

Index Description
1 The new version is removing enum value(s) '2022-10-15-preview.04, 2023-12-20-preview.06' from the old version.
New: Face/preview/v1.3-preview.1/Face.json#L6530:5
definitions.LivenessModel
Old: Face/preview/v1.2-preview.1/Face.json#L8064:5
2 The new version is removing enum value(s) 'Started, ResultAvailable' from the old version.
New: Face/preview/v1.3-preview.1/Face.json#L6610:9
definitions.LivenessSession.properties.status
Old: Face/preview/v1.2-preview.1/Face.json#L8202:9
3 The new version is removing enum value(s) 'Started, ResultAvailable' from the old version.
New: Face/preview/v1.3-preview.1/Face.json#L6783:9
definitions.LivenessWithVerifySession.properties.status
Old: Face/preview/v1.2-preview.1/Face.json#L8397:9

⚠️ 1033 - RemovedProperty

Displaying 17 out of 17 occurrences.

Index Description
1 The new version is missing a property found in the old version. Was 'authTokenTimeToLiveInSeconds' renamed or removed?
New: Face/preview/v1.3-preview.1/Face.json#L6600:7
definitions.LivenessSession.properties
Old: Face/preview/v1.2-preview.1/Face.json#L8170:7
2 The new version is missing a property found in the old version. Was 'authTokenTimeToLiveInSeconds' renamed or removed?
New: Face/preview/v1.3-preview.1/Face.json#L6773:7
definitions.LivenessWithVerifySession.properties
Old: Face/preview/v1.2-preview.1/Face.json#L8365:7
3 The new version is missing a property found in the old version. Was 'createdDateTime' renamed or removed?
New: Face/preview/v1.3-preview.1/Face.json#L6600:7
definitions.LivenessSession.properties
Old: Face/preview/v1.2-preview.1/Face.json#L8170:7
4 The new version is missing a property found in the old version. Was 'createdDateTime' renamed or removed?
New: Face/preview/v1.3-preview.1/Face.json#L6773:7
definitions.LivenessWithVerifySession.properties
Old: Face/preview/v1.2-preview.1/Face.json#L8365:7
5 The new version is missing a property found in the old version. Was 'deviceCorrelationId' renamed or removed?
New: Face/preview/v1.3-preview.1/Face.json#L6600:7
definitions.LivenessSession.properties
Old: Face/preview/v1.2-preview.1/Face.json#L8170:7
6 The new version is missing a property found in the old version. Was 'deviceCorrelationId' renamed or removed?
New: Face/preview/v1.3-preview.1/Face.json#L6773:7
definitions.LivenessWithVerifySession.properties
Old: Face/preview/v1.2-preview.1/Face.json#L8365:7
7 The new version is missing a property found in the old version. Was 'id' renamed or removed?
New: Face/preview/v1.3-preview.1/Face.json#L6600:7
definitions.LivenessSession.properties
Old: Face/preview/v1.2-preview.1/Face.json#L8170:7
8 The new version is missing a property found in the old version. Was 'id' renamed or removed?
New: Face/preview/v1.3-preview.1/Face.json#L6773:7
definitions.LivenessWithVerifySession.properties
Old: Face/preview/v1.2-preview.1/Face.json#L8365:7
9 The new version is missing a property found in the old version. Was 'livenessSingleModalModel' renamed or removed?
New: Face/preview/v1.3-preview.1/Face.json#L5440:7
definitions.CreateLivenessSessionContent.properties
Old: Face/preview/v1.2-preview.1/Face.json#L6857:7
10 The new version is missing a property found in the old version. Was 'result' renamed or removed?
New: Face/preview/v1.3-preview.1/Face.json#L6600:7
definitions.LivenessSession.properties
Old: Face/preview/v1.2-preview.1/Face.json#L8170:7
11 The new version is missing a property found in the old version. Was 'result' renamed or removed?
New: Face/preview/v1.3-preview.1/Face.json#L6773:7
definitions.LivenessWithVerifySession.properties
Old: Face/preview/v1.2-preview.1/Face.json#L8365:7
12 The new version is missing a property found in the old version. Was 'sendResultsToClient' renamed or removed?
New: Face/preview/v1.3-preview.1/Face.json#L5440:7
definitions.CreateLivenessSessionContent.properties
Old: Face/preview/v1.2-preview.1/Face.json#L6857:7
13 The new version is missing a property found in the old version. Was 'sessionExpired' renamed or removed?
New: Face/preview/v1.3-preview.1/Face.json#L6600:7
definitions.LivenessSession.properties
Old: Face/preview/v1.2-preview.1/Face.json#L8170:7
14 The new version is missing a property found in the old version. Was 'sessionExpired' renamed or removed?
New: Face/preview/v1.3-preview.1/Face.json#L6773:7
definitions.LivenessWithVerifySession.properties
Old: Face/preview/v1.2-preview.1/Face.json#L8365:7
15 The new version is missing a property found in the old version. Was 'sessionStartDateTime' renamed or removed?
New: Face/preview/v1.3-preview.1/Face.json#L6600:7
definitions.LivenessSession.properties
Old: Face/preview/v1.2-preview.1/Face.json#L8170:7
16 The new version is missing a property found in the old version. Was 'sessionStartDateTime' renamed or removed?
New: Face/preview/v1.3-preview.1/Face.json#L6773:7
definitions.LivenessWithVerifySession.properties
Old: Face/preview/v1.2-preview.1/Face.json#L8365:7
17 The new version is missing a property found in the old version. Was 'verifyImage' renamed or removed?
New: Face/preview/v1.3-preview.1/Face.json#L6695:7
definitions.LivenessWithVerifyOutputs.properties
Old: Face/preview/v1.2-preview.1/Face.json#L8339:7

⚠️ 1034 - AddedRequiredProperty

Displaying 8 out of 8 occurrences.

Index Description
1 The new version lists new non-read-only properties as required: 'authToken'. These properties were not listed as required in the old version.
New: Face/preview/v1.3-preview.1/Face.json#L6600:7
definitions.LivenessSession.properties
Old: Face/preview/v1.2-preview.1/Face.json#L8170:7
2 The new version lists new non-read-only properties as required: 'authToken'. These properties were not listed as required in the old version.
New: Face/preview/v1.3-preview.1/Face.json#L6773:7
definitions.LivenessWithVerifySession.properties
Old: Face/preview/v1.2-preview.1/Face.json#L8365:7
3 The new version lists new non-read-only properties as required: 'results'. These properties were not listed as required in the old version.
New: Face/preview/v1.3-preview.1/Face.json#L6600:7
definitions.LivenessSession.properties
Old: Face/preview/v1.2-preview.1/Face.json#L8170:7
4 The new version lists new non-read-only properties as required: 'results'. These properties were not listed as required in the old version.
New: Face/preview/v1.3-preview.1/Face.json#L6773:7
definitions.LivenessWithVerifySession.properties
Old: Face/preview/v1.2-preview.1/Face.json#L8365:7
5 The new version lists new non-read-only properties as required: 'sessionId, authToken, results'. These properties were not listed as required in the old version.
New: Face/preview/v1.3-preview.1/Face.json#L6597:5
definitions.LivenessSession
Old: Face/preview/v1.2-preview.1/Face.json#L8167:5
6 The new version lists new non-read-only properties as required: 'sessionId, authToken, results'. These properties were not listed as required in the old version.
New: Face/preview/v1.3-preview.1/Face.json#L6770:5
definitions.LivenessWithVerifySession
Old: Face/preview/v1.2-preview.1/Face.json#L8362:5
7 The new version lists new non-read-only properties as required: 'sessionId'. These properties were not listed as required in the old version.
New: Face/preview/v1.3-preview.1/Face.json#L6600:7
definitions.LivenessSession.properties
Old: Face/preview/v1.2-preview.1/Face.json#L8170:7
8 The new version lists new non-read-only properties as required: 'sessionId'. These properties were not listed as required in the old version.
New: Face/preview/v1.3-preview.1/Face.json#L6773:7
definitions.LivenessWithVerifySession.properties
Old: Face/preview/v1.2-preview.1/Face.json#L8365:7

⚠️ 1038 - AddedPath

Displaying 7 out of 7 occurrences.

Index Description
1 The new version is adding a path that was not found in the old version.
New: Face/preview/v1.3-preview.1/Face.json#L348:5
paths./detectLiveness-sessions
2 The new version is adding a path that was not found in the old version.
New: Face/preview/v1.3-preview.1/Face.json#L3566:5
paths./sessionImages/{sessionImageId}
3 The new version is adding a path that was not found in the old version.
New: Face/preview/v1.3-preview.1/Face.json#L3610:5
paths./settings
4 The new version is adding a path that was not found in the old version.
New: Face/preview/v1.3-preview.1/Face.json#L3682:5
paths./settings/getClientAssetsAccessToken
5 The new version is adding a path that was not found in the old version.
New: Face/preview/v1.3-preview.1/Face.json#L391:5
paths./detectLiveness-sessions/{sessionId}
6 The new version is adding a path that was not found in the old version.
New: Face/preview/v1.3-preview.1/Face.json#L467:5
paths./detectLivenessWithVerify-sessions
7 The new version is adding a path that was not found in the old version.
New: Face/preview/v1.3-preview.1/Face.json#L616:5
paths./detectLivenessWithVerify-sessions/{sessionId}

⚠️ 1047 - XmsEnumChanged

Displaying 2 out of 2 occurrences.

Index Description
1 The new version has a different x-ms-enum 'name' than the previous one.
New: Face/preview/v1.3-preview.1/Face.json#L6610:9
definitions.LivenessSession.properties.status
Old: Face/preview/v1.2-preview.1/Face.json#L8202:9
2 The new version has a different x-ms-enum 'name' than the previous one.
New: Face/preview/v1.3-preview.1/Face.json#L6783:9
definitions.LivenessWithVerifySession.properties.status
Old: Face/preview/v1.2-preview.1/Face.json#L8397:9

💬 1020 - AddedEnumValue

Displaying 3 out of 3 occurrences.

Index Description
1 The new version is adding enum value(s) '2024-11-15' from the old version.
New: Face/preview/v1.3-preview.1/Face.json#L6530:5
definitions.LivenessModel
Old: Face/preview/v1.2-preview.1/Face.json#L8064:5
2 The new version is adding enum value(s) 'Running, Succeeded, Failed, Canceled' from the old version.
New: Face/preview/v1.3-preview.1/Face.json#L6610:9
definitions.LivenessSession.properties.status
Old: Face/preview/v1.2-preview.1/Face.json#L8202:9
3 The new version is adding enum value(s) 'Running, Succeeded, Failed, Canceled' from the old version.
New: Face/preview/v1.3-preview.1/Face.json#L6783:9
definitions.LivenessWithVerifySession.properties.status
Old: Face/preview/v1.2-preview.1/Face.json#L8397:9

💬 1045 - AddedOptionalProperty

Displaying 5 out of 5 occurrences.

Index Description
1 The new version has a new optional property 'expectedClientIpAddress' that was not found in the old version.
New: Face/preview/v1.3-preview.1/Face.json#L5440:7
definitions.CreateLivenessSessionContent.properties
Old: Face/preview/v1.2-preview.1/Face.json#L6857:7
2 The new version has a new optional property 'livenessModelVersion' that was not found in the old version.
New: Face/preview/v1.3-preview.1/Face.json#L5440:7
definitions.CreateLivenessSessionContent.properties
Old: Face/preview/v1.2-preview.1/Face.json#L6857:7
3 The new version has a new optional property 'numberOfClientAttemptsAllowed' that was not found in the old version.
New: Face/preview/v1.3-preview.1/Face.json#L5440:7
definitions.CreateLivenessSessionContent.properties
Old: Face/preview/v1.2-preview.1/Face.json#L6857:7
4 The new version has a new optional property 'userCorrelationId' that was not found in the old version.
New: Face/preview/v1.3-preview.1/Face.json#L5440:7
definitions.CreateLivenessSessionContent.properties
Old: Face/preview/v1.2-preview.1/Face.json#L6857:7
5 The new version has a new optional property 'userCorrelationIdSetInClient' that was not found in the old version.
New: Face/preview/v1.3-preview.1/Face.json#L5440:7
definitions.CreateLivenessSessionContent.properties
Old: Face/preview/v1.2-preview.1/Face.json#L6857:7