Documentation Powered by ReDoc

Events (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

EventsService

EVENTS

Provide information data for a given event.

Authorizations:
Bearer
Request Body schema: application/json
object (v1FailedAttemptEvent)
object (v1ChallengeOutcomeEvent)

Responses

Request samples

Content type
application/json
{
  • "failedAttempt": {
    },
  • "challengeOutcome": {
    }
}

Response samples

Content type
application/json
{ }

CHALLENGEOUTCOME

Provide information data for a given event.

Authorizations:
Bearer
Request Body schema: application/json
inquiryId
string (inquiryId)

Customer supplied identifier used to track state across the “inquiry” or customer journey

deviceSessionId
string (deviceSessionId) ^[\w-]{0,32}$

Device collection event identifier

decisionCorrelationId
string <uuid> (decisionCorrelationId) ^[0-9A-F]{8}-[0-9A-F]{4}-4[0-9A-F]{3}-[89AB][...

The unique identifier 'correlationId' from the original decision response from the Kount API

challengeType
string (challengeType)
Enum: "Captcha" "Captcha2" "Puzzle" "SecretQuestion" "EmailLink" "EmailPIN" "TextPIN" "TextLink" "MFAAppGoogle" "MFAAppDuo" "MFAAppiOS" "MFAAppAuthy" "MFAAppMicrosoft" "MFAAppLastPass" "MFAAppOther"

The type of challenge sent to the User's Client

challengeStatus
string (challengeStatus)
Enum: "Success" "Failed"

Represents the success or failure result of the challenge

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

Device collection event identifier

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

Device collection event identifier

failureType
string (failureType)
Enum: "TimedOut" "IncorrectResponse" "ExpiredSession" "ExpiredLink" "InvalidLink" "InvalidData" "MissingData"

If challenge is failed, the reason for the failure

Responses

Request samples

Content type
application/json
{
  • "inquiryId": "string",
  • "deviceSessionId": "d121ea2210434ffc8a90daff9cc97e76",
  • "decisionCorrelationId": "3438ac3c-37eb-4902-adef-ed16b4431030",
  • "challengeType": "Captcha",
  • "challengeStatus": "Success",
  • "sentTimestamp": "2024-02-22T01:02:03.123Z",
  • "completedTimestamp": "2024-02-22T01:02:03.123Z",
  • "failureType": "TimedOut"
}

Response samples

Content type
application/json
{ }

FAILEDATTEMPT

Provide information data for a given event.

Authorizations:
Bearer
Request Body schema: application/json
inquiryId
string (inquiryId)

Customer supplied identifier used to track state across the “inquiry” or customer journey

channel
string (channel)

Unique identifier of the website or app and/or product where the inquiry originated

deviceSessionId
string (deviceSessionId) ^[\w-]{0,32}$

Device collection event identifier

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

object (eventsorchestratorv1Person)
object (eventsorchestratorv1Account)

Responses

Request samples

Content type
application/json
{
  • "inquiryId": "string",
  • "channel": "ACME_IOS_APP",
  • "deviceSessionId": "d121ea2210434ffc8a90daff9cc97e76",
  • "userIp": "192.168.0.1",
  • "loginUrl": "http://www.example.com/login",
  • "person": {
    },
  • "account": {
    }
}

Response samples

Content type
application/json
{ }