Telemetry

This API calls allows you to retrieve meta data related to a user or specific transaction.

Introduction

Keyless is inevitably used as part of a wider authentication flow, whether it's an account recovery, login or step-up authentication. Integrators use this feature to collect additional insights around user transactions such as the result, errors and type of authentication and then leverage this data in their own systems for analytics, orchestration or fraud decisioning.

Telemetry data can be retrieved for specific transactions using the operationID. This ID is generated via the Mobile SDK by passing an operationInfo object to the EnrollConfig or AuthConfig following a specific transaction. This API also allows customers to search via the integrators External User ID i.e. the unique identifier the user is known by in your own system. For details on how to create and manage the mapping from External User ID to the Keyless ID head here.

Get all user authentications in the last 10 minutes

get

Get all user authentications in the last 10 minutes. This can be optionally filtered by operation id in order to return a specific transaction/authentication attempt.

Authorizations

X-Api-Key

Path parameters

userIdstring · Uppercase HEX stringRequired

The user id

Query parameters

operationIdstringOptional

Operation id to filter the results

Responses

200

User authentications

application/json

401

Unauthorized request, the request can't be processed unless you provide a valid authentication method

application/json

404

User not found

application/json

get

/users/{userId}/authentications

HTTPcURLJavaScriptPython

GET /v2/users/{userId}/authentications HTTP/1.1
Host: 
X-Api-Key: YOUR_API_KEY
Accept: */*

{
  "page": {
    "number": 1,
    "totalElements": 1,
    "totalPages": 1,
    "size": 1
  },
  "content": [
    {
      "userId": "0123456789ABCDEF",
      "authentications": [
        {
          "createdAt": "text",
          "result": "APPROVED",
          "errorCode": 1,
          "operationId": "text",
          "deviceId": "text",
          "authType": "biom"
        }
      ]
    }
  ]
}

Get all user authentications in the last 10 minutes using the External User ID

get

Get all user authentications in the last 10 minutes using the External User ID (i.e. the unique identifier the user is identified by in your own system). This can be optionally filtered by operation id in order to return a specific transaction/authentication attempt.

Authorizations

X-Api-Key

Path parameters

externalUserIdstringRequired

The customer-meaningful user id. Case-sensitive

Query parameters

operationIdstringOptional

Operation id to filter the results

Responses

200

External user authentications

application/json

401

Unauthorized request, the request can't be processed unless you provide a valid authentication method

application/json

404

External user not found

application/json

get

/external-users/{externalUserId}/authentications

HTTPcURLJavaScriptPython

GET /v2/external-users/{externalUserId}/authentications HTTP/1.1
Host: 
X-Api-Key: YOUR_API_KEY
Accept: */*

{
  "page": {
    "number": 1,
    "totalElements": 1,
    "totalPages": 1,
    "size": 1
  },
  "content": [
    {
      "externalUserId": "text",
      "authentications": [
        {
          "createdAt": "text",
          "result": "APPROVED",
          "errorCode": 1,
          "operationId": "text",
          "deviceId": "text",
          "authType": "biom"
        }
      ]
    }
  ]
}