Login (1.0.0)

Download OpenAPI specification:Download

Authentication

BearerAuth

Security scheme type: HTTP
HTTP Authorization Scheme bearer
Bearer format "JWT"

Authorization

Security scheme type: API Key
Header parameter name: Authorization

Login Decision Request

Request to Kount triggering an evaluation of Client defined policies and returning a decision based on those policies

Authorizations:
Request Body schema: application/json
clientId
required
string (clientId) ^[a-zA-Z0-9]{1,64}$

Kount's unique identifier for a Client

loginUrl
string (loginUrl)

Webpage from which a Client’s user is attempting to log in

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

userAuthenticationStatus
string (userAuthenticationStatus) ^[a-zA-Z0-9]{1,64}$

Not validated/restricted, intended to indicate if user already completed step up authN

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

userCreationDate
string <date-time> (userCreationDate) YYYY-MM-DD'T'hh:mm:ss.fff'Z'

Date account was created for a Client's user

userIp
string <ipv4> (userIp)

User’s IPv4 address as identified by the Client

userType
string (userType) ^[a-zA-Z0-9]{1,128}$

Client’s designation for a Client’s user

Responses

200

successful request

400

validation request failed

500

internal error

post /login

Production

https://api.kount.com/login

Sandbox

https://api-sandbox.kount.com/login

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "clientId": "900900",
  • "sessionId": "d121ea2210434ffc8a90daff9cc97e76",
  • "userId": "meoyyd8za8jdmwfm",
  • "userAuthenticationStatus": "true",
  • "username": "meoyyd8za8jdmwfm",
  • "userPassword": "38401eb46f8fbb74c1846a5f47f68d83a9bef126b1d4143f886cd464323cdaab",
  • "userCreationDate": "2018-02-22T01:02:03.123Z",
  • "userIp": "208.75.113.3",
  • "userType": "VIP"
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "decision": "Allow",
  • "userProfile": "VIP",
  • "sessionId": "d121ea2210434ffc8a90daff9cc97e76",
  • "trustedDeviceState": "TRUSTED",
  • "trustedDeviceFriendlyName": "Brad's Phone",
  • "deviceId": "7363b8ae6b2247b99f5d56fc81102254",
  • "matchedToDevice": "string"
}