Shell HTTP Node.JS JavaScript Ruby Python Java Go

Client Interaction Events v0.5.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

The Client Interaction Events API allows Apiture Digital Banking client applications to inform the Apiture Digital Banking platform of client interaction activity, such as starting a new (UI) client session, visiting pages or using application features, or invoking specific client actions (such as clicking on a button or menu action).

A client interaction event is an abstraction (representation) of such activity performed in a client application. Each kind of event has an event type. Related events are also organized into categories. Event types and categories may be specific to one client application or they may be generic and apply to more than one client application. Each event type belongs to one category. There can be many event messages over time for each event type.

An event message is a concrete data representation of an event that has occurred. The message contains event metadata (such as a unique event ID, timestamp, etc.) and the event's specific, associated data payload. Each event message is defined with the clientEventMessageItem schema, which includes the metadata. The clientEventMessageItem object has a data object whose value depends on the clientEventMessageItem.type. The data value is constrained to the schema whose name is derived from the type. The data event message schema name is the event type name with the suffix EventSchema. For example, the data value in a client event message with type of clientSessionStarted is defined by clientSessionStartedEventSchema.

Client applications may use the createClientInteractionEvent operation to register client-side events. See the table below for a list of such events the client may send.

All operations in this API require an authenticated/authorized user. The user may be a banking customer (for digital banking client applications) or a financial institution operator/admin (for administrative applications).

Event Types by Category

Events are organized into categories, as follows:

Event category Event type Event Message Schema
contentInteractions clicked clickedEventSchema
screenInteractions screenViewed screenViewedEventSchema
sessions clientSessionStarted clientSessionStartedEventSchema
sessions userEngaged userEngagedEventSchema

Download OpenAPI Definition (YAML)

Base URLs:

Terms of service

Email: Apiture Web: Apiture

License: Apiture API License

Authentication

  • API Key (apiKey)
    • header parameter: API-Key
    • API Key based client identification. See details at Secure Access.

Client Interaction Events

Banking Client Interaction Events

createClientInteractionEvent

Code samples

# You can also use wget
curl -X POST https://api.apiture.com/clients/clientInteractionEvents \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Institution-Id: TIBURON' \
  -H 'API-Key: API_KEY'


POST https://api.apiture.com/clients/clientInteractionEvents HTTP/1.1
Host: api.apiture.com
Content-Type: application/json
Accept: application/json
Institution-Id: TIBURON


const fetch = require('node-fetch');
const inputBody = '{
  "page_url": "https://www.banking.tiburon-cf.com",
  "referrer_url": "http://www.tiburon-cf.com",
  "title": "Open a new Account at Tiburon Community Financial",
  "screenResolution": {
    "width": 1792,
    "height": 1120
  },
  "sessionId": "7859270edbe87b9f969c",
  "engagementDuration": 180000,
  "sessionNumber": 0,
  "data": {},
  "type": "clientSessionStarted",
  "category": "sessions",
  "language": "en-US",
  "clientId": "056c0a5d954897e4dc1a",
  "channel": "web"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Institution-Id':'TIBURON',
  'API-Key':'API_KEY'

};

fetch('https://api.apiture.com/clients/clientInteractionEvents',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


var headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Institution-Id':'TIBURON',
  'API-Key':'API_KEY'

};

$.ajax({
  url: 'https://api.apiture.com/clients/clientInteractionEvents',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Institution-Id' => 'TIBURON',
  'API-Key' => 'API_KEY'
}

result = RestClient.post 'https://api.apiture.com/clients/clientInteractionEvents',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Institution-Id': 'TIBURON',
  'API-Key': 'API_KEY'
}

r = requests.post('https://api.apiture.com/clients/clientInteractionEvents', params={

}, headers = headers)

print r.json()


URL obj = new URL("https://api.apiture.com/clients/clientInteractionEvents");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Institution-Id": []string{"TIBURON"},
        "API-Key": []string{"API_KEY"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.apiture.com/clients/clientInteractionEvents", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Create a new client interaction event

POST https://api.apiture.com/clients/clientInteractionEvents

Create a new client interaction event within the client interaction events collection. This operation usually returns a 204 response so that the client does not block.

Body parameter

{
  "page_url": "https://www.banking.tiburon-cf.com",
  "referrer_url": "http://www.tiburon-cf.com",
  "title": "Open a new Account at Tiburon Community Financial",
  "screenResolution": {
    "width": 1792,
    "height": 1120
  },
  "sessionId": "7859270edbe87b9f969c",
  "engagementDuration": 180000,
  "sessionNumber": 0,
  "data": {},
  "type": "clientSessionStarted",
  "category": "sessions",
  "language": "en-US",
  "clientId": "056c0a5d954897e4dc1a",
  "channel": "web"
}

Parameters

ParameterDescription
Institution-Id
in: header
 institutionId (required)
The unique identifier of the financial institution.
minLength: 2
maxLength: 8
pattern: "^[A-Z0-9_]{2,8}$"
body newClientInteractionEvent (required)
The data necessary to create a new client interaction event.

Example responses

201 Response

{
  "page_url": "https://www.banking.tiburon-cf.com",
  "referrer_url": "http://www.tiburon-cf.com",
  "title": "Open a new Account at Tiburon Community Financial",
  "screenResolution": {
    "width": 1792,
    "height": 1120
  },
  "sessionId": "7859270edbe87b9f969c",
  "engagementDuration": 180000,
  "sessionNumber": 7,
  "data": {},
  "id": "d073754cd6ccd22146b0",
  "occurredAt": "2024-01-25T09:34:26.375Z",
  "userId": "philduciary_2298",
  "language": "en-US",
  "type": "clientSessionStarted",
  "category": "sessions",
  "clientId": "056c0a5d954897e4dc1a",
  "channel": "web"
}

Responses

StatusDescription
201 Created
Created. The client interaction event was accepted and recorded.
Schema: clientInteractionEvent
204 No Content
No Content. The client interaction event was accepted and recorded but the service returned no response.
StatusDescription
400 Bad Request

Bad Request. The request body, request headers, and/or query parameters are not well-formed.

This problem responsemay have one of the following type values:

Schema: Inline
StatusDescription
401 Unauthorized

Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given.

This problem responsemay have one of the following type values:

Schema: Inline
StatusDescription
403 Forbidden

Forbidden. The authenticated caller is not authorized to perform the requested operation.

This problem responsemay have one of the following type values:

Schema: Inline
StatusDescription
422 Unprocessable Entity

Unprocessable Entity. The request body and/or query parameters were well-formed but otherwise invalid.

This problem responsemay have one of the following type values:

Schema: Inline
StatusDescription
429 Too Many Requests

Too Many Requests. The client has sent too many requests in a given amount of time.

This problem responsemay have one of the following type values:

Schema: Inline
StatusDescription
4XX Unknown
Client Request Problem. The client request had a problem not listed under another specific 400-level HTTP response code. View the detail in the problem response for additional details.
Schema: Inline
StatusDescription
5XX Unknown
Server Problem. The server encountered a problem not listed under another specific 500-level HTTP response code. View the detail in the problem response for additional details.
Schema: Inline

Response Schema

Status Code 400

Property Name Description
Problem Response (v0.4.1) object
API problem or error response, as per RFC 9457 application/problem+json.
» type string(uri-reference)
A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank".
maxLength: 2048
» title string(text)
A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type.
maxLength: 120
» status integer(int32)
The HTTP status code for this occurrence of the problem.
minimum: 100
maximum: 599
» detail string(text)
A human-readable explanation specific to this occurrence of the problem.
maxLength: 256
» instance string(uri-reference)
A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment
maxLength: 2048
» id readOnlyResourceId
The unique identifier for this problem. This is an immutable opaque string.
minLength: 6
maxLength: 48
pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt readOnlyTimestamp(date-time)
The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC.
minLength: 20
maxLength: 30
» problems array: [apiProblem]
Optional root-causes if there are multiple problems in the request or API call processing.
maxItems: 128
» attributes object
Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 401

Property Name Description
Problem Response (v0.4.1) object
API problem or error response, as per RFC 9457 application/problem+json.
» type string(uri-reference)
A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank".
maxLength: 2048
» title string(text)
A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type.
maxLength: 120
» status integer(int32)
The HTTP status code for this occurrence of the problem.
minimum: 100
maximum: 599
» detail string(text)
A human-readable explanation specific to this occurrence of the problem.
maxLength: 256
» instance string(uri-reference)
A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment
maxLength: 2048
» id readOnlyResourceId
The unique identifier for this problem. This is an immutable opaque string.
minLength: 6
maxLength: 48
pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt readOnlyTimestamp(date-time)
The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC.
minLength: 20
maxLength: 30
» problems array: [apiProblem]
Optional root-causes if there are multiple problems in the request or API call processing.
maxItems: 128
» attributes object
Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 403

Property Name Description
Problem Response (v0.4.1) object
API problem or error response, as per RFC 9457 application/problem+json.
» type string(uri-reference)
A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank".
maxLength: 2048
» title string(text)
A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type.
maxLength: 120
» status integer(int32)
The HTTP status code for this occurrence of the problem.
minimum: 100
maximum: 599
» detail string(text)
A human-readable explanation specific to this occurrence of the problem.
maxLength: 256
» instance string(uri-reference)
A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment
maxLength: 2048
» id readOnlyResourceId
The unique identifier for this problem. This is an immutable opaque string.
minLength: 6
maxLength: 48
pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt readOnlyTimestamp(date-time)
The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC.
minLength: 20
maxLength: 30
» problems array: [apiProblem]
Optional root-causes if there are multiple problems in the request or API call processing.
maxItems: 128
» attributes object
Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 422

Property Name Description
Problem Response (v0.4.1) object
API problem or error response, as per RFC 9457 application/problem+json.
» type string(uri-reference)
A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank".
maxLength: 2048
» title string(text)
A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type.
maxLength: 120
» status integer(int32)
The HTTP status code for this occurrence of the problem.
minimum: 100
maximum: 599
» detail string(text)
A human-readable explanation specific to this occurrence of the problem.
maxLength: 256
» instance string(uri-reference)
A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment
maxLength: 2048
» id readOnlyResourceId
The unique identifier for this problem. This is an immutable opaque string.
minLength: 6
maxLength: 48
pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt readOnlyTimestamp(date-time)
The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC.
minLength: 20
maxLength: 30
» problems array: [apiProblem]
Optional root-causes if there are multiple problems in the request or API call processing.
maxItems: 128
» attributes object
Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 429

Property Name Description
Problem Response (v0.4.1) object
API problem or error response, as per RFC 9457 application/problem+json.
» type string(uri-reference)
A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank".
maxLength: 2048
» title string(text)
A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type.
maxLength: 120
» status integer(int32)
The HTTP status code for this occurrence of the problem.
minimum: 100
maximum: 599
» detail string(text)
A human-readable explanation specific to this occurrence of the problem.
maxLength: 256
» instance string(uri-reference)
A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment
maxLength: 2048
» id readOnlyResourceId
The unique identifier for this problem. This is an immutable opaque string.
minLength: 6
maxLength: 48
pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt readOnlyTimestamp(date-time)
The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC.
minLength: 20
maxLength: 30
» problems array: [apiProblem]
Optional root-causes if there are multiple problems in the request or API call processing.
maxItems: 128
» attributes object
Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 4XX

Property Name Description
Problem Response (v0.4.1) object
API problem or error response, as per RFC 9457 application/problem+json.
» type string(uri-reference)
A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank".
maxLength: 2048
» title string(text)
A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type.
maxLength: 120
» status integer(int32)
The HTTP status code for this occurrence of the problem.
minimum: 100
maximum: 599
» detail string(text)
A human-readable explanation specific to this occurrence of the problem.
maxLength: 256
» instance string(uri-reference)
A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment
maxLength: 2048
» id readOnlyResourceId
The unique identifier for this problem. This is an immutable opaque string.
minLength: 6
maxLength: 48
pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt readOnlyTimestamp(date-time)
The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC.
minLength: 20
maxLength: 30
» problems array: [apiProblem]
Optional root-causes if there are multiple problems in the request or API call processing.
maxItems: 128
» attributes object
Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 5XX

Property Name Description
Problem Response (v0.4.1) object
API problem or error response, as per RFC 9457 application/problem+json.
» type string(uri-reference)
A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank".
maxLength: 2048
» title string(text)
A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type.
maxLength: 120
» status integer(int32)
The HTTP status code for this occurrence of the problem.
minimum: 100
maximum: 599
» detail string(text)
A human-readable explanation specific to this occurrence of the problem.
maxLength: 256
» instance string(uri-reference)
A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment
maxLength: 2048
» id readOnlyResourceId
The unique identifier for this problem. This is an immutable opaque string.
minLength: 6
maxLength: 48
pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt readOnlyTimestamp(date-time)
The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC.
minLength: 20
maxLength: 30
» problems array: [apiProblem]
Optional root-causes if there are multiple problems in the request or API call processing.
maxItems: 128
» attributes object
Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Schemas

abstractClientInteractionEventDataSchema

{}

Abstract Client Interaction Event Data Schema (v0.1.1)

Abstract schema used to define other event message data object schemas.

Properties

NameDescription
Abstract Client Interaction Event Data Schema (v0.1.1) object
Abstract schema used to define other event message data object schemas.

apiProblem

{
  "id": "3fbad566-be86-4b22-9ba6-3ca99fdc0799",
  "type": "https://production.api.apiture.com/errors/accountNotFound/v1.0.0",
  "title": "Account Not Found",
  "status": 422,
  "occurredAt": "2022-04-25T12:42:21.375Z",
  "detail": "No account exists at the given account_url",
  "instance": "https://production.api.apiture.com/banking/transfers/bb709151-575041fcd617"
}

API Problem (v1.2.1)

API problem or error, as per RFC 7807 application/problem+json.

Properties

NameDescription
API Problem (v1.2.1) object
API problem or error, as per RFC 7807 application/problem+json.
type string(uri-reference)
A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank".
format: uri-reference
maxLength: 2048
title string(text)
A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type.
format: text
maxLength: 120
status integer(int32)
The HTTP status code for this occurrence of the problem.
format: int32
minimum: 100
maximum: 599
detail string(text)
A human-readable explanation specific to this occurrence of the problem.
format: text
maxLength: 256
instance string(uri-reference)
A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment
format: uri-reference
maxLength: 2048
id readOnlyResourceId
The unique identifier for this problem. This is an immutable opaque string.
read-only
minLength: 6
maxLength: 48
pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
occurredAt readOnlyTimestamp(date-time)
The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC.
read-only
format: date-time
minLength: 20
maxLength: 30
problems array: [apiProblem]
Optional root-causes if there are multiple problems in the request or API call processing.
maxItems: 128
items: object

challengeFactor

{
  "type": "sms",
  "labels": [
    "9876"
  ]
}

Challenge Factor (v1.2.1)

A challenge factor. See requiredIdentityChallenge for multiple examples.

Properties

NameDescription
Challenge Factor (v1.2.1) object
A challenge factor. See requiredIdentityChallenge for multiple examples.
id challengeFactorId
The ID of an a challenge factor. This ID is unique within the challenge factors associated with a challenge. The client should pass this id value as the factorId when starting or verifying a challenge factor.

Note: The id will become required in a future update to this schema.
minLength: 3
maxLength: 48
pattern: "^[-a-zA-Z0-9$_]{3,48}$"

type challengeFactorType (required)

The name of challenge factor.

challengeFactorType strings may have one of the following enumerated values:

ValueDescription
smsSMS:

One-time passcode sent to the primary mobile phone number
emailEmail:

One-time passcode sent to the primary email address
voiceVoice:

One-time passcode communicated via automated voice phone call
authenticatorTokenauthenticator Token:

One-time passcode issued by a pre-registered hardware device, such as a token key fob, or an authenticator app
securityQuestionsSecurity Questions:

Prompt with the user's security questions registered with their security profile

enum values: sms, email, voice, securityQuestions, authenticatorToken
labels array: [string]
A list of text label which identifies the channel(s) through which the user completes the challenge. For an sms or voice challenge, the only label item is the last four digits of the corresponding phone number. For an email challenge, each label is the masked email address.
minItems: 1
maxItems: 4
items: string(text)
» format: text
» maxLength: 300
securityQuestions challengeSecurityQuestions
Describes a securityQuestions challenge. This is omitted if the challenge type is not securityQuestions.

challengeFactorId

"string"

Challenge Factor ID (v1.0.0)

The ID of an a challenge factor. This ID is unique within the factors offered with a challenge.

type: string


minLength: 3
maxLength: 48
pattern: "^[-a-zA-Z0-9$_]{3,48}$"

challengeFactorType

"sms"

Challenge Factor Type (v1.0.0)

The name of challenge factor.

challengeFactorType strings may have one of the following enumerated values:

ValueDescription
smsSMS:

One-time passcode sent to the primary mobile phone number
emailEmail:

One-time passcode sent to the primary email address
voiceVoice:

One-time passcode communicated via automated voice phone call
authenticatorTokenauthenticator Token:

One-time passcode issued by a pre-registered hardware device, such as a token key fob, or an authenticator app
securityQuestionsSecurity Questions:

Prompt with the user's security questions registered with their security profile

type: string


enum values: sms, email, voice, securityQuestions, authenticatorToken

challengeOperationId

"string"

Challenge Operation ID (v1.0.1)

The ID of an operation/action for which the user must verify their identity via an identity challenge. This is passed when starting a challenge factor or when validating the identity challenge responses.

type: string


minLength: 6
maxLength: 48
pattern: "^[-a-zA-Z0-9$_]{6,48}$"

challengePromptId

"string"

Challenge Prompt ID (v1.0.0)

The unique ID of a prompt (such as a security question) in a challenge factor.

type: string


minLength: 1
maxLength: 48
pattern: "^[-_:.~$a-zA-Z0-9]+$"

challengeSecurityQuestion

{
  "id": "74699fa628911e762ea5",
  "prompt": "What is your mother's maiden name?"
}

Challenge Security Question (v1.0.1)

A single security question within the questions array of the challengeSecurityQuestions

Properties

NameDescription
Challenge Security Question (v1.0.1) object
A single security question within the questions array of the challengeSecurityQuestions
id challengePromptId (required)
The unique ID of security question prompt. This should be included in the challengeVerification response as the promptId.
minLength: 1
maxLength: 48
pattern: "^[-_:.~$a-zA-Z0-9]+$"
prompt string(text) (required)
The text prompt of this security question.
format: text
maxLength: 80

challengeSecurityQuestions

{
  "questions": [
    {
      "id": "q1",
      "prompt": "What is your mother's maiden name?"
    },
    {
      "id": "q4",
      "prompt": "What is your high school's name?"
    },
    {
      "id": "q9",
      "prompt": "What is the name of your first pet?"
    }
  ]
}

Challenge Security Questions (v1.0.1)

Describes a securityQuestions challenge. This is omitted if the challenge type is not securityQuestions.

Properties

NameDescription
Challenge Security Questions (v1.0.1) object
Describes a securityQuestions challenge. This is omitted if the challenge type is not securityQuestions.
questions array: [challengeSecurityQuestion] (required)
The array of security questions.
minItems: 1
maxItems: 8
items: object

clickedEventSchema

{
  "link": {
    "class": "action enabled",
    "id": "submit-wire-transfer",
    "url": "https://www.example.com/wire-transfer-confirmation"
  }
}

Clicked Event Schema (v0.2.1)

Payload for client interaction event messages triggered when the user clicks on a link, menu item, button, or other clickable control. This schema defines the data object for event messages with category contentInteractions and event message type of clicked.

Properties

NameDescription
Clicked Event Schema (v0.2.1) object
Payload for client interaction event messages triggered when the user clicks on a link, menu item, button, or other clickable control. This schema defines the data object for event messages with category contentInteractions and event message type of clicked.
Unevaluated Properties: false
link clientInteractionEventLink (required)
A link involved in a client interaction.

The scheme and '://' separator and host from the url constitute the link's origin.

clientEventMessageItem

{
  "page_url": "https://www.banking.tiburon-cf.com",
  "referrer_url": "http://www.tiburon-cf.com",
  "title": "Open a new Account at Tiburon Community Financial",
  "screenResolution": {
    "width": 1792,
    "height": 1120
  },
  "sessionId": "2024-01-25T10:44:01.375Z",
  "engagementDuration": 180000,
  "sessionNumber": 7,
  "data": {},
  "id": "d073754cd6ccd22146b0",
  "type": "clientSessionStarted",
  "category": "sessions",
  "occurredAt": "2024-01-25T09:34:26.375Z",
  "clientId": "056c0a5d954897e4dc1a",
  "channel": "web"
}

Client Event Message Item (v1.1.0)

A data record representing a specific client application activity or action performed by a user. This conveys:

  • who did something (userId)
  • what they did (type, category),
  • when they did it (occurredAt),
  • client application state (language, page_url, referrer_url, title, screenResolution)
  • A unique id for this client event
  • additional data that is specific to the activity type.

Properties

NameDescription
Client Event Message Item (v1.1.0) object

A data record representing a specific client application activity or action performed by a user. This conveys:

  • who did something (userId)
  • what they did (type, category),
  • when they did it (occurredAt),
  • client application state (language, page_url, referrer_url, title, screenResolution)
  • A unique id for this client event
  • additional data that is specific to the activity type.
language string
The language-locale code of the client, such as 'en-US' or 'en'. Normally, this is the language code and optional region/locale code, without weights or punctuation, of the first value in the Accept-Language header that the browser manages for HTTP requests.
minLength: 1
maxLength: 16
pattern: "^([a-z]{2,3}(?:-[A-Z]{2,3}(?:-[a-zA-Z0-9]{2,8})?)?)$"
clientId mutableResourceId (required)
A value that uniquely identifies the end user/device/client application combination.
minLength: 1
maxLength: 55
pattern: "^[-_:.~$a-zA-Z0-9]{1,55}$"
channel clientInteractionEventChannel (required)
The client application's delivery channel.
enum values: unknown, web, mobile, other
page_url string(uri)
The complete URL of the current application page, including query parameters and anchor.
format: uri
maxLength: 2048
referrer_url string(uri)
The URL of referrer (previous page), including query parameters and anchor, if any. Omitted if not known or there is no previous page (no referrer).
format: uri
maxLength: 2048
title string(text)
The title of the current page, if known.
format: text
maxLength: 100
screenResolution clientEventScreenResolution
The screen resolution of the current client screen/display, in a width x height, in pixels. Present only if known.
userId mutableResourceId
A unique ID of the interactive user who is using the client application.
minLength: 1
maxLength: 55
pattern: "^[-_:.~$a-zA-Z0-9]{1,55}$"
sessionId mutableResourceId (required)
A opaque string which identifies the user's session. Session IDs are not required to be unique across users or across time.
minLength: 1
maxLength: 55
pattern: "^[-_:.~$a-zA-Z0-9]{1,55}$"
sessionNumber integer(int32) (required)
The sequential number of this user's renewed session. The first session (for example, after authenticating) is 0. When the client extends the session when the session times out, the client should increment this number.
format: int32
minimum: 0
maximum: 10000
engagementDuration integer(int32)
The total time the end user has been engaged with the client application, in milliseconds. The maximum, 172,800,000ms, is 48 hours of continuous engagement.
format: int32
minimum: 0
maximum: 172800000
type clientInteractionEventMessageType (required)
The type of this event. This is the key into the set of event types. This is a lowerCamelCase string.
minLength: 4
maxLength: 48
pattern: "^[a-z][a-zA-Z0-9]{3,47}$"
category clientInteractionEventMessageCategory (required)
An identifier for the category of the event. Multiple message types can belong to a category. This is a lowerCamelCase string.
minLength: 4
maxLength: 40
pattern: "^[a-z][a-zA-Z0-9]{3,39}$"
data abstractClientInteractionEventDataSchema (required)
Additional type-specific data properties for this event. For example, the data value in a client event message with type of clientSessionStarted is defined by clientSessionStartedEventSchema.
id resourceId (required)
The unique identifier for this event. This is an immutable opaque string.
minLength: 6
maxLength: 48
pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
occurredAt readOnlyTimestamp(date-time) (required)
The date and time when the event occurred.
read-only
format: date-time
minLength: 20
maxLength: 30

clientEventScreenResolution

{
  "width": 100,
  "height": 100
}

Client Event Screen Resolution (v1.0.0)

The Screen Resolution associated with a client event. These values are typically derived in a client with the Javascript expressions, window.innerWidth and window.innerHeight.

Properties

NameDescription
Client Event Screen Resolution (v1.0.0) object
The Screen Resolution associated with a client event. These values are typically derived in a client with the Javascript expressions, window.innerWidth and window.innerHeight.
width integer(int32) (required)
The screen width, in pixels.
format: int32
minimum: 100
maximum: 100000
height integer(int32) (required)
The screen height, in pixels.
format: int32
minimum: 100
maximum: 100000

clientInteractionEvent

{
  "page_url": "https://www.banking.tiburon-cf.com",
  "referrer_url": "http://www.tiburon-cf.com",
  "title": "Open a new Account at Tiburon Community Financial",
  "screenResolution": {
    "width": 1792,
    "height": 1120
  },
  "sessionId": "7859270edbe87b9f969c",
  "engagementDuration": 180000,
  "sessionNumber": 7,
  "data": {},
  "id": "d073754cd6ccd22146b0",
  "occurredAt": "2024-01-25T09:34:26.375Z",
  "userId": "philduciary_2298",
  "language": "en-US",
  "type": "clientSessionStarted",
  "category": "sessions",
  "clientId": "056c0a5d954897e4dc1a",
  "channel": "web"
}

Client Interaction Event (v1.1.0)

Representation of a client interaction event resource.

Properties

NameDescription
Client Interaction Event (v1.1.0) object
Representation of a client interaction event resource.
language string (required)
The language-locale code of the client, such as 'en-US' or 'en'. Normally, this is the language code and optional region/locale code, without weights or punctuation, of the first value in the Accept-Language header that the browser manages for HTTP requests.
minLength: 1
maxLength: 16
pattern: "^([a-z]{2,3}(?:-[A-Z]{2,3}(?:-[a-zA-Z0-9]{2,8})?)?)$"
clientId mutableResourceId (required)
A value that uniquely identifies the end user/device/client application combination.
minLength: 1
maxLength: 55
pattern: "^[-_:.~$a-zA-Z0-9]{1,55}$"
channel clientInteractionEventChannel
The client application's delivery channel.
enum values: unknown, web, mobile, other
page_url string(uri) (required)
The complete URL of the current application page, including query parameters and anchor.
format: uri
maxLength: 2048
referrer_url string(uri)
The URL of referrer (previous page), including query parameters and anchor, if any. Omitted if not known or there is no previous page (no referrer).
format: uri
maxLength: 2048
title string(text) (required)
The title of the current page, if known.
format: text
maxLength: 100
screenResolution clientEventScreenResolution
The screen resolution of the current client screen/display, in a width x height, in pixels. Present only if known.
userId mutableResourceId
A unique ID of the interactive user who is using the client application.
minLength: 1
maxLength: 55
pattern: "^[-_:.~$a-zA-Z0-9]{1,55}$"
sessionId mutableResourceId (required)
A opaque string which identifies the user's session. Session IDs are not required to be unique across users or across time.
minLength: 1
maxLength: 55
pattern: "^[-_:.~$a-zA-Z0-9]{1,55}$"
sessionNumber integer(int32) (required)
The sequential number of this user's renewed session. The first session (for example, after authenticating) is 0. When the client extends the session when the session times out, the client should increment this number.
format: int32
minimum: 0
maximum: 10000
engagementDuration integer(int32)
The total time the end user has been engaged with the client application, in milliseconds. The maximum, 172,800,000ms, is 48 hours of continuous engagement.
format: int32
minimum: 0
maximum: 172800000
type clientInteractionEventMessageType (required)
The type of this event. This is the key into the set of event types. This is a lowerCamelCase string.
minLength: 4
maxLength: 48
pattern: "^[a-z][a-zA-Z0-9]{3,47}$"
category clientInteractionEventMessageCategory (required)
An identifier for the category of the event. Multiple message types can belong to a category. This is a lowerCamelCase string.
minLength: 4
maxLength: 40
pattern: "^[a-z][a-zA-Z0-9]{3,39}$"
data abstractClientInteractionEventDataSchema
Additional type-specific data properties for this event. For example, the data value in a client event message with type of clientSessionStarted is defined by clientSessionStartedEventSchema.
id readOnlyResourceId (required)
The unique identifier for this client interaction event resource. This is an immutable opaque string.
read-only
minLength: 6
maxLength: 48
pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
occurredAt readOnlyTimestamp(date-time)
The date and time when the event occurred.
read-only
format: date-time
minLength: 20
maxLength: 30

clientInteractionEventChannel

"unknown"

Client Interaction Event Channel (v1.0.0)

The client's application channel.

clientInteractionEventChannel strings may have one of the following enumerated values:

ValueDescription
unknownUnknown:

The client does not know the channel
webWeb:

The client is a web application
mobileMobile:

The client is a mobile application
otherOther:

The client is delivered via some other channel

type: string


enum values: unknown, web, mobile, other

clientInteractionEventItem

{
  "page_url": "https://www.banking.tiburon-cf.com",
  "referrer_url": "http://www.tiburon-cf.com",
  "title": "Open a new Account at Tiburon Community Financial",
  "screenResolution": {
    "width": 1792,
    "height": 1120
  },
  "sessionId": "7859270edbe87b9f969c",
  "engagementDuration": 180000,
  "sessionNumber": 7,
  "data": {},
  "id": "d073754cd6ccd22146b0",
  "occurredAt": "2024-01-25T09:34:26.375Z",
  "userId": "philduciary_2298",
  "language": "en-US",
  "type": "clientSessionStarted",
  "category": "sessions",
  "clientId": "056c0a5d954897e4dc1a",
  "channel": "web"
}

Client Interaction Event Item (v1.1.0)

Summary representation of a client interaction event resource within a list.

Properties

NameDescription
Client Interaction Event Item (v1.1.0) object
Summary representation of a client interaction event resource within a list.
language string (required)
The language-locale code of the client, such as 'en-US' or 'en'. Normally, this is the language code and optional region/locale code, without weights or punctuation, of the first value in the Accept-Language header that the browser manages for HTTP requests.
minLength: 1
maxLength: 16
pattern: "^([a-z]{2,3}(?:-[A-Z]{2,3}(?:-[a-zA-Z0-9]{2,8})?)?)$"
clientId mutableResourceId (required)
A value that uniquely identifies the end user/device/client application combination.
minLength: 1
maxLength: 55
pattern: "^[-_:.~$a-zA-Z0-9]{1,55}$"
channel clientInteractionEventChannel
The client application's delivery channel.
enum values: unknown, web, mobile, other
page_url string(uri) (required)
The complete URL of the current application page, including query parameters and anchor.
format: uri
maxLength: 2048
referrer_url string(uri)
The URL of referrer (previous page), including query parameters and anchor, if any. Omitted if not known or there is no previous page (no referrer).
format: uri
maxLength: 2048
title string(text) (required)
The title of the current page, if known.
format: text
maxLength: 100
screenResolution clientEventScreenResolution
The screen resolution of the current client screen/display, in a width x height, in pixels. Present only if known.
userId mutableResourceId
A unique ID of the interactive user who is using the client application.
minLength: 1
maxLength: 55
pattern: "^[-_:.~$a-zA-Z0-9]{1,55}$"
sessionId mutableResourceId (required)
A opaque string which identifies the user's session. Session IDs are not required to be unique across users or across time.
minLength: 1
maxLength: 55
pattern: "^[-_:.~$a-zA-Z0-9]{1,55}$"
sessionNumber integer(int32) (required)
The sequential number of this user's renewed session. The first session (for example, after authenticating) is 0. When the client extends the session when the session times out, the client should increment this number.
format: int32
minimum: 0
maximum: 10000
engagementDuration integer(int32)
The total time the end user has been engaged with the client application, in milliseconds. The maximum, 172,800,000ms, is 48 hours of continuous engagement.
format: int32
minimum: 0
maximum: 172800000
type clientInteractionEventMessageType (required)
The type of this event. This is the key into the set of event types. This is a lowerCamelCase string.
minLength: 4
maxLength: 48
pattern: "^[a-z][a-zA-Z0-9]{3,47}$"
category clientInteractionEventMessageCategory (required)
An identifier for the category of the event. Multiple message types can belong to a category. This is a lowerCamelCase string.
minLength: 4
maxLength: 40
pattern: "^[a-z][a-zA-Z0-9]{3,39}$"
data abstractClientInteractionEventDataSchema
Additional type-specific data properties for this event. For example, the data value in a client event message with type of clientSessionStarted is defined by clientSessionStartedEventSchema.
id readOnlyResourceId (required)
The unique identifier for this client interaction event resource. This is an immutable opaque string.
read-only
minLength: 6
maxLength: 48
pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
occurredAt readOnlyTimestamp(date-time)
The date and time when the event occurred.
read-only
format: date-time
minLength: 20
maxLength: 30 

{
  "url": "https://www.example.com/wire-transfer-confirmation",
  "text": "Submit Wire Transfer",
  "class": "action",
  "id": "submit-wire-transfer",
  "outbound": false
}

Client Interaction Event Link (v1.0.0)

A link involved in a client interaction.

The scheme and '😕/' separator and host from the url constitute the link's origin.

NameDescription
Client Interaction Event Link (v1.0.0) object
A link involved in a client interaction.

The scheme and '://' separator and host from the url constitute the link's origin.

url string(uri-reference)
The full URL of the link target, if known.
format: uri-reference
minLength: 2
maxLength: 2048
text string(text)
The text label/title of the link.
format: text
minLength: 0
maxLength: 200
class string(text)
The CSS class of the link, if present/known. This contains one or more class names, space-delimited.
format: text
minLength: 1
maxLength: 400
id string(text) (required)
The HTML id of the link or other element, if present/known.
format: text
minLength: 1
maxLength: 80
outbound boolean
true if the link is to a different application from the current application: the link's origin differs from the current application's origin. This property is derived and immutable.
read-only

clientInteractionEventMessageCategory

"wireTransfers"

Client Interaction Event Message Category (v1.0.0)

An identifier for the category of the event. Multiple message types can belong to a category. This is a lowerCamelCase string.

type: string


minLength: 4
maxLength: 40
pattern: "^[a-z][a-zA-Z0-9]{3,39}$"

clientInteractionEventMessageType

"wireTransferScheduled"

Client Interaction Event Message Type (v1.0.0)

The type of this event. This is the key into the set of event types. This is a lowerCamelCase string.

type: string


minLength: 4
maxLength: 48
pattern: "^[a-z][a-zA-Z0-9]{3,47}$"

clientSessionStartedEventSchema

{}

Client Session Started Event Schema (v0.2.1)

Payload for client interaction event messages triggered when the client starts a new user session, such as initially opening the application and authenticating. This schema defines the data object for event messages with category sessions and event message type of clientSessionStarted.

Properties

NameDescription
Client Session Started Event Schema (v0.2.1) object
Payload for client interaction event messages triggered when the client starts a new user session, such as initially opening the application and authenticating. This schema defines the data object for event messages with category sessions and event message type of clientSessionStarted.
Unevaluated Properties: false

institutionId

"TIBURON"

Institution ID (v1.1.0)

The unique immutable identifier of a financial institution.

type: string


minLength: 2
maxLength: 8
pattern: "^[A-Z0-9_]{2,8}$"

mutableResourceId

"string"

Mutable Resource Identifier (v1.0.0)

A mutable unique, opaque system identifier for a resource.

type: string


minLength: 1
maxLength: 55
pattern: "^[-_:.~$a-zA-Z0-9]{1,55}$"

newClientInteractionEvent

{
  "page_url": "https://www.banking.tiburon-cf.com",
  "referrer_url": "http://www.tiburon-cf.com",
  "title": "Open a new Account at Tiburon Community Financial",
  "screenResolution": {
    "width": 1792,
    "height": 1120
  },
  "sessionId": "7859270edbe87b9f969c",
  "engagementDuration": 180000,
  "sessionNumber": 0,
  "data": {},
  "type": "clientSessionStarted",
  "category": "sessions",
  "language": "en-US",
  "clientId": "056c0a5d954897e4dc1a",
  "channel": "web"
}

New Client Interaction Event (v1.1.0)

Representation used to create a new client interaction event.

Properties

NameDescription
New Client Interaction Event (v1.1.0) object
Representation used to create a new client interaction event.
language string (required)
The language-locale code of the client, such as 'en-US' or 'en'. Normally, this is the language code and optional region/locale code, without weights or punctuation, of the first value in the Accept-Language header that the browser manages for HTTP requests.
minLength: 1
maxLength: 16
pattern: "^([a-z]{2,3}(?:-[A-Z]{2,3}(?:-[a-zA-Z0-9]{2,8})?)?)$"
clientId mutableResourceId (required)
A value that uniquely identifies the end user/device/client application combination.
minLength: 1
maxLength: 55
pattern: "^[-_:.~$a-zA-Z0-9]{1,55}$"
channel clientInteractionEventChannel (required)
The client application's delivery channel.
enum values: unknown, web, mobile, other
page_url string(uri) (required)
The complete URL of the current application page, including query parameters and anchor.
format: uri
maxLength: 2048
referrer_url string(uri)
The URL of referrer (previous page), including query parameters and anchor, if any. Omitted if not known or there is no previous page (no referrer).
format: uri
maxLength: 2048
title string(text) (required)
The title of the current page, if known.
format: text
maxLength: 100
screenResolution clientEventScreenResolution
The screen resolution of the current client screen/display, in a width x height, in pixels. Present only if known.
userId mutableResourceId
A unique ID of the interactive user who is using the client application.
minLength: 1
maxLength: 55
pattern: "^[-_:.~$a-zA-Z0-9]{1,55}$"
sessionId mutableResourceId (required)
A opaque string which identifies the user's session. Session IDs are not required to be unique across users or across time.
minLength: 1
maxLength: 55
pattern: "^[-_:.~$a-zA-Z0-9]{1,55}$"
sessionNumber integer(int32) (required)
The sequential number of this user's renewed session. The first session (for example, after authenticating) is 0. When the client extends the session when the session times out, the client should increment this number.
format: int32
minimum: 0
maximum: 10000
engagementDuration integer(int32)
The total time the end user has been engaged with the client application, in milliseconds. The maximum, 172,800,000ms, is 48 hours of continuous engagement.
format: int32
minimum: 0
maximum: 172800000
type clientInteractionEventMessageType (required)
The type of this event. This is the key into the set of event types. This is a lowerCamelCase string.
minLength: 4
maxLength: 48
pattern: "^[a-z][a-zA-Z0-9]{3,47}$"
category clientInteractionEventMessageCategory (required)
An identifier for the category of the event. Multiple message types can belong to a category. This is a lowerCamelCase string.
minLength: 4
maxLength: 40
pattern: "^[a-z][a-zA-Z0-9]{3,39}$"
data abstractClientInteractionEventDataSchema
Additional type-specific data properties for this event. For example, the data value in a client event message with type of clientSessionStarted is defined by clientSessionStartedEventSchema.

problemResponse

{
  "id": "3fbad566-be86-4b22-9ba6-3ca99fdc0799",
  "type": "https://production.api.apiture.com/errors/noSuchAccount/v1.0.0",
  "title": "Account Not Found",
  "status": 422,
  "occurredAt": "2022-04-25T12:42:21.375Z",
  "detail": "No account exists for the given account reference",
  "instance": "https://production.api.apiture.com/banking/transfers/bb709151-575041fcd617"
}

Problem Response (v0.4.1)

API problem or error response, as per RFC 9457 application/problem+json.

Properties

NameDescription
Problem Response (v0.4.1) object
API problem or error response, as per RFC 9457 application/problem+json.
type string(uri-reference)
A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank".
format: uri-reference
maxLength: 2048
title string(text)
A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type.
format: text
maxLength: 120
status integer(int32)
The HTTP status code for this occurrence of the problem.
format: int32
minimum: 100
maximum: 599
detail string(text)
A human-readable explanation specific to this occurrence of the problem.
format: text
maxLength: 256
instance string(uri-reference)
A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment
format: uri-reference
maxLength: 2048
id readOnlyResourceId
The unique identifier for this problem. This is an immutable opaque string.
read-only
minLength: 6
maxLength: 48
pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
occurredAt readOnlyTimestamp(date-time)
The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC.
read-only
format: date-time
minLength: 20
maxLength: 30
problems array: [apiProblem]
Optional root-causes if there are multiple problems in the request or API call processing.
maxItems: 128
items: object
attributes object
Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

readOnlyResourceId

"string"

Read-only Resource Identifier (v1.0.1)

The unique, opaque system-assigned identifier for a resource. This case-sensitive ID is also used in URLs as path parameters or in other properties or parameters that reference a resource by ID rather than URL. Resource IDs are immutable.

type: string


read-only
minLength: 6
maxLength: 48
pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"

readOnlyTimestamp

"2021-10-30T19:06:04.250Z"

Read-Only Timestamp (v1.0.0)

A readonly or derived timestamp (an instant in time) formatted in RFC 3339 date-time UTC format: YYYY-MM-DDThh:mm:ss.sssZ.

type: string(date-time)


read-only
format: date-time
minLength: 20
maxLength: 30

requiredIdentityChallenge

{
  "operationId": "createTransfer",
  "challengeId": "0504076c566a3cf7009c",
  "factors": [
    {
      "type": "sms",
      "labels": [
        "9876"
      ],
      "id": "85c0ee5753fcd0b0953f"
    },
    {
      "type": "voice",
      "labels": [
        "9876"
      ],
      "id": "d089e10a80a8627df37b"
    },
    {
      "type": "voice",
      "labels": [
        "6754"
      ],
      "id": "10506ecf9d1c2ee00403"
    },
    {
      "type": "email",
      "labels": [
        "an****nk@example.com",
        "an****98@example.com"
      ],
      "id": "e917d671cb2f030b56f1"
    },
    {
      "type": "authenticatorToken",
      "labels": [
        "Acme fob"
      ],
      "id": "fe6c452d7da0bbb4e407"
    },
    {
      "type": "securityQuestions",
      "securityQuestions": {
        "questions": [
          {
            "id": "q1",
            "prompt": "What is your mother's maiden name?"
          },
          {
            "id": "q4",
            "prompt": "What is your high school's name?"
          },
          {
            "id": "q9",
            "prompt": "What is the name of your first pet?"
          }
        ]
      },
      "id": "df33c6f88a37d6b3f0a6"
    }
  ]
}

Required Challenge (v1.2.3)

A request from the service for the user to verify their identity. This contains a challenge ID, the corresponding operation ID, and a list of challenge factors for identity verification. The user must complete one of these challenge factors to satisfy the challenge. This schema defines the attributes in the 401 Unauthorized problem response when the 401 problem type name is challengeRequired. See the "Challenge API" for details.

Properties

NameDescription
Required Challenge (v1.2.3) object
A request from the service for the user to verify their identity. This contains a challenge ID, the corresponding operation ID, and a list of challenge factors for identity verification. The user must complete one of these challenge factors to satisfy the challenge. This schema defines the attributes in the 401 Unauthorized problem response when the 401 problem type name is challengeRequired. See the "Challenge API" for details.
operationId challengeOperationId (required)
The ID of an operation/action for which the user must verify their identity via an identity challenge. This is passed when starting a challenge factor or when validating the identity challenge responses.
minLength: 6
maxLength: 48
pattern: "^[-a-zA-Z0-9$_]{6,48}$"
challengeId readOnlyResourceId (required)
The unique ID of this challenge instance. This is an opaque string. This is passed when starting a challenge factor or when validating the identity challenge responses.
read-only
minLength: 6
maxLength: 48
pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
factors array: [challengeFactor] (required)
A list of challenge factors. The user must complete one of these challenge factors. The labels in each factor identify one or more channels the user may use, such as a list of email addresses the system may use to send a one-time passcode to the user. *Note: The same channel may be used by multiple factors in the array of factors. For example, the user's primary mobile phone number may be used for both an sms factor and a voice factor.
minItems: 1
maxItems: 8
items: object

resourceId

"string"

Resource Identifier (v1.0.1)

The unique, opaque system identifier for a resource. This case-sensitive ID is also used as path parameters in URLs or in other properties or parameters that reference a resource by ID rather than URL.

type: string


minLength: 6
maxLength: 48
pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"

screenViewedEventSchema

{}

Screen Viewed Event Schema (v0.2.1)

Payload for client interaction event messages triggered when the user views a page or a screen (in a single page application) This schema defines the data object for event messages with category screenInteractions and event message type of screenViewed.

Properties

NameDescription
Screen Viewed Event Schema (v0.2.1) object
Payload for client interaction event messages triggered when the user views a page or a screen (in a single page application) This schema defines the data object for event messages with category screenInteractions and event message type of screenViewed.
Unevaluated Properties: false

userEngagedEventSchema

{}

User Engaged Event Schema (v0.2.1)

Payload for client interaction event messages which record how long the client application user has been engaged with client application. The client should pass the engagementDuration property within the newClientInteractionEvent object with this event. This schema defines the data object for event messages with category sessions and event message type of userEngaged.

Properties

NameDescription
User Engaged Event Schema (v0.2.1) object
Payload for client interaction event messages which record how long the client application user has been engaged with client application. The client should pass the engagementDuration property within the newClientInteractionEvent object with this event. This schema defines the data object for event messages with category sessions and event message type of userEngaged.
Unevaluated Properties: false
Generated by @apiture/api-doc 3.2.4 on Wed Mar 26 2025 19:42:36 GMT+0000 (Coordinated Universal Time).
Shell HTTP Node.JS JavaScript Ruby Python Java Go