> ## Documentation Index
> Fetch the complete documentation index at: https://docs.gu1.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# User event codes

> Closed eventType list for user events: what each code means and when to send it.

A user event records something a person did in your product: a login, a credential change, a lookup, a loan application, or the result of that application. Send it to [`POST /events/user`](/en/api-reference/events/create) in the `eventType` field.

The value is a closed code, uppercase with underscores. Pick the most specific code. Use `OTHER_EVENT` only when no listed code fits the action.

## Authentication

| Code | When to use it |
| - | - |
| `LOGIN_SUCCESS` | Sign-in succeeded. |
| `LOGIN_FAILED` | A sign-in attempt failed. |
| `LOGOUT` | The person signed out. |
| `TOKEN_GENERATED` | An authentication token was generated. |

## Credentials

| Code | When to use it |
| - | - |
| `PASSWORD_CHANGE` | The password was changed. |
| `PASSWORD_CHANGE_FAILED` | The password change failed. |
| `EMAIL_CHANGE` | The email address changed. |
| `PHONE_CHANGE` | The phone number changed. |
| `PIN_CHANGE` | The PIN changed. |

## Account, contacts, and devices

| Code | When to use it |
| - | - |
| `ACCOUNT_LINKED` | An account was linked. |
| `CONTACT_CREATED` | A contact was created. |
| `CONTACT_DELETED` | A contact was deleted. |
| `ADDRESS_CHANGED` | The address changed. |
| `DEVICE_ADDED` | A device was added. |
| `DEVICE_DELETED` | A device was removed. |
| `DEVICE_CONNECTED` | A device connected or was linked in that flow. |
| `EMAIL_CREATED` | An email address was created. |
| `EMAIL_ELIMINATED` | An email address was removed. |

## Navigation and lookups

| Code | When to use it |
| - | - |
| `NAVIGATION` | The person opened a page or screen in your product. |
| `BALANCE_CHECK` | They checked a balance. |
| `BALANCE_CHECK_FAILED` | The balance check failed. |
| `ACCOUNTS_VIEW` | They viewed the account list or account detail. |
| `ACCOUNTS_VIEW_FAILED` | The account view failed. |
| `TRANSACTIONS_VIEW` | They viewed movements or history. |
| `TRANSACTIONS_VIEW_FAILED` | The history view failed. |
| `SEARCH_RECIPIENTS` | They searched or looked up recipients. |
| `SEARCH_RECIPIENTS_FAILED` | The recipient search failed. |
| `SCHEDULE_RECIPIENT_FAILED` | Scheduling a recipient failed. |
| `PROFILE_VIEW` | They viewed a profile. |
| `PROFILE_UPDATED` | They saved profile changes. |
| `MESSAGES_VIEW` | They viewed messages. |
| `MESSAGES_VIEW_FAILED` | The message view failed. |
| `ACCOUNT_HOLDERS_VIEW` | They looked up account holders. |
| `ACCOUNT_HOLDERS_VIEW_FAILED` | The account-holder lookup failed. |

## Alias and payment methods

| Code | When to use it |
| - | - |
| `ALIAS_VIEW` | They looked up an alias. |
| `ALIAS_VIEW_FAILED` | The alias lookup failed. |
| `ALIAS_CHANGE` | An alias was changed. |
| `ALIAS_CHANGE_FAILED` | The alias change failed. |
| `CARD_ADDED` | A card was added. |

## Transfers

| Code | When to use it |
| - | - |
| `TRANSFER_SUCCESS` | The transfer completed. |
| `TRANSFER_FAILED` | The transfer failed. |
| `TRANSFER_SCHEDULED` | The transfer was scheduled. |

A transfer is not a loan application. Use the loan codes below for that lifecycle.

## Loans

| Code | When to use it |
| - | - |
| `LOAN_REQUEST` | The person submitted a loan application. |
| `LOAN_APPROVED` | The loan application was approved. |
| `LOAN_REJECTED` | The loan application was rejected. |

## Biometrics

| Code | When to use it |
| - | - |
| `BIOMETRIC_VALIDATION_SUCCESS` | A biometric validation reported by your product succeeded. |
| `BIOMETRIC_VALIDATION_ERROR` | That biometric validation failed. |

## SDK

The Gu1 SDK emits these codes. You can also send them when you record the same action.

| Code | When to use it |
| - | - |
| `SESSION_STARTED` | A session started, before the person is identified. |
| `SESSION_IDENTIFIED` | The session was bound to an entity. |
| `SCREEN_VIEW` | A screen or navigation was recorded. |

## Other

| Code | When to use it |
| - | - |
| `OTHER_EVENT` | The action does not match any code on this page. |

To create the event, see [Create a user event](/en/api-reference/events/create).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.