Trusted Device (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

Create

Create Trusted Device Record

Request to Kount creating a Trusted Device record for the specified User and the Device associated to the Session

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

Kount's unique identifier for a Client

sessionId
required
string (sessionId) ^[\w-]{1,32}$

Device collection event identifier

userId
required
string (userId) .{1,255}$

Client’s unique identifier for a Client’s User

trustState
required
string (trustState)
Enum: "TRUSTED" "BANNED" "UNASSIGNED"

TRUSTED - Used to minimize friction for a User who has passed step-up authentication.
BANNED - Used to block access to an account for a specified Device
UNASSIGNED - Used to preserve a connection between a user and a device without a trust judgment

friendlyName
string (friendlyName) ^.{1,255}$

Human readable identifier for a Device. If not provided, a default name will be generated based on Device attributes

Responses

200

trusted Device created

400

validation request failed

404

resource not found

409

resource already exists in collection

500

internal error

post /trusted-device

Production

https://api.kount.com/trusted-device

Sandbox

https://api-sandbox.kount.com/trusted-device

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "clientId": "900900",
  • "sessionId": "d121ea2210434ffc8a90daff9cc97e76",
  • "userId": "meoyyd8za8jdmwfm",
  • "trustState": "TRUSTED",
  • "friendlyName": "Brad's Phone"
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "clientId": "900900",
  • "sessionId": "d121ea2210434ffc8a90daff9cc97e76",
  • "userId": "meoyyd8za8jdmwfm",
  • "deviceId": "7363b8ae6b2247b99f5d56fc81102254",
  • "trustState": "TRUSTED",
  • "friendlyName": "Brad's Phone",
  • "createdAt": "2018-02-22T01:02:03.123Z",
  • "lastUpdated": "2018-02-22T01:02:03.123Z"
}

Update

Update Trusted Device Record

Request to Kount updating a Trusted Device record for the specified User and the Device associated to the Session

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

Kount's unique identifier for a Client

sessionId
string (sessionId) ^[\w-]{1,32}$

Device collection event identifier

userId
required
string (userId) .{1,255}$

Client’s unique identifier for a Client’s User

trustState
required
string (trustState)
Enum: "TRUSTED" "BANNED" "UNASSIGNED"

TRUSTED - Used to minimize friction for a User who has passed step-up authentication.
BANNED - Used to block access to an account for a specified Device
UNASSIGNED - Used to preserve a connection between a user and a device without a trust judgment

friendlyName
string (friendlyName) ^.{1,255}$

Human readable identifier for a Device. If not provided, a default name will be generated based on Device attributes

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

Unique identifier for a Device

Responses

200
400

validation request failed

404

resource not found

500

internal error

put /trusted-device

Production

https://api.kount.com/trusted-device

Sandbox

https://api-sandbox.kount.com/trusted-device

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "clientId": "900900",
  • "sessionId": "d121ea2210434ffc8a90daff9cc97e76",
  • "userId": "meoyyd8za8jdmwfm",
  • "trustState": "TRUSTED",
  • "friendlyName": "Brad's Phone",
  • "deviceId": "7363b8ae6b2247b99f5d56fc81102254"
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "clientId": "900900",
  • "deviceId": "7363b8ae6b2247b99f5d56fc81102254",
  • "userId": "meoyyd8za8jdmwfm",
  • "trustState": "TRUSTED",
  • "friendlyName": "Brad's Phone",
  • "lastUpdated": "2018-02-22T01:02:03.123Z"
}

Read

Trust States by Device

Request to Kount returning an array of all Trusted Device user records for the Device specified

Authorizations:
path Parameters
deviceId
required
string (deviceId) ^[a-zA-Z0-9]{1, 32}$
Example: 7363b8ae6b2247b99f5d56fc81102254

Unique identifier for a Device

clientId
required
string (clientId) ^[a-zA-Z0-9]{1,64}$
Example: 900900

Kount's unique identifier for a Client

Responses

200
400

validation request failed

404

resource not found

500

internal error

get /trusted-device/devices/{deviceId}/clients/{clientId}/users

Production

https://api.kount.com/trusted-device/devices/{deviceId}/clients/{clientId}/users

Sandbox

https://api-sandbox.kount.com/trusted-device/devices/{deviceId}/clients/{clientId}/users

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "details":
    [
    ]
}

Trust States by Session

Request to Kount returning an array of all Trusted Device User records for the Session specified

Authorizations:
path Parameters
sessionId
required
string (sessionId) ^[\w-]{1,32}$
Example: d121ea2210434ffc8a90daff9cc97e76

Device collection event identifier

clientId
required
string (clientId) ^[a-zA-Z0-9]{1,64}$
Example: 900900

Kount's unique identifier for a Client

Responses

200
400

validation request failed

404

resource not found

500

internal error

get /trusted-device/sessions/{sessionId}/clients/{clientId}/users

Production

https://api.kount.com/trusted-device/sessions/{sessionId}/clients/{clientId}/users

Sandbox

https://api-sandbox.kount.com/trusted-device/sessions/{sessionId}/clients/{clientId}/users

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "details":
    [
    ]
}

Trust States by User

Request to Kount returning an array of all Trusted Device records for the User specified

Authorizations:
path Parameters
userId
required
string (userId) .{1,255}$
Example: meoyyd8za8jdmwfm

Client’s unique identifier for a Client’s User

clientId
required
string (clientId) ^[a-zA-Z0-9]{1,64}$
Example: 900900

Kount's unique identifier for a Client

Responses

200
400

validation request failed

404

resource not found

500

internal error

get /trusted-device/users/{userId}/clients/{clientId}/devices

Production

https://api.kount.com/trusted-device/users/{userId}/clients/{clientId}/devices

Sandbox

https://api-sandbox.kount.com/trusted-device/users/{userId}/clients/{clientId}/devices

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "details":
    [
    ]
}

Trust State by Session and User

Fetch a single Trusted Device records for the Session and User specified

Authorizations:
BearerAuth (Trusted Device)
path Parameters
sessionId
required
string (sessionId) ^[\w-]{1,32}$
Example: d121ea2210434ffc8a90daff9cc97e76

Device collection event identifier

userId
required
string (userId) .{1,255}$
Example: meoyyd8za8jdmwfm

Client’s unique identifier for a Client’s User

clientId
required
string (clientId) ^[a-zA-Z0-9]{1,64}$
Example: 900900

Kount's unique identifier for a Client

Responses

200
400

validation request failed

404

resource not found

500

internal error

get /trusted-device/sessions/{sessionId}/users/{userId}/clients/{clientId}

Production

https://api.kount.com/trusted-device/sessions/{sessionId}/users/{userId}/clients/{clientId}

Sandbox

https://api-sandbox.kount.com/trusted-device/sessions/{sessionId}/users/{userId}/clients/{clientId}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "details":
    [
    ]
}

Delete

Delete Trusted Device Record

Request to Kount deleting a Trusted Device record for the specified User and the Device associated to the Session

Authorizations:
path Parameters
sessionId
required
string (sessionId) ^[\w-]{1,32}$
Example: d121ea2210434ffc8a90daff9cc97e76

Device collection event identifier

userId
required
string (userId) .{1,255}$
Example: meoyyd8za8jdmwfm

Client’s unique identifier for a Client’s User

clientId
required
string (clientId) ^[a-zA-Z0-9]{1,64}$
Example: 900900

Kount's unique identifier for a Client

Responses

200
400

validation request failed

404

resource not found

500

internal error

delete /trusted-device/sessions/{sessionId}/users/{userId}/clients/{clientId}

Production

https://api.kount.com/trusted-device/sessions/{sessionId}/users/{userId}/clients/{clientId}

Sandbox

https://api-sandbox.kount.com/trusted-device/sessions/{sessionId}/users/{userId}/clients/{clientId}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "clientId": "900900",
  • "userId": "meoyyd8za8jdmwfm",
  • "deviceId": "7363b8ae6b2247b99f5d56fc81102254"
}

Delete Trusted Device Record by Device Id

Request to Kount deleting a Trusted Device record for the specified User and the Device associated to the Device Id

Authorizations:
path Parameters
deviceId
required
string (deviceId) ^[a-zA-Z0-9]{1, 32}$
Example: 7363b8ae6b2247b99f5d56fc81102254

Unique identifier for a Device

userId
required
string (userId) .{1,255}$
Example: meoyyd8za8jdmwfm

Client’s unique identifier for a Client’s User

clientId
required
string (clientId) ^[a-zA-Z0-9]{1,64}$
Example: 900900

Kount's unique identifier for a Client

Responses

200
400

validation request failed

404

resource not found

500

internal error

delete /trusted-device/devices/{deviceId}/users/{userId}/clients/{clientId}

Production

https://api.kount.com/trusted-device/devices/{deviceId}/users/{userId}/clients/{clientId}

Sandbox

https://api-sandbox.kount.com/trusted-device/devices/{deviceId}/users/{userId}/clients/{clientId}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "clientId": "900900",
  • "userId": "meoyyd8za8jdmwfm",
  • "deviceId": "7363b8ae6b2247b99f5d56fc81102254"
}