Changes.2026.11.05

What's New

`GET` /api/identity-store/stores/{storeName}/users/extendedSearch

Extended search based on first name, last name, phone number, email, and additional search terms defined alongside the Identity Store User.

What's Changed

`POST` /api/identity-store/stores/{storeName}/users/{extId}/biometrics/{type}/ext

Return Type:

Changed response : 200 OK

User biometric updated successfully

Changed content type : application/json
- Added property normalizedEmail (object)
  The user's email address after normalization applied.
- Added property phoneNumber (object)
  The user's phone number.
- Added property normalizedPhoneNumber (object)
  The user's phone number address after normalization applied.
- Added property searchTerms (object)
  Search terms string which allows the customer to provide additional search terms for that user, for example, a nick name or a document number.

`GET` /api/identity-store/stores/{storeName}/users

Parameters:

Added: firstName in query

First name filter (exact match). Cannot be used as the sole search parameter.

Added: lastName in query

Last name filter (exact match).

Added: email in query

Email filter (exact match against normalized email).

Added: phoneNumber in query

Phone number filter (exact match against normalized phone number).

Added: status in query

Comma-separated list of user statuses to filter by (e.g., 'ACTIVE,PENDING_ACTIVE'). If not provided, all statuses are returned.

Return Type:

Changed response : 400 Bad Request

Bad Request

New content type : */*
Deleted content type : application/json

`POST` /api/identity-store/stores/{storeName}/users

Request:

Changed content type : application/json

Added property normalizedEmail (object)
The user's email address after normalization applied.
Added property phoneNumber (object)
The user's phone number.
Added property normalizedPhoneNumber (object)
The user's phone number address after normalization applied.
Added property searchTerms (object)
Search terms string which allows the customer to provide additional search terms for that user, for example, a nick name or a document number.

Return Type:

Changed response : 201 Created

User created successfully

Changed content type : application/json
- Added property normalizedEmail (object)
  The user's email address after normalization applied.
- Added property phoneNumber (object)
  The user's phone number.
- Added property normalizedPhoneNumber (object)
  The user's phone number address after normalization applied.
- Added property searchTerms (object)
  Search terms string which allows the customer to provide additional search terms for that user, for example, a nick name or a document number.

`GET` /api/identity-store/stores/{storeName}/users/{userId}

Return Type:

Changed response : 200 OK

User retrieved successfully

Changed content type : application/json
- Added property normalizedEmail (object)
  The user's email address after applying normalization.
- Added property phoneNumber (object)
  The user's phone number.
- Added property normalizedPhoneNumber (object)
  The user's phone number after applying normalization.
- Added property searchTerms (object)
  Search terms string which allows the customer to provide additional search terms for that user, for example, a nick name or a document number.

`POST` /api/identity-store/stores/{storeName}/users/{userId}

Request:

Changed content type : application/json

Added property normalizedEmail (object)
The user's email address after normalization applied.
Added property phoneNumber (object)
The user's phone number.
Added property normalizedPhoneNumber (object)
The user's phone number address after normalization applied.
Added property searchTerms (object)
Search terms string which allows the customer to provide additional search terms for that user, for example, a nick name or a document number.

Return Type:

Changed response : 200 OK

User updated successfully

Changed content type : application/json
- Added property normalizedEmail (object)
  The user's email address after applying normalization.
- Added property phoneNumber (object)
  The user's phone number.
- Added property normalizedPhoneNumber (object)
  The user's phone number after applying normalization.
- Added property searchTerms (object)
  Search terms string which allows the customer to provide additional search terms for that user, for example, a nick name or a document number.

`DELETE` /api/identity-store/stores/{storeName}/users/{userId}/appkeys/relyingParties/{rpId}/preferredDevice/{deviceId}

Return Type:

Changed response : 200 OK

Preferred device deleted from user

Changed content type : application/json
- Added property normalizedEmail (object)
  The user's email address after applying normalization.
- Added property phoneNumber (object)
  The user's phone number.
- Added property normalizedPhoneNumber (object)
  The user's phone number after applying normalization.
- Added property searchTerms (object)
  Search terms string which allows the customer to provide additional search terms for that user, for example, a nick name or a document number.

`GET` /api/identity-store/stores/{storeName}/users/{extId}/ext

Return Type:

Changed response : 200 OK

User retrieved successfully

Changed content type : application/json
- Added property normalizedEmail (object)
  The user's email address after applying normalization.
- Added property phoneNumber (object)
  The user's phone number.
- Added property normalizedPhoneNumber (object)
  The user's phone number after applying normalization.
- Added property searchTerms (object)
  Search terms string which allows the customer to provide additional search terms for that user, for example, a nick name or a document number.

`POST` /api/identity-store/stores/{storeName}/users/{extId}/ext

Request:

Changed content type : application/json

Added property normalizedEmail (object)
The user's email address after normalization applied.
Added property phoneNumber (object)
The user's phone number.
Added property normalizedPhoneNumber (object)
The user's phone number address after normalization applied.
Added property searchTerms (object)
Search terms string which allows the customer to provide additional search terms for that user, for example, a nick name or a document number.

Return Type:

Changed response : 200 OK

User updated successfully

Changed content type : application/json
- Added property normalizedEmail (object)
  The user's email address after applying normalization.
- Added property phoneNumber (object)
  The user's phone number.
- Added property normalizedPhoneNumber (object)
  The user's phone number after applying normalization.
- Added property searchTerms (object)
  Search terms string which allows the customer to provide additional search terms for that user, for example, a nick name or a document number.

`DELETE` /api/identity-store/stores/{storeName}/users/{extUserId}/appkeys/relyingParties/{rpId}/preferredDevice/{deviceId}/ext

Return Type:

Changed response : 200 OK

Preferred device deleted from user

Changed content type : application/json
- Added property normalizedEmail (object)
  The user's email address after applying normalization.
- Added property phoneNumber (object)
  The user's phone number.
- Added property normalizedPhoneNumber (object)
  The user's phone number after applying normalization.
- Added property searchTerms (object)
  Search terms string which allows the customer to provide additional search terms for that user, for example, a nick name or a document number.

`POST` /api/identity-store/stores/{storeName}/users/{userId}/biometrics/{type}

Return Type:

Changed response : 200 OK

User biometric updated successfully

Changed content type : application/json
- Added property normalizedEmail (object)
  The user's email address after applying normalization.
- Added property phoneNumber (object)
  The user's phone number.
- Added property normalizedPhoneNumber (object)
  The user's phone number after applying normalization.
- Added property searchTerms (object)
  Search terms string which allows the customer to provide additional search terms for that user, for example, a nick name or a document number.

`POST` /api/watchlist-manager/trends

Return Type:

Changed response : 201 Created

Trend record added successfully

Changed content type : application/json
- Added property _links (object)
  Navigation links for related resources

`POST` /api/identity-store/stores/{storeName}/passcodes/renewals/sessions/{sessionId}

Return Type:

Changed response : 200 OK

Passcode renewal completed successfully

Changed content type : application/json
- Changed property user (object)
  A user in an identity store.
  - Added property normalizedEmail (object)
    The user's email address after applying normalization.
  - Added property phoneNumber (object)
    The user's phone number.
  - Added property normalizedPhoneNumber (object)
    The user's phone number after applying normalization.
  - Added property searchTerms (object)
    Search terms string which allows the customer to provide additional search terms for that user, for example, a nick name or a document number.

`POST` /api/identity-store/stores/{storeName}/users/{userId}/totps/registrations/{policyName}

Return Type:

Changed response : 201 Created

TOTP registration started successfully - QR code string created

Changed content type : application/json
- Changed property user (object)
  A user in an identity store.
  - Added property normalizedEmail (object)
    The user's email address after applying normalization.
  - Added property phoneNumber (object)
    The user's phone number.
  - Added property normalizedPhoneNumber (object)
    The user's phone number after applying normalization.
  - Added property searchTerms (object)
    Search terms string which allows the customer to provide additional search terms for that user, for example, a nick name or a document number.

`POST` /api/identity-store/stores/{storeName}/users/{userId}/totps/authentications/{policyName}

Return Type:

Changed response : 200 OK

TOTP authentication successful

Changed content type : application/json
- Changed property user (object)
  A user in an identity store.
  - Added property normalizedEmail (object)
    The user's email address after applying normalization.
  - Added property phoneNumber (object)
    The user's phone number.
  - Added property normalizedPhoneNumber (object)
    The user's phone number after applying normalization.
  - Added property searchTerms (object)
    Search terms string which allows the customer to provide additional search terms for that user, for example, a nick name or a document number.

`POST` /api/identity-store/stores/{storeName}/passcodes/registrations/sessions/{sessionId}

Return Type:

Changed response : 200 OK

Passcode registration completed successfully

Changed content type : application/json
- Changed property user (object)
  A user in an identity store.
  - Added property normalizedEmail (object)
    The user's email address after applying normalization.
  - Added property phoneNumber (object)
    The user's phone number.
  - Added property normalizedPhoneNumber (object)
    The user's phone number after applying normalization.
  - Added property searchTerms (object)
    Search terms string which allows the customer to provide additional search terms for that user, for example, a nick name or a document number.

`POST` /api/identity-store/stores/{storeName}/users/{extUserId}/appkeys/relyingParties/{rpId}/preferredDevices/ext

Return Type:

Changed response : 200 OK

User updated with the preferred device

Changed content type : application/json
- Added property normalizedEmail (object)
  The user's email address after applying normalization.
- Added property phoneNumber (object)
  The user's phone number.
- Added property normalizedPhoneNumber (object)
  The user's phone number after applying normalization.
- Added property searchTerms (object)
  Search terms string which allows the customer to provide additional search terms for that user, for example, a nick name or a document number.

`DELETE` /api/identity-store/stores/{storeName}/users/{extUserId}/appkeys/relyingParties/{rpId}/preferredDevices/ext

Return Type:

Changed response : 200 OK

Preferred device cleared from user

Changed content type : application/json
- Changed property user (object)
  A user in an identity store.
  - Added property normalizedEmail (object)
    The user's email address after applying normalization.
  - Added property phoneNumber (object)
    The user's phone number.
  - Added property normalizedPhoneNumber (object)
    The user's phone number after applying normalization.
  - Added property searchTerms (object)
    Search terms string which allows the customer to provide additional search terms for that user, for example, a nick name or a document number.

`POST` /api/identity-store/stores/{storeName}/users/{userExtId}/totps/authentications/{policyName}/ext

Return Type:

Changed response : 200 OK

TOTP authentication successful

Changed content type : application/json
- Changed property user (object)
  A user in an identity store.
  - Added property normalizedEmail (object)
    The user's email address after applying normalization.
  - Added property phoneNumber (object)
    The user's phone number.
  - Added property normalizedPhoneNumber (object)
    The user's phone number after applying normalization.
  - Added property searchTerms (object)
    Search terms string which allows the customer to provide additional search terms for that user, for example, a nick name or a document number.

`POST` /api/identity-store/stores/{storeName}/users/{userId}/totps/deregistrations/{policyName}

Return Type:

Changed response : 200 OK

User TOTP deregistered successfully

Changed content type : application/json
- Changed property user (object)
  A user in an identity store.
  - Added property normalizedEmail (object)
    The user's email address after applying normalization.
  - Added property phoneNumber (object)
    The user's phone number.
  - Added property normalizedPhoneNumber (object)
    The user's phone number after applying normalization.
  - Added property searchTerms (object)
    Search terms string which allows the customer to provide additional search terms for that user, for example, a nick name or a document number.

`POST` /api/identity-store/stores/{storeName}/users/{userId}/appkeys/relyingParties/{rpId}/preferredDevices

Return Type:

Changed response : 200 OK

User updated with the preferred device

Changed content type : application/json
- Added property normalizedEmail (object)
  The user's email address after applying normalization.
- Added property phoneNumber (object)
  The user's phone number.
- Added property normalizedPhoneNumber (object)
  The user's phone number after applying normalization.
- Added property searchTerms (object)
  Search terms string which allows the customer to provide additional search terms for that user, for example, a nick name or a document number.

`DELETE` /api/identity-store/stores/{storeName}/users/{userId}/appkeys/relyingParties/{rpId}/preferredDevices

Return Type:

Changed response : 200 OK

Preferred device cleared from user

Changed content type : application/json
- Changed property user (object)
  A user in an identity store.
  - Added property normalizedEmail (object)
    The user's email address after applying normalization.
  - Added property phoneNumber (object)
    The user's phone number.
  - Added property normalizedPhoneNumber (object)
    The user's phone number after applying normalization.
  - Added property searchTerms (object)
    Search terms string which allows the customer to provide additional search terms for that user, for example, a nick name or a document number.

`POST` /api/identity-store/stores/{storeName}/appkeys/authentications/sessions/{sessionId}

Return Type:

Changed response : 200 OK

Appkey authentication completed successfully

Changed content type : application/json
- Changed property user (object)
  A user in an identity store.
  - Added property normalizedEmail (object)
    The user's email address after applying normalization.
  - Added property phoneNumber (object)
    The user's phone number.
  - Added property normalizedPhoneNumber (object)
    The user's phone number after applying normalization.
  - Added property searchTerms (object)
    Search terms string which allows the customer to provide additional search terms for that user, for example, a nick name or a document number.

Changed response : 400 Bad Request

An error occurred either on the server or the client. Not all the error codes are listed here as there are many and a lot of them are unlikely to occur when integrating with a validated appkey client.
NOTE For convenience the updated user object is returned when there is an authentication error because it may contain updated information about the user lock state.
Some of the more likely errors are:
502: The user associated with this authentication is not active- 1014: Session data was provided but session management for this authentication is configured as internal
1017: The supplied client response message is not an authentication, it's a registration for example
1026: The application on the client device is not registered in the trusted facets list of the appkey policy
1029: The session challenge does not match the challenge in the client response
1035: The appkey type is not supported- 1058: No appkey was found which matched the appkey key ID supplied in the authentication assertion
1059: The appkey referenced in the authentication assertion was not registered to the expected user
1060: The appkey referenced in the authentication assertion is not active
1061: Potential appkey clone detected, the signature count is lower than expected.
1090: The single-shot challenge timestamp is outside the valid time window
1091: Malformed authentication response message from the client
1092: Client response message contains no authentication responses
1093: Client response message contains multiple authentication responses
1102: Malformed authentication failure response message from the client
1104: The authentication failed on the client
1105: The authentication was cancelled by the client
1115: Operation success/failure response data not provided
2100: The user is locked. Authentication cannot proceed.
2101: The user appkey modality is locked. Authentication cannot proceed.

Changed content type : application/json
- Changed property user (object)
  A user in an identity store.
  - Added property normalizedEmail (object)
    The user's email address after applying normalization.
  - Added property phoneNumber (object)
    The user's phone number.
  - Added property normalizedPhoneNumber (object)
    The user's phone number after applying normalization.
  - Added property searchTerms (object)
    Search terms string which allows the customer to provide additional search terms for that user, for example, a nick name or a document number.

`POST` /api/identity-store/stores/{storeName}/users/{userExtId}/totps/registrations/{policyName}/complete/ext

Return Type:

Changed response : 200 OK

TOTP registration completed successfully

Changed content type : application/json
- Changed property user (object)
  A user in an identity store.
  - Added property normalizedEmail (object)
    The user's email address after applying normalization.
  - Added property phoneNumber (object)
    The user's phone number.
  - Added property normalizedPhoneNumber (object)
    The user's phone number after applying normalization.
  - Added property searchTerms (object)
    Search terms string which allows the customer to provide additional search terms for that user, for example, a nick name or a document number.

`POST` /api/identity-store/stores/{storeName}/users/{userId}/totps/registrations/{policyName}/complete

Return Type:

Changed response : 200 OK

TOTP registration completed successfully

Changed content type : application/json
- Changed property user (object)
  A user in an identity store.
  - Added property normalizedEmail (object)
    The user's email address after applying normalization.
  - Added property phoneNumber (object)
    The user's phone number.
  - Added property normalizedPhoneNumber (object)
    The user's phone number after applying normalization.
  - Added property searchTerms (object)
    Search terms string which allows the customer to provide additional search terms for that user, for example, a nick name or a document number.

`POST` /api/identity-store/stores/{storeName}/users/{userExtId}/biometrics/authentications/failure/ext

Return Type:

Changed response : 200 OK

Failed biometric authentication recorded successfully

Changed content type : application/json
- Added property normalizedEmail (object)
  The user's email address after applying normalization.
- Added property phoneNumber (object)
  The user's phone number.
- Added property normalizedPhoneNumber (object)
  The user's phone number after applying normalization.
- Added property searchTerms (object)
  Search terms string which allows the customer to provide additional search terms for that user, for example, a nick name or a document number.

`POST` /api/identity-store/stores/{storeName}/users/{extId}/biometrics/authentications/face/ext

Return Type:

Changed response : 200 OK

Face matched successfully

Changed content type : application/json
- Changed property user (object)
  A user in an identity store.
  - Added property normalizedEmail (object)
    The user's email address after applying normalization.
  - Added property phoneNumber (object)
    The user's phone number.
  - Added property normalizedPhoneNumber (object)
    The user's phone number after applying normalization.
  - Added property searchTerms (object)
    Search terms string which allows the customer to provide additional search terms for that user, for example, a nick name or a document number.

Changed response : 400 Bad Request

An error occurred - including the face match failing.
NOTE For convenience the updated user object is returned when there is a face match failure because it may contain updated information about the user lock state.
Possible error codes:
8: Face algorithm not supported
2006: The biometric subtype is not supported
2100: The user is locked so authentication cannot be performed
2101: The face modality is locked so authentication cannot be performed
2102: The user is disabled so authentication cannot be performed
2103: The presented biometric is disabled so authentication cannot be performed
20114: Biometric data is not supplied in the request
20115: The specified biometric type is not supported
20120: An unexpected error occurred while generating face template
20121: An error occurred while attempting to perform a face match
20122: There is no suitable face data available for matching against the presented sample
20123: The matching process data is missing from the request
20124: The matching algorithm is missing from the request
20125: The matching threshold must be between 0 and 1
20126: The internal matching threshold must be between 0 and 1

Changed content type : application/json
- Changed property user (object)
  A user in an identity store.
  - Added property normalizedEmail (object)
    The user's email address after applying normalization.
  - Added property phoneNumber (object)
    The user's phone number.
  - Added property normalizedPhoneNumber (object)
    The user's phone number after applying normalization.
  - Added property searchTerms (object)
    Search terms string which allows the customer to provide additional search terms for that user, for example, a nick name or a document number.

`POST` /api/identity-store/stores/{storeName}/users/{userId}/biometrics/authentications/failure

Return Type:

Changed response : 200 OK

Failed biometric authentication recorded successfully

Changed content type : application/json
- Added property normalizedEmail (object)
  The user's email address after applying normalization.
- Added property phoneNumber (object)
  The user's phone number.
- Added property normalizedPhoneNumber (object)
  The user's phone number after applying normalization.
- Added property searchTerms (object)
  Search terms string which allows the customer to provide additional search terms for that user, for example, a nick name or a document number.

`POST` /api/identity-store/stores/{storeName}/users/{userId}/biometrics/authentications/face

Return Type:

Changed response : 200 OK

Face matched successfully

Changed content type : application/json
- Changed property user (object)
  A user in an identity store.
  - Added property normalizedEmail (object)
    The user's email address after applying normalization.
  - Added property phoneNumber (object)
    The user's phone number.
  - Added property normalizedPhoneNumber (object)
    The user's phone number after applying normalization.
  - Added property searchTerms (object)
    Search terms string which allows the customer to provide additional search terms for that user, for example, a nick name or a document number.

Changed response : 400 Bad Request

An error occurred - including the face match failing.
NOTE For convenience the updated user object is returned when there is a face match failure because it may contain updated information about the user lock state.
Possible error codes:
8: Face algorithm not supported
2006: The biometric subtype is not supported
2100: The user is locked so authentication cannot be performed
2101: The face modality is locked so authentication cannot be performed
2102: The user is disabled so authentication cannot be performed
2103: The presented biometric is disabled so authentication cannot be performed
20114: Biometric data is not supplied in the request
20115: The biometric type is not supported
20120: An unexpected error occurred while generating face template
20121: An error occurred while attempting to perform a face match
20122: There is no suitable face data available for matching against the presented sample
20123: The matching process data is missing from the request
20124: The matching algorithm is missing from the request
20125: The matching threshold must be between 0 and 1
20126: The internal matching threshold must be between 0 and 1

Changed content type : application/json
- Changed property user (object)
  A user in an identity store.
  - Added property normalizedEmail (object)
    The user's email address after applying normalization.
  - Added property phoneNumber (object)
    The user's phone number.
  - Added property normalizedPhoneNumber (object)
    The user's phone number after applying normalization.
  - Added property searchTerms (object)
    Search terms string which allows the customer to provide additional search terms for that user, for example, a nick name or a document number.

`POST` /api/identity-store/stores/{storeName}/users/{userExtId}/passcodes/deregistrations/{policyName}/ext

Return Type:

Changed response : 200 OK

User passcode deregistered successfully

Changed content type : application/json
- Changed property user (object)
  A user in an identity store.
  - Added property normalizedEmail (object)
    The user's email address after applying normalization.
  - Added property phoneNumber (object)
    The user's phone number.
  - Added property normalizedPhoneNumber (object)
    The user's phone number after applying normalization.
  - Added property searchTerms (object)
    Search terms string which allows the customer to provide additional search terms for that user, for example, a nick name or a document number.

`POST` /api/identity-store/stores/{storeName}/passcodes/authentications/sessions/{sessionId}

Return Type:

Changed response : 200 OK

Passcode authentication completed successfully

Changed content type : application/json
- Changed property user (object)
  A user in an identity store.
  - Added property normalizedEmail (object)
    The user's email address after applying normalization.
  - Added property phoneNumber (object)
    The user's phone number.
  - Added property normalizedPhoneNumber (object)
    The user's phone number after applying normalization.
  - Added property searchTerms (object)
    Search terms string which allows the customer to provide additional search terms for that user, for example, a nick name or a document number.

`POST` /api/identity-store/stores/{storeName}/users/{userExtId}/totps/registrations/{policyName}/ext

Return Type:

Changed response : 201 Created

TOTP registration started successfully - QR code string created

Changed content type : application/json
- Changed property user (object)
  A user in an identity store.
  - Added property normalizedEmail (object)
    The user's email address after applying normalization.
  - Added property phoneNumber (object)
    The user's phone number.
  - Added property normalizedPhoneNumber (object)
    The user's phone number after applying normalization.
  - Added property searchTerms (object)
    Search terms string which allows the customer to provide additional search terms for that user, for example, a nick name or a document number.

`POST` /api/identity-store/stores/{storeName}/users/{userId}/passcodes/deregistrations/{policyName}

Return Type:

Changed response : 200 OK

User passcode deregistered successfully

Changed content type : application/json
- Changed property user (object)
  A user in an identity store.
  - Added property normalizedEmail (object)
    The user's email address after applying normalization.
  - Added property phoneNumber (object)
    The user's phone number.
  - Added property normalizedPhoneNumber (object)
    The user's phone number after applying normalization.
  - Added property searchTerms (object)
    Search terms string which allows the customer to provide additional search terms for that user, for example, a nick name or a document number.

`POST` /api/identity-store/stores/{storeName}/appkeys/registrations/sessions/{sessionId}

Return Type:

Changed response : 200 OK

Appkey registration completed successfully

Changed content type : application/json
- Changed property user (object)
  A user in an identity store.
  - Added property normalizedEmail (object)
    The user's email address after applying normalization.
  - Added property phoneNumber (object)
    The user's phone number.
  - Added property normalizedPhoneNumber (object)
    The user's phone number after applying normalization.
  - Added property searchTerms (object)
    Search terms string which allows the customer to provide additional search terms for that user, for example, a nick name or a document number.

`POST` /api/identity-store/stores/{storeName}/users/{userExtId}/totps/deregistrations/{policyName}/ext

Return Type:

Changed response : 200 OK

User TOTP deregistered successfully

Changed content type : application/json
- Changed property user (object)
  A user in an identity store.
  - Added property normalizedEmail (object)
    The user's email address after applying normalization.
  - Added property phoneNumber (object)
    The user's phone number.
  - Added property normalizedPhoneNumber (object)
    The user's phone number after applying normalization.
  - Added property searchTerms (object)
    Search terms string which allows the customer to provide additional search terms for that user, for example, a nick name or a document number.

`POST` /api/identity-store/stores/{storeName}/biometrics

Return Type:

Changed response : 201 Created

Biometric enrolled and user created/retrieved successfully

Changed content type : application/json
- Changed property user (object)
  A user in an identity store.
  - Added property normalizedEmail (object)
    The user's email address after applying normalization.
  - Added property phoneNumber (object)
    The user's phone number.
  - Added property normalizedPhoneNumber (object)
    The user's phone number after applying normalization.
  - Added property searchTerms (object)
    Search terms string which allows the customer to provide additional search terms for that user, for example, a nick name or a document number.

`DELETE` /api/identity-store/stores/{storeName}/users/{userId}/appkeys/relyingParties/{rpId}/registrations/keyIds/{keyId}

Return Type:

Changed response : 200 OK

User appkey(s) deleted successfully

Changed content type : application/json
- Changed property user (object)
  A user in an identity store.
  - Added property normalizedEmail (object)
    The user's email address after applying normalization.
  - Added property phoneNumber (object)
    The user's phone number.
  - Added property normalizedPhoneNumber (object)
    The user's phone number after applying normalization.
  - Added property searchTerms (object)
    Search terms string which allows the customer to provide additional search terms for that user, for example, a nick name or a document number.

`POST` /api/identity-store/stores/{storeName}/users/{userId}/appkeys/relyingParties/{rpId}/deregistrations

Return Type:

Changed response : 200 OK

User appkey(s) deleted successfully

Changed content type : application/json
- Changed property user (object)
  A user in an identity store.
  - Added property normalizedEmail (object)
    The user's email address after applying normalization.
  - Added property phoneNumber (object)
    The user's phone number.
  - Added property normalizedPhoneNumber (object)
    The user's phone number after applying normalization.
  - Added property searchTerms (object)
    Search terms string which allows the customer to provide additional search terms for that user, for example, a nick name or a document number.

`POST` /api/identity-store/stores/{storeName}/passkeys/registrations/sessions/{sessionId}

Return Type:

Changed response : 200 OK

Passkey registration completed successfully

Changed content type : application/json
- Changed property user (object)
  A user in an identity store.
  - Added property normalizedEmail (object)
    The user's email address after applying normalization.
  - Added property phoneNumber (object)
    The user's phone number.
  - Added property normalizedPhoneNumber (object)
    The user's phone number after applying normalization.
  - Added property searchTerms (object)
    Search terms string which allows the customer to provide additional search terms for that user, for example, a nick name or a document number.

`POST` /api/identity-store/stores/{storeName}/biometrics/authentications/voice/{sessionId}

Return Type:

Changed response : 200 OK

Voice authentication completed successfully

Changed content type : application/json
- Changed property authenticationResult (object)
  The result details of a completed voice authentication.
  - Changed property user (object)
    A user in an identity store.
    - Added property normalizedEmail (object)
      The user's email address after applying normalization.
    - Added property phoneNumber (object)
      The user's phone number.
    - Added property normalizedPhoneNumber (object)
      The user's phone number after applying normalization.
    - Added property searchTerms (object)
      Search terms string which allows the customer to provide additional search terms for that user, for example, a nick name or a document number.

`POST` /api/identity-store/stores/{storeName}/users/{userId}/biometrics/authentications/voice

Return Type:

Changed response : 200 OK

Voice authentication session created successfully

Changed content type : application/json
- Changed property authenticationResult (object)
  The result details of a completed voice authentication.
  - Changed property user (object)
    A user in an identity store.
    - Added property normalizedEmail (object)
      The user's email address after applying normalization.
    - Added property phoneNumber (object)
      The user's phone number.
    - Added property normalizedPhoneNumber (object)
      The user's phone number after applying normalization.
    - Added property searchTerms (object)
      Search terms string which allows the customer to provide additional search terms for that user, for example, a nick name or a document number.

`POST` /api/identity-store/stores/{storeName}/users/{extUserId}/appkeys/relyingParties/{rpId}/deregistrations/ext

Return Type:

Changed response : 200 OK

User appkey(s) deleted successfully

Changed content type : application/json
- Changed property user (object)
  A user in an identity store.
  - Added property normalizedEmail (object)
    The user's email address after applying normalization.
  - Added property phoneNumber (object)
    The user's phone number.
  - Added property normalizedPhoneNumber (object)
    The user's phone number after applying normalization.
  - Added property searchTerms (object)
    Search terms string which allows the customer to provide additional search terms for that user, for example, a nick name or a document number.

`DELETE` /api/identity-store/stores/{storeName}/users/{extUserId}/appkeys/relyingParties/{rpId}/registrations/keyIds/{keyId}/ext

Return Type:

Changed response : 200 OK

User appkey(s) deleted successfully

Changed content type : application/json
- Changed property user (object)
  A user in an identity store.
  - Added property normalizedEmail (object)
    The user's email address after applying normalization.
  - Added property phoneNumber (object)
    The user's phone number.
  - Added property normalizedPhoneNumber (object)
    The user's phone number after applying normalization.
  - Added property searchTerms (object)
    Search terms string which allows the customer to provide additional search terms for that user, for example, a nick name or a document number.

`POST` /api/identity-store/stores/{storeName}/users/{userExtId}/biometrics/authentications/voice/ext

Return Type:

Changed response : 200 OK

Voice authentication session created successfully

Changed content type : application/json
- Changed property authenticationResult (object)
  The result details of a completed voice authentication.
  - Changed property user (object)
    A user in an identity store.
    - Added property normalizedEmail (object)
      The user's email address after applying normalization.
    - Added property phoneNumber (object)
      The user's phone number.
    - Added property normalizedPhoneNumber (object)
      The user's phone number after applying normalization.
    - Added property searchTerms (object)
      Search terms string which allows the customer to provide additional search terms for that user, for example, a nick name or a document number.

`POST` /api/identity-store/stores/{storeName}/passkeys/authentications/sessions/{sessionId}

Return Type:

Changed response : 200 OK

Passkey authentication completed successfully

Changed content type : application/json
- Changed property user (object)
  A user in an identity store.
  - Added property normalizedEmail (object)
    The user's email address after applying normalization.
  - Added property phoneNumber (object)
    The user's phone number.
  - Added property normalizedPhoneNumber (object)
    The user's phone number after applying normalization.
  - Added property searchTerms (object)
    Search terms string which allows the customer to provide additional search terms for that user, for example, a nick name or a document number.

Changed response : 400 Bad Request

An error occurred either on the server or the client. Not all the error codes are listed here as there are many and a lot of them are unlikely to occur when integrating a validated passkey client.
NOTE For convenience the updated user object is returned when there is an authentication error because it may contain updated information about the user lock state.
Some of the more likely errors are:
348: The passkey matching the supplied credential ID is not active
352: The supplied client response message is not an authentication, it's a registration
353: The provided challenge is not the same as the challenge signed in the assertion
354: The origin in the client response is not in the restricted origins list
356: Token binding in the client response does not match the expected value
356: Token binding status missing from client response
362: No passkey was found matching the supplied credential ID
363: The passkey matching the supplied credential ID does not match the expected user
364: The authentication credential is not in the allowed credentials list
364: There is not user handle for this passkey and relying party ID found for the user
365: The user handle in the assertion does not match the expected user handle
372: Possible cloned authenticator. The signature counter is out of synch.
382: The origin in the client response does not start with https
383: The origin in the client response does not match the relying party ID
388: Session data was provided but session management for this authentication is configured as internal
395: Operation success/failure response data not provided
397: Passkey authentication failed on the client
398: Passkey authentication was cancelled on the client
403: Passkey authentication timed out on the client
502: The user associated with this authentication is not active- 2100: The user is locked. Authentication cannot proceed.
2101: The user passkey modality is locked. Authentication cannot proceed.

Changed content type : application/json
- Changed property user (object)
  A user in an identity store.
  - Added property normalizedEmail (object)
    The user's email address after applying normalization.
  - Added property phoneNumber (object)
    The user's phone number.
  - Added property normalizedPhoneNumber (object)
    The user's phone number after applying normalization.
  - Added property searchTerms (object)
    Search terms string which allows the customer to provide additional search terms for that user, for example, a nick name or a document number.

`POST` /api/identity-store/stores/{storeName}/appkeys/authentications

Return Type:

Changed response : 200 OK

Appkey authentication completed successfully

Changed content type : application/json
- Changed property user (object)
  A user in an identity store.
  - Added property normalizedEmail (object)
    The user's email address after applying normalization.
  - Added property phoneNumber (object)
    The user's phone number.
  - Added property normalizedPhoneNumber (object)
    The user's phone number after applying normalization.
  - Added property searchTerms (object)
    Search terms string which allows the customer to provide additional search terms for that user, for example, a nick name or a document number.

Changed response : 400 Bad Request

An error occurred either on the server or the client. Not all the error codes are listed here as there are many and a lot of them are unlikely to occur when integrating a validated appkey client.
NOTE For convenience the updated user object is returned when there is an authentication error because it may contain updated information about the user lock state.
Some of the more likely errors are:
502: The user associated with this authentication is not active- 1009: Session data not provided
1011: Session data is missing the challenge
1012: Session data is missing the relying party ID
1017: The supplied client response message is not an authentication, it's a registration for example
1026: The application on the client device is not registered in the trusted facets list of the appkey policy
1029: The session challenge does not match the challenge in the client response
1035: The appkey type is not supported- 1055: Session data is missing the policy
1056: Session data is missing authentication policy name
1058: No appkey was found which matched the appkey key ID supplied in the authentication assertion
1059: The appkey referenced in the authentication assertion was not registered to the expected user
1060: The appkey referenced in the authentication assertion is not active
1061: Potential appkey clone detected, the signature count is lower than expected.
1090: The single-shot challenge timestamp is outside the valid time window
1091: Malformed authentication response message from the client
1092: Client response message contains no authentication responses
1093: Client response message contains multiple authentication responses
1102: Malformed authentication failure response message from the client
1104: The authentication failed on the client
1105: The authentication was cancelled by the client
1115: Operation success/failure response data not provided
2100: The user is locked. Authentication cannot proceed.
2101: The user appkey modality is locked. Authentication cannot proceed.

Changed content type : application/json
- Changed property user (object)
  A user in an identity store.
  - Added property normalizedEmail (object)
    The user's email address after applying normalization.
  - Added property phoneNumber (object)
    The user's phone number.
  - Added property normalizedPhoneNumber (object)
    The user's phone number after applying normalization.
  - Added property searchTerms (object)
    Search terms string which allows the customer to provide additional search terms for that user, for example, a nick name or a document number.

`POST` /api/identity-store/stores/{storeName}/appkeys/registrations

Return Type:

Changed response : 200 OK

Appkey registration completed successfully

Changed content type : application/json
- Changed property user (object)
  A user in an identity store.
  - Added property normalizedEmail (object)
    The user's email address after applying normalization.
  - Added property phoneNumber (object)
    The user's phone number.
  - Added property normalizedPhoneNumber (object)
    The user's phone number after applying normalization.
  - Added property searchTerms (object)
    Search terms string which allows the customer to provide additional search terms for that user, for example, a nick name or a document number.

`POST` /api/identity-store/stores/{storeName}/passkeys/authentications

Return Type:

Changed response : 200 OK

Passkey authentication completed successfully

Changed content type : application/json
- Changed property user (object)
  A user in an identity store.
  - Added property normalizedEmail (object)
    The user's email address after applying normalization.
  - Added property phoneNumber (object)
    The user's phone number.
  - Added property normalizedPhoneNumber (object)
    The user's phone number after applying normalization.
  - Added property searchTerms (object)
    Search terms string which allows the customer to provide additional search terms for that user, for example, a nick name or a document number.

Changed response : 400 Bad Request

An error occurred either on the server or the client. Not all the error codes are listed here as there are many and a lot of them are unlikely to occur when integrating a validated passkey client.
NOTE For convenience the updated user object is returned when there is an authentication error because it may contain updated information about the user lock state.
Some of the more likely errors are:
348: The passkey matching the supplied credential ID is not active
352: The supplied client response message is not an authentication, it's a registration
353: The provided challenge is not the same as the challenge signed in the assertion
354: The origin in the client response is not in the restricted origins list
356: Token binding in the client response does not match the expected value
356: Token binding status missing from client response
362: No passkey was found matching the supplied credential ID
363: The passkey matching the supplied credential ID does not match the expected user
364: The authentication credential is not in the allowed credentials list
364: There is not user handle for this passkey and relying party ID found for the user
365: The user handle in the assertion does not match the expected user handle
372: Possible cloned authenticator. The signature counter is out of synch.
382: The origin in the client response does not start with https
383: The origin in the client response does not match the relying party ID
384: Session data not provided
386: Session data is missing the challenge
387: Session data is missing the relying party ID
394: Session data is missing authentication policy name
395: Operation success/failure response data not provided
397: Passkey authentication failed on the client
398: Passkey authentication was cancelled on the client
403: Passkey authentication timed out on the client
502: The user associated with this authentication is not active- 2100: The user is locked. Authentication cannot proceed.
2101: The user passkey modality is locked. Authentication cannot proceed.

Changed content type : application/json
- Changed property user (object)
  A user in an identity store.
  - Added property normalizedEmail (object)
    The user's email address after applying normalization.
  - Added property phoneNumber (object)
    The user's phone number.
  - Added property normalizedPhoneNumber (object)
    The user's phone number after applying normalization.
  - Added property searchTerms (object)
    Search terms string which allows the customer to provide additional search terms for that user, for example, a nick name or a document number.

`POST` /api/identity-store/stores/{storeName}/passkeys/registrations

Return Type:

Changed response : 200 OK

Passkey registration completed successfully

Changed content type : application/json
- Changed property user (object)
  A user in an identity store.
  - Added property normalizedEmail (object)
    The user's email address after applying normalization.
  - Added property phoneNumber (object)
    The user's phone number.
  - Added property normalizedPhoneNumber (object)
    The user's phone number after applying normalization.
  - Added property searchTerms (object)
    Search terms string which allows the customer to provide additional search terms for that user, for example, a nick name or a document number.

`GET` /api/userdata-server/processDefinitions/{processDefnId}/processInstances/{processInstanceId}/userdata

Return Type:

Changed response : 200 OK

OK

Changed content type : */*
- Changed property signals (object)
  - Changed property deviceIntegritySignals (object)
    - Added property v4 (object)
    - Changed property v3 (object)

Last updated on