Documentation Powered by ReDoc

Trusted-Device (1.0.0)

Download OpenAPI specification:Download

Authentication

Bearer

Authentication JWT token, prefixed by Bearer: Bearer ${JWT}

Security Scheme Type API Key
Header parameter name: Authorization

TrustedDeviceService

Trusted-Device

Create Trusted Device Record

Authorizations:
Bearer
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-]{0,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,32}$

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

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "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 Trusted Device Record

Authorizations:
Bearer
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-]{0,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,32}$

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

Request samples

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

Response samples

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

Trust States by Device

Authorizations:
Bearer
path Parameters
deviceId
required
string

Unique identifier for a Device

clientId
required
string

Kount's unique identifier for a Client

Responses

Response samples

Content type
application/json
{
  • "details": [
    ]
}

Delete Trusted Device Record by DeviceId

Authorizations:
Bearer
path Parameters
deviceId
required
string

Unique identifier for a Device

userId
required
string

Client’s unique identifier for a Client’s User

clientId
required
string

Kount's unique identifier for a Client

Responses

Response samples

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

Trust States by Session

Authorizations:
Bearer
path Parameters
sessionId
required
string

Device collection event identifier

clientId
required
string

Kount's unique identifier for a Client

Responses

Response samples

Content type
application/json
{
  • "details": [
    ]
}

Trust State by Session and User

Authorizations:
Bearer
path Parameters
sessionId
required
string

Device collection event identifier

userId
required
string

Client’s unique identifier for a Client’s User

clientId
required
string

Kount's unique identifier for a Client

Responses

Response samples

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

Delete Trusted Device Record

Authorizations:
Bearer
path Parameters
sessionId
required
string

Device collection event identifier

userId
required
string

Client’s unique identifier for a Client’s User

clientId
required
string

Kount's unique identifier for a Client

Responses

Response samples

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

Trust States by User

Authorizations:
Bearer
path Parameters
userId
required
string

Client’s unique identifier for a Client’s User

clientId
required
string

Kount's unique identifier for a Client

Responses

Response samples

Content type
application/json
{
  • "details": [
    ]
}