User Events 2.0 (Optional)

User events provide full visibility into the customer’s actions while they’re interacting with the Connect or Connect Lite applications (apps).

The event types are compatible with all analytics tools, allowing you to build web analytics dashboards to evaluate conversions, success rates, and error rates. Tracking metric data from your customers also allows you to make decisions about your own products.

Definitions

  • Financial Institution (FI)

  • Multi-factor authentication (MFA)

  • Support Full—Connect 2.0

  • Support Lite—Connect Lite 2.0

  • Support Fix—Connect Fix 2.0

  • ttl field—when the Connect URL link expires.

Events List

AddAccounts

Supported: Connect Full


Sent when a customer attempt to add their accounts.

This event is sent two times.

1. The first event is sent when the customer attempts to add their bank accounts.

    The return includes:

    • A null value for the success, accounts, and errorCode fields.

2. The second event sent provides the details about the attempt.

     a.  The customer successfully added their accounts if:

• accounts= populated
• success= true
•errorCode= null

    b.  The customer failed to add their accounts if:

• accounts= null
• success= false
• errorCode= populated

Note: If the first event is received but the second event never arrives, then the customer ended the attempt to add accounts before Connect could successfully add the accounts.

AddAccounts
 {

	"action": "AddAccounts",

	"institutionId": 101732,

	"accounts": 2,

	"success": true,

	"errorCode": null

}

DisplayAlert

Supported: Connect Full, Connect Lite, Connect Fix


Sent when a customer receives an alert within a Connect session.

The return includes:

  • The error code
  • The error code message 

Note: These fields are only sent if an alert occurs for an FI.

  • institutionId
  • institutionName
DisplayAlert
 {

 "action": "DisplayAlert",

 "alertType": "action",

 "title": "Incorrect sign in",

 "message": "Your sign in information doesn't match this account. Try again or reset your password. (103)",

 "errorCode": 103,

 "data": {

   "institutionId": 101732,

   "institutionName": "FinBank"

 }

}

End

Supported: Connect Full, Connect Lite, Connect Fix


Sent when a customer ends a Connect session. 

See Connect 2.0 Error Codes

Note: Used to indicate how many customers have left a Connect session within your own product applications.

End
 {

 "action": "End",

 "reason": "complete",

 "code": 200,

 "customerId": "1017101354",

 "partnerId": "2445582695152",

 "timestamp": "1614357232785",

 "ttl": "1614364432785",

 "type": "default",

 "experience": null,

 "product": "voa"

 "sessionId": "0e90718d9f7c7d300117e30f8c25120ee81ac367b77f4347659ec8b5175fbab9"

}

FixMfaAttempt

Supported: Connect Fix


Sent when a customer attempts to answer an MFA challenge.

This event is sent two times.

1. The first event is sent when the customer attempts to answer an MFA challenge question while signing into their bank.

    The return includes:

    • A null value for the success, accounts, and errorCode fields.

2. A second event sent provides the details about the attempt.

     a.  The customer successfully signed into their accounts if:

• accounts= populated
• success= true
•errorCode= null

     b.  The customer encountered another MFA challenge if:

• accounts= null
• success= true
•errorCode= null

    c.  The customer failed to sign in to their accounts if:

• accounts= null
• success= false
• errorCode= populated

FixMfaAttempt
 {

   "action": "FixMfaAttempt",

   "institutionId": 101732,

   "institutionLoginId": 1020531041,

   "accounts": 8,

   "success": true,

   "errorCode": null

}

FixSignInAttempt

Supported: Connect Fix


Sent when a customer tries attempts to sign in when fixing a connection to their account.

This event is sent two times.

1. The first event is sent when the customer attempts to sign into their bank.

    The return includes:

    • A null value for the success, accounts, and errorCode fields.

2. A second event sent provides the details about the attempt.

     a.  The customer successfully fixed the sign in for the account if:

• accounts= populated
• success= true
•errorCode= null

     b.  The customer encountered an MFA challenge if:

• accounts= null
• success= true
•errorCode= null

    c.  The customer failed to fix the sign in for their account if:

• accounts= null
• success= false
• errorCode= populated

Note: If the first event is received but the second event never arrives, then the customer ended the attempt to fix their sign-in before Connect could successfully connect to the FI.

FixSignInAttempt
 {

   "action": "FixSignInAttempt",

   "institutionId": 101732,

   "institutionLoginId": 1020531041,

   "accounts": null,

   "success": true,

   "errorCode": null

}

Initialize

Supported: Connect Full, Connect Lite, Connect Fix


Sent when a user starts a Connect session. 



Initialize
 {

   "action": "Initialize",

   "customerId": "1015170547",

   "partnerId": "2445582695152",

   "timestamp": "1606253024467",

   "ttl": "1606260224467",

   "type": "full",

   "experience": null,

   "product": "voa"

   "sessionId": "7035b169d6f13306a240e7291bf7eab1a28010af26b57249ca1ccf5c49a30ce4"

}

LaunchOAuth

Supported: Connect Full, Connect Lite


Sent when the customer opens an OAuth window for an FI.

See OAuth Connections

Note: If no other OAuth events are received after this event, then the customer most likely closed the OAuth window.

LaunchOAuth
 {

   "action": "LaunchOAuth",

   "institutionId": 102176

   "success": true,

   "errorCode": null

}

MfaAttempt

Supported: Connect Full, Connect Lite


Sent when the customer attempts to answer an MFA challenge.

This event is sent two times.

1. The first event is sent when the customer attempts to sign into their bank.

    The return includes:

    • A null value for the success, accounts, and errorCode fields.

2. A second event sent provides the details about the attempt.

     a.  The customer successfully signed into their accounts if:

• accounts= populated
• success= true
•errorCode= null

     b.  The customer encountered another MFA challenge if:

• accounts= null
• success= true
•errorCode= null

    c.  The customer failed to sign in to their accounts if:

• accounts= null
• success= false
• errorCode= populated

MfaAttempt
 {

   "action": "MfaAttempt",

   "institutionId": 101732,

   "accounts": 8,

   "success": true,

   "errorCode": null

}

OAuthAddAccounts

Supported: Connect Full, Connect Lite


Sent when the customer attempts to add an OAuth account for an FI.

See OAuth Connections.

OAuthAddAccounts
 {

   "action": "OAuthAddAccounts",

   "institutionId": 102176,

   "accounts": 2,

   "success": true,

   "errorCode": null

}

OAuthSignInAttempt

Supported: Connect Full, Connect Lite


Sent when the customer attempts to sign into an OAuth account for an FI.

See OAuth Connections

ConnectInstitution
 {

   "action": "OAuthSignInAttempt",

   "institutionId": 102176,

   "success": true,

   "errorCode": null

}

RemoveAccounts

Supported: Connect Full, Connect Lite


Sent when a customer tries to remove their accounts.

This event is sent two times.

1. The first event is sent when the customer attempts to sign into their bank.

    The return includes:

    • A null value for the success, accounts, and errorCode fields.

2. A second event is sent with the results about the customer’s attempt to remove their accounts:

    • Successfully removes accounts
    • Failed to remove accounts

Note: If the first event is received but the second event never arrives, then the customer ended the attempt to remove their accounts before Connect could successfully remove them.

RemoveAccounts
 {

   "action": "RemoveAccounts",

   "institutionId": 101732,

   "institutionLoginId": 1020404281,

   "accounts": 2,

   "success": true,

   "errorCode": null

}

SearchInstitutions

Supported: Connect Full


Sent when a user searches for an FI. 

The return includes: 

  • The customer’s query search words
  • The number of matching search results
  • The number of times the customer attempted to search

Note: The event is only sent if this condition occurs: at least three letters are typed and the customer pauses after typing for 300 ms.


SearchInstitutions
 {

   "action": "SearchInstitutions",

   "searchTerm": "finbank",

   "resultCount": 14

}

SelectInstitution

Supported: Connect Full

Sent when the customer selects an FI to sign into. 

The return includes:

  • The institution ID the customer selected.
  • If the FI is supported for the product.
SelectInstitution
 {

   "action": "SelectInstitution",

   "institutionId": 101732,

   "supported": true

}

SignInAttempt

Supported: Connect Full, Connect Lite


Sent when a customer attempts to sign in to an account.

This event is sent two times.

1. The first event is sent when the customer attempts to sign into their bank.

    The return includes:

    • A null value for the success, accounts, and errorCode fields.

2. A second event sent provides the details about the attempt.

     a.  The customer successfully signed into their accounts if:

• accounts= populated
• success= true
•errorCode= null

     b.  The customer encountered an MFA challenge if:

• accounts= null
• success= true
•errorCode= null

    c.  The customer failed to sign in to their accounts if:

• accounts= null
• success= false
• errorCode= populated


Note: If the first event is received but the second event never arrives, then the customer ended the attempt before Connect successfully connected to the FI.

SignInAttempt
 {

   "action": "SignInAttempt",

   "institutionId": 101732,

   "accounts": 8,

   "success": true,

   "errorCode": null

}

SubmitAccounts

Supported: Connect Full 


Sent when the customer attempts to submit their accounts. 

The return includes:

  • The accounts

This user event indicates:

  • The customer attempted to submit their accounts
  • The account number if the customer’s attempt to submit accounts was successful
SubmitAccounts
 {

   "action": "SubmitAccounts",

   "customerId": "1015170547",

   "partnerId": "2445582695152",

   "timestamp": "1606253024467",

   "ttl": "1606260224467",

   "type": "full",

   "experience": null,

   "product": "voa"

   "sessionId": "7035b169d6f13306a240e7291bf7eab1a28010af26b57249ca1ccf5c49a30ce4"

}