Account Protection API Version Comparison

April 16, 2025 17:00

We have a new version of the Account Protection API v2 for Login, New Account Opening, Challenge Outcome, and Failed Attempt. Changes have been made to the payload requests and responses. Refer to the following tables for each endpoint to see what properties have changed.

Login Version Comparison

The following tables define the changes between v1 and v2. Some existing API properties have been renamed or deprecated. If you have any questions, send an email to support@kount.com.

sidebar. Request payload comparison table

v1	v2	Explanation of Change
clientId		The Client ID in Login v2 is determined using the JSON Web Token. You do not have to pass the client ID in Login v2.
	inquiryId	A new required property. This is a customer-supplied identifier used to track the state across the inquiry or customer journey.
	channel	A new property. A unique identifier of the website or app and/or product where the inquiry originated.
sessionId	deviceSessionId	Renamed property for Login v2.
loginUrl	loginUrl	No change.
userIp	userIp	No change.
userAgent		This property has been deprecated in Login v2.
context		This property has been deprecated in Login v2.
preferredLanguageCode		This property has been deprecated in Login v2.
userAuthenticationStatus		This property has been deprecated in Login v2.
userId	account.id	Renamed property for Login v2.
username	account.username	Renamed and required property for Login v2.
userPassword	account.userPassword	Renamed property for Login v2.
	account.IsActive	A new property.
userCreationDate	account.creationDateTime	Renamed property for Login v2.
userType	account.type	Renamed property for Login v2.
	person.name.first	A new property. The first name for an end user.
	person.name.last	A new property. The last name for an end user.
	person.name.preferred	A new property. The preferred name for an end user.
mfaEmail	person.emailAddress	Renamed property for Login v2.
mfaPhone	person.phoneNumber	Renamed property for Login v2.
	person.address.line1	A new property. Line one of the end user's street address.
	person.address.line2	A new property. Line two of the end user's street address.
	person.address.city	A new property. The end user's city address.
	person.address.region	A new property. The end user's address region.
	person.address.postalCode	A new property. The end user's address postal code.
	person.address.countryCode	A new property. The end user's address country code.
	person.address.addressType	A new property. The end user's address type. Default: "UNKNOWN_ADDRESS_TYPE" Enum: "UNKNOWN_ADDRESS_TYPE" , "BILLING" , "SHIPPING"
workflow.mfaTemplate	strategy.mfaTemplate	Renamed attribute for Login v2.
workflow.mfaTemplate.mfaTargetUrl.success		The success target URL can now be added to the template, which removes the requirement to send it with each request.
workflow.mfaTemplate.mfaTargetUrl.expired		The expired target URL can now be added to the template, which removes the requirement to send it with each request.
workflow.mfaTemplate.mfaTargetUrl.failed		The failed target URL can now be added to the template, which removes the requirement to send it with each request.

sidebar. Response payload comparison table

v1	v2	Explanation of Change
guidance	decision	Renamed property for Login v2.
sessionId	deviceSessionId	Renamed property for Login v2.
deviceId	deviceId	No change.
matchedToDevice		No change.
trustState	trustState	No change.
friendlyName	friendlyName	No change.
set.name	policyManagement.set.name	Renamed property for Login v2.
set.versionName	policyManagement.set.versionName	Renamed property for Login v2.
	policyManagement.segmentExecuted.ID	A new property. The unique identifier for the segment evaluated as true.
userProfile	policyManagement.segmentExecuted.name	Renamed property for Login v2.
userSegment	policyManagement.segmentExecuted.name	Renamed property for Login v2.
	policyManagement.policiesTriggered.ID	A new property. The unique identifier for the policy evaluated as true.
	policyManagement.policiesTriggered.Name	A new property. The name for the policy evaluated as true.
tags	tags	No change.
tagWeights	policyManagement.tagWeights	Renamed property for Login v2.
mfaId	mfa.ID	Renamed property for Login v2.
mfaType	mfa.type	Renamed property for Login v2.
mfaError	mfa.Error	Renamed property for Login v2.

Challenge Outcome API Version Comparison

The following tables define the changes between v1 and v2. Some existing API properties have been renamed or deprecated. If you have any questions, send an email to support@kount.com.

You can use v2 of the Challenge Outcome endpoint to update Kount 360 about your challenge outcome if you are using your own Multifactor Authentication solution.

sidebar. Request payload comparison table

v1	v2	Explanation of Change
challengeOutcome.clientId		The Client ID in v2 is determined using the JSON Web Token. You do not have to pass the client ID in v2.
	inquiryId	A new required property. Customer-supplied identifier used to track the state across the inquiry or customer journey.
challengeOutcome.sessionId	deviceSessionId	Renamed property for v2.
challengeOutcome.loginDecisionCorrelationId	decisionCorrelationId	Renamed property for v2. The unique identifier from the original decision response from the Kount API.
challengeOutcome.challengeType	challengeType	Renamed property for v2.
challengeOutcome.challengeStatus	challengeStatus	Renamed property for v2.
challengeOutcome.userId		The user ID can now be retrieved from the decisionCorrelationId.
challengeOutcome.sentTimestamp	sentTimestamp	Renamed property for v2.
challengeOutcome.completedTimestamp	completedTimestamp	Renamed property for v2.
challengeOutcome.failureType	failureType	Renamed property for v2.
challengeOutcome.loginUrl		The Login or New Account Opening URL can now be retrieved from the decisionCorrelationId.
challengeOutcome.userType		The userType can now be retrieved from the decisionCorrelationId.

Failed Attempt API Version Comparison

The following tables define the changes between v1 and v2. Some existing API properties have been renamed or deprecated. If you have any questions, send an email to support@kount.com.

sidebar. Request payload comparison table

v1	v2	Explanation of Change
failedAttempt.clientId		The Client ID in v2 is now determined using the JSON Web Token. You do not have to pass the client ID in v2.
	inquiryId	A new required property. This is a customer-supplied identifier used to track the state across the inquiry or customer journey.
	channel	A new property. A unique identifier of the website or app and/or product where the inquiry originated.
failedAttempt.sessionId	deviceSessionId	Renamed property for v2.
	userIp	A new property. The user's IPv4 address as identified by the client.
failedAttempt.loginUrl	loginUrl	Renamed property for v2.
failedAttempt.userId	account.id	Renamed property for v2.
failedAttempt.username	account.username	Renamed property for v2.
failedAttempt.userPassword	account.password	Renamed property for v2.
failedAttempt.userAgent		This property has been deprecated in v2.
failedAttempt.userType	account.type	Renamed property for v2.
	person.name.first	A new property. The first name for an end user.
	person.name.last	A new property. The last name for an end user.
	person.name.preferred	A new property. The preferred name for an end user.
	person.emailAddress	Renamed property for v2.
	person.phoneNumber	Renamed property for v2.
	person.address.line1	A new property. Line one of the end user's street address.
	person.address.line2	A new property. Line two of the end user's street address.
	person.address.city	A new property. The end user's city address.
	person.address.region	A new property. The end user's address region.
	person.address.postalCode	A new property. The end user's address postal code.
	person.address.countryCode	A new property. The end user's address country code.
	person.address.addressType	A new property. The end user's address type. Default: "UNKNOWN_ADDRESS_TYPE" Enum: "UNKNOWN_ADDRESS_TYPE" , "BILLING" , "SHIPPING"

New Account Opening API Version Comparison

The following tables define the changes between v1 and v2. Some existing API properties have been renamed or deprecated. If you have any questions, send an email to support@kount.com.

sidebar. Request payload comparison table

v1	v2	Explanation of Change
clientId		The Client ID in v2 is determined using the JSON Web Token. You do not have to pass the client ID in v2.
	inquiryId	A new required property. This is a customer-supplied identifier used to track the state across the inquiry or customer journey.
	channel	A new property. A unique identifier of the website or app and/or product where the inquiry originated.
deviceSessionId	deviceSessionId	No change.
naoUrl	naoUrl	No change.
account.id	account.id	No change.
account.username	account.username	No change.
account.userPassword	account.userPassword	No change.
account.IsActive	account.IsActive	No change.
account.creationDate	account.creationDate	No change.
userType	account.type	Renamed property for v2.
	person.name.first	A new property. The first name for an end user.
	person.name.last	A new property. The last name for an end user.
	person.name.preferred	A new property. The preferred name for an end user.
	person.emailAddress	Renamed property for v2.
	person.phoneNumber	Renamed property for v2.
	person.address.line1	A new property. Line one of the end user's street address.
	person.address.line2	A new property. Line two of the end user's street address.
	person.address.city	A new property. The end user's city address.
	person.address.region	A new property. The end user's address region.
	person.address.postalCode	A new property. The end user's address postal code.
	person.address.countryCode	A new property. The end user's address country code.
	person.address.addressType	A new property. The end user's address type. Default: "UNKNOWN_ADDRESS_TYPE" Enum: "UNKNOWN_ADDRESS_TYPE" , "BILLING" , "SHIPPING"
strategy.mfaTemplate	strategy.mfaTemplate	No change.
workflow.mfaTemplate.mfaTargetUrl.success		The success target URL can now be added to the template, which removes the requirement to send it with each request.
workflow.mfaTemplate.mfaTargetUrl.expired		The expired target URL can now be added to the template, which removes the requirement to send it with each request.
workflow.mfaTemplate.mfaTargetUrl.failed		The failed target URL can now be added to the template, which removes the requirement to send it with each request.

sidebar. Response payload comparison table

v1	v2	Explanation of Change
guidance	decision	Renamed property for v2.
deviceSessionId	deviceSessionId	No change.
deviceId	deviceId	No change.
friendlyName	friendlyName	No change.
set.name	policyManagement.set.name	Renamed property for v2.
set.versionName	policyManagement.set.versionName	Renamed property for v2.
	policyManagement.segmentExecuted.ID	A new property. The unique identifier for the segment evaluated as true.
userProfile	policyManagement.segmentExecuted.name	Renamed property for v2.
userSegment	policyManagement.segmentExecuted.name	Renamed property for v2.
	policyManagement.policiesTriggered.ID	A new property. The unique identifier for the policy evaluated as true.
	policyManagement.policiesTriggered.Name	A new property. The name for the policy evaluated as true.
tags	tags	No change.
tagWeights	policyManagement.tagWeights	Renamed property for v2.
verificationId	verification.ID	Renamed property for v2.
verificationType	verification.type	Renamed property for v2.
verificationError	verification.Error	Renamed property for v2.

Was this article helpful?

0 out of 0 found this helpful