Download OpenAPI specification:Download
Request to Kount triggering an evaluation of Client defined policies and returning a decision based on those policies
| clientId required | string (clientId) ^[a-zA-Z0-9]{1,64}$ Kount's unique identifier for a Client |
| sessionId required | string (sessionId) ^[\w-]{0,32}$ Device collection event identifier |
| userId required | string (userId) .{1,255}$ Client’s unique identifier for a Client’s User |
| username | string (username) ^.{0,128}$ Username for a Client’s user |
| userPassword | string (userPassword) `^.{0,128}$` Irrevocable hash of the Client's user's password |
| userIp | string <ipv4> (userIp) User’s IPv4 address as identified by the Client |
| loginUrl | string (loginUrl) ^.{0,256}$ Webpage from which a Client’s user is attempting to log in |
| userAuthenticationStatus | string (userAuthenticationStatus) ^[a-zA-Z0-9]{1,64}$ Not validated/restricted, intended to indicate if user already completed step up authN |
| userCreationDate | string <date-time> (userCreationDate) YYYY-MM-DD'T'hh:mm:ss.fff'Z' Date account was created for a Client's user |
| userType | string (userType) ^[a-zA-Z0-9]{1,128}$ Client’s designation for a Client’s user |
| mfaPhone | string (mfaPhone) (Optional) The phone number that will be used to send the MFA link to via SMS |
| mfaEmail | string (mfaEmail) (Optional) The email address that will be used to send the MFA link |
| userAgent | string (userAgent) (Optional) Request header identifying information about the User's system |
| context | string (LoginRequestContext) Default: "LOGIN" Enum: "LOGIN" "PRE_AUTH" "GIFT_CARD" "LOYALTY" "COUPON" "FORM_FILL" "MARKETING" "PRE_LOGIN" |
OK
validation request failed
internal error
Production
Sandbox