> ## 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.

# Códigos de eventos de usuário

> Lista fechada de eventType para eventos de usuário: o que cada código significa e quando enviá-lo.

Um evento de usuário registra uma ação da pessoa no seu produto: um login, uma mudança de credencial, uma consulta, uma solicitação de empréstimo ou o resultado dessa solicitação. O envio é em [`POST /events/user`](/pt/api-reference/events/create), no campo `eventType`.

O valor é um código fechado, em maiúsculas e com sublinhados. Escolha o código mais específico. `OTHER_EVENT` fica para uma ação que não tem código próprio.

## Autenticação

| Código | Quando usar |
| - | - |
| `LOGIN_SUCCESS` | O login foi concluído. |
| `LOGIN_FAILED` | A tentativa de login falhou. |
| `LOGOUT` | A pessoa encerrou a sessão. |
| `TOKEN_GENERATED` | Um token de autenticação foi gerado. |

## Credenciais

| Código | Quando usar |
| - | - |
| `PASSWORD_CHANGE` | A senha foi alterada. |
| `PASSWORD_CHANGE_FAILED` | A alteração de senha falhou. |
| `EMAIL_CHANGE` | O e-mail mudou. |
| `PHONE_CHANGE` | O telefone mudou. |
| `PIN_CHANGE` | O PIN mudou. |

## Conta, contatos e dispositivos

| Código | Quando usar |
| - | - |
| `ACCOUNT_LINKED` | Uma conta foi vinculada. |
| `CONTACT_CREATED` | Um contato foi criado. |
| `CONTACT_DELETED` | Um contato foi excluído. |
| `ADDRESS_CHANGED` | O endereço mudou. |
| `DEVICE_ADDED` | Um dispositivo foi adicionado. |
| `DEVICE_DELETED` | Um dispositivo foi removido. |
| `DEVICE_CONNECTED` | Um dispositivo conectou ou foi vinculado nesse fluxo. |
| `EMAIL_CREATED` | Um e-mail foi criado. |
| `EMAIL_ELIMINATED` | Um e-mail foi removido. |

## Navegação e consultas

| Código | Quando usar |
| - | - |
| `NAVIGATION` | A pessoa navegou por uma página ou tela do seu produto. |
| `BALANCE_CHECK` | Consultou o saldo. |
| `BALANCE_CHECK_FAILED` | A consulta de saldo falhou. |
| `ACCOUNTS_VIEW` | Viu a lista ou o detalhe das contas. |
| `ACCOUNTS_VIEW_FAILED` | Não foi possível ver as contas. |
| `TRANSACTIONS_VIEW` | Viu movimentações ou o histórico. |
| `TRANSACTIONS_VIEW_FAILED` | Não foi possível ver o histórico. |
| `SEARCH_RECIPIENTS` | Buscou ou consultou destinatários. |
| `SEARCH_RECIPIENTS_FAILED` | A busca de destinatários falhou. |
| `SCHEDULE_RECIPIENT_FAILED` | Falhou ao agendar um destinatário. |
| `PROFILE_VIEW` | Viu o perfil. |
| `PROFILE_UPDATED` | Salvou alterações do perfil. |
| `MESSAGES_VIEW` | Viu mensagens. |
| `MESSAGES_VIEW_FAILED` | Não foi possível ver as mensagens. |
| `ACCOUNT_HOLDERS_VIEW` | Consultou os titulares da conta. |
| `ACCOUNT_HOLDERS_VIEW_FAILED` | Não foi possível consultar os titulares. |

## Alias e meios de pagamento

| Código | Quando usar |
| - | - |
| `ALIAS_VIEW` | Consultou um alias. |
| `ALIAS_VIEW_FAILED` | A consulta de alias falhou. |
| `ALIAS_CHANGE` | Um alias foi alterado. |
| `ALIAS_CHANGE_FAILED` | A alteração de alias falhou. |
| `CARD_ADDED` | Um cartão foi adicionado. |

## Transferências

| Código | Quando usar |
| - | - |
| `TRANSFER_SUCCESS` | A transferência foi concluída. |
| `TRANSFER_FAILED` | A transferência falhou. |
| `TRANSFER_SCHEDULED` | A transferência foi agendada. |

Uma transferência não é uma solicitação de empréstimo. Para esse ciclo, use os códigos da seção seguinte.

## Empréstimos

| Código | Quando usar |
| - | - |
| `LOAN_REQUEST` | A pessoa enviou uma solicitação de empréstimo. |
| `LOAN_APPROVED` | A solicitação de empréstimo foi aprovada. |
| `LOAN_REJECTED` | A solicitação de empréstimo foi rejeitada. |

## Biometria

| Código | Quando usar |
| - | - |
| `BIOMETRIC_VALIDATION_SUCCESS` | A validação biométrica informada pelo seu produto foi concluída. |
| `BIOMETRIC_VALIDATION_ERROR` | Essa validação biométrica falhou. |

## SDK

O SDK da Gu1 emite estes códigos. Você também pode enviá-los ao registrar a mesma ação.

| Código | Quando usar |
| - | - |
| `SESSION_STARTED` | Uma sessão começou, antes de identificar a pessoa. |
| `SESSION_IDENTIFIED` | A sessão foi vinculada a uma entidade. |
| `SCREEN_VIEW` | Uma tela ou navegação foi registrada. |

## Outros

| Código | Quando usar |
| - | - |
| `OTHER_EVENT` | A ação não corresponde a nenhum código desta página. |

Para criar o evento, veja [Criar um evento de usuário](/pt/api-reference/events/create).


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