Manejo de Erros e Retornos da API

Introdução

Este documento tem como objetivo fornecer uma visão geral sobre o manejo de erros e os retornos da API. Cada erro retornado pela API é padronizado para garantir consistência e facilitar a identificação de problemas. Os códigos de erro são prefixados para indicar o contexto ou o módulo ao qual pertencem. Por exemplo, erros relacionados a operações de usuário possuem o prefixo "ERR_USR".

Padronização dos Prefixos

Os códigos de erro seguem uma convenção de prefixos para indicar a origem ou o módulo do erro:

• ERR_AUD: Erros relacionados a auditorias.
• ERR_AUT: Erros relacionados a autenticação.
• ERR_CRD: Erros relacionados a cartões.
• ERR_CHR: Erros relacionados a gráficos.
• ERR_CMP: Erros relacionados a empresas.
• ERR_CMP_CFG: Erros relacionados a configurações de empresas.
• ERR_CMP_SUP: Erros relacionados a supervisores de empresas.
• ERR_FCE: Erros relacionados a reconhecimento facial.
• ERR_HLT: Erros relacionados à saúde do sistema.
• ERR_INT: Erros relacionados a integrações.
• ERR_JUS: Erros relacionados a justificativas.
• ERR_LOG: Erros relacionados a logs.
• ERR_MDW: Erros relacionados a middleware.
• ERR_PROC: Erros relacionados a procedimentos.
• ERR_EXP_PROC: Erros relacionados a isenções de procedimentos.
• ERR_RCZ: Erros relacionados a reconhecimento.
• ERR_RPT: Erros relacionados a relatórios.
• ERR_RNI: Erros relacionados a novas imagens solicitadas.
• ERR_USR: Erros relacionados a usuários.

Tabelas de Erros por Endpoint

Endpoint: Audit

Código	Mensagem	Descrição
ERR_AUD_HASH_FIND	"Falha ao recuperar auditoria pelo código."	Ocorre quando a recuperação de uma auditoria pelo código hash falha.
ERR_AUD_COUNT_GET	"Não foi possível verificar o total de auditorias disponíveis."	Ocorre quando a obtenção do total de auditorias falha.
ERR_AUD_LIST_FIND	"Ocorreu um erro ao consultar as auditorias disponíveis."	Ocorre quando a consulta da lista de auditorias falha.
ERR_AUD_MAIN_IMAGE_NOT_FOUND	"Nenhuma imagem principal encontrada para a carteirinha."	Ocorre quando a imagem principal de uma carteirinha não é encontrada.
ERR_AUD_IMAGE_GET	"Falha ao recuperar a imagem da auditoria."	Ocorre quando a recuperação da imagem de uma auditoria falha.
ERR_AUD_UPDATE	"Ocorreu um erro ao atualizar auditoria."	Ocorre quando a atualização de uma auditoria falha.
ERR_AUD_CARD_NOT_FOUND	"Não foi possível encontrar a carteirinha pelo ID informado."	Ocorre quando a recuperação de uma carteirinha pelo ID falha.
ERR_AUD_INVALID_PARAMS	"Parâmetros inválidos"	Ocorre quando os parâmetros fornecidos para a auditoria são inválidos.
ERR_AUD_MAIN_IMAGE_FIND	"Ocorreu um erro ao verificar a imagem principal."	Ocorre quando a verificação da imagem principal de uma carteirinha falha.
ERR_AUD_INVALID_REQUEST	"Requisição inválida. Verifique os dados e demais parâmetros e tente novamente."	Ocorre quando a requisição é inválida ou malformada.
ERR_AUD_ACCESS_NOT_ALLOWED	"Empresa não autorizada a realizar essa operação."	Ocorre quando a empresa não tem permissão para realizar uma determinada ação em um recurso.

Endpoint: Auth

Código	Mensagem	Descrição
ERR_AUTH_INVALID_USER	"Acesso inválido ou não registrado."	Ocorre quando o usuário não é encontrado no banco de dados.
ERR_AUTH_INVALID_USER_ACCOUNT	"Conta inválida ou não registrada. Verifique os dados e tente novamente."	Ocorre quando os detalhes da conta do usuário não são encontrados.
ERR_AUTH_USER_FIND	"Credenciais inválidas ou não registradas."	Ocorre quando a recuperação do usuário no banco de dados falha.
ERR_AUTH_USER_COMPANIES_FIND	"Empresa não associada ou não registrada."	Ocorre quando a recuperação das empresas associadas ao usuário falha.
ERR_AUTH_USER_UPDATE	"Não foi possível atualizar os dados do usuário."	Ocorre quando a atualização das informações do usuário falha.
ERR_AUTH_USER_ACCOUNT_CREATE	"Falha ao criar conta do usuário. Verifique os dados e tente novamente."	Ocorre quando a criação da conta do usuário falha.
ERR_AUTH_USER_ACCOUNT_UPDATE	"Não foi possível atualizar a conta solicitada."	Ocorre quando a atualização dos detalhes da conta do usuário falha.
ERR_AUTH_USER_ALREADY_VERIFIED	"Usuário já verificado. Nenhuma ação adicional necessária."	Ocorre quando o usuário já foi verificado anteriormente.
ERR_AUTH_USER_ACCESS_DENIED	"Acesso negado."	Ocorre quando o usuário não tem acesso à empresa especificada.
ERR_AUTH_INVALID_RELATED_COMPANY	"Empresa inválida ou não registrada."	Ocorre quando não são encontradas empresas associadas ao usuário.
ERR_AUTH_INVALID_CREDENTIALS	"Credenciais inválidas. Verifique os dados e tente novamente."	Ocorre quando a senha fornecida está incorreta.
ERR_AUTH_INVALID_REQUEST	"Requisição inválida. Verifique os parâmetros enviados e tente novamente."	Ocorre quando a requisição é inválida ou malformada.
ERR_AUTH_ACCESS_TOKEN_VERIFY	"Token de acesso inválido."	Ocorre quando a verificação do token JWT falha.
ERR_AUTH_ACCESS_TOKEN_CREATE	"Não foi possível gerar um novo token de acesso."	Ocorre quando a criação do token de acesso falha.
ERR_AUTH_SEND_CONFIRMATION_EMAIL	"Falha ao enviar o e-mail de confirmação. Por favor, verifique o endereço de e-mail e tente novamente."	Ocorre quando o envio do e-mail de confirmação falha.
ERR_AUTH_SEND_RECOVERY_EMAIL	"Falha ao enviar o e-mail de recuperação de senha. Por favor, verifique o endereço de e-mail e tente novamente."	Ocorre quando o envio do e-mail de recuperação de senha falha.
ERR_AUTH_CREDENTIALS_CREATE	"Falha ao criar credenciais. Por favor, verifique os dados e tente novamente."	Ocorre quando a criação da senha e do hash de sal falha.
ERR_AUTH_PASSWORD_ATTEMPTS_EXCEEDED	"Limite de tentativas de senha excedido. Por favor, redefina sua senha."	Ocorre quando o usuário excede o número permitido de tentativas de senha.
ERR_AUTH_INVALID_PARAMS	"Parâmetros inválidos."	Ocorre quando os parâmetros fornecidos são inválidos.

Endpoint: Card

Código	Mensagem	Descrição
ERR_CRD_GET	"Falha ao recuperar as carteirinhas. Por favor, tente novamente."	Ocorre quando a recuperação das carteirinhas falha.
ERR_CRD_IMAGE_GET	"Falha ao recuperar a imagem. Por favor, tente novamente."	Ocorre quando a recuperação da imagem falha.
ERR_CRD_IMAGE_ALREADY_MAIN	"A imagem já é a principal. Verifique e tente novamente."	Ocorre quando a imagem já está definida como principal.
ERR_CRD_MAIN_IMAGE_GET	"Falha ao recuperar as imagens principais. Por favor, tente novamente."	Ocorre quando a recuperação das imagens principais falha.
ERR_CRD_MAIN_IMAGE_UPDATE	"Falha ao atualizar a imagem principal. Por favor, tente novamente."	Ocorre quando a atualização da imagem principal falha.
ERR_CRD_STATUS_UPDATE	"Falha ao atualizar o status do documento. Por favor, tente novamente."	Ocorre quando a atualização do status do documento falha.
ERR_CRD_NOT_FOUND	"O documento não foi encontrado. Verifique os dados e tente novamente."	Ocorre quando o documento não é encontrado.
ERR_CRD_IMAGE_COUNT	"Não foi possível quantificar os dados. Por favor, tente novamente."	Ocorre quando a contagem de imagens falha.
ERR_CRD_IMAGE_NOT_FOUND	"Imagem não encontrada. Verifique e tente novamente."	Ocorre quando a imagem não é encontrada.
ERR_CRD_IMAGE_URL_GET	"Falha ao recuperar os dados da imagem. Por favor, tente novamente."	Ocorre quando a recuperação da URL da imagem falha.
ERR_CRD_IMAGE_DECODE	"Falha ao enviar a imagem. Verifique o formato da imagem e tente novamente."	Ocorre quando a decodificação da imagem falha.
ERR_CRD_FACE_SEARCH	"Falha ao buscar faces na imagem. Por favor, tente novamente."	Ocorre quando a busca por faces na imagem falha.
ERR_CRD_INVALID_IMAGE_ID	"Código identificador inválido. Verifique os dados fornecidos e tente novamente."	Ocorre quando o ImageID fornecido é inválido.
ERR_CRD_USER_COMPANY_NOT_FOUND	"Empresa não encontrada. Verifique as informações fornecidas e tente novamente."	Ocorre quando a empresa do usuário não é encontrada.
ERR_CRD_UNAUTHORIZED_ACTION	"O usuário não tem permissão para realizar esta ação. Por favor, verifique e tente novamente."	Ocorre quando uma ação não autorizada é tentada.
ERR_CRD_UPDATE_CONSENT_TERM_STATUS	"Falha ao atualizar o status do termo de consentimento. Por favor, tente novamente."	Ocorre quando a atualização do status do termo de consentimento falha.
ERR_CRD_ACTION_BLOCKED_FOR_COMPANY	"Esta empresa não possui acesso a estas informações. Por favor, verifique e tente novamente."	Ocorre quando uma ação é bloqueada para a empresa.
ERR_CRD_JUSTIFICATION_NOT_FOUND	"Justificativa não encontrada. Por favor, tente novamente."	Ocorre quando a mensagem de justificativa não é encontrada.
ERR_CRD_EXCEEDED_MAX_JUSTIFICATIONS	"O documento excedeu o número máximo permitido de justificativas. Por favor, tente novamente."	Ocorre quando o número máximo de justificativas é excedido.
ERR_CRD_UPDATE	"Falha ao atualizar os dados do documento. Verifique-os e tente novamente."	Ocorre quando a atualização dos dados do documento falha.
ERR_CRD_INVALID_DETAIL_FORMAT	"Formato inválido. Verifique e tente novamente."	Ocorre quando o formato dos detalhes é inválido.
ERR_CRD_ID_NOT_FOUND	"Número da carteirinha não encontrado. Verifique os dados e tente novamente."	Ocorre quando o número da carteirinha não é encontrado.
ERR_CRD_NAME_NOT_FOUND	"Nome da carteirinha não encontrado. Verifique os dados e tente novamente."	Ocorre quando o nome da carteirinha não é encontrado.
ERR_CRD_COMPANY_GET	"Falha ao recuperar a empresa. Por favor, tente novamente."	Ocorre quando a recuperação da empresa falha.
ERR_CRD_COMPANY_CONFIG_NOT_FOUND	"As configurações da empresa não foram encontradas. Por favor, tente novamente."	Ocorre quando as configurações da empresa não são encontradas.
ERR_CRD_COMPANY_CODE_GET	"Falha ao recuperar o código da empresa. Por favor, tente novamente."	Ocorre quando a recuperação do código da empresa falha.
ERR_CRD_COMPANY_CREATE	"Falha ao criar a empresa. Por favor, tente novamente."	Ocorre quando a criação da empresa falha.
ERR_CRD_CREATE	"Falha ao criar a carteirinha. Verifique os dados e tente novamente."	Ocorre quando a criação da carteirinha falha.
ERR_CRD_DETAIL_PARSE	"Falha ao analisar os detalhes. Por favor, tente novamente."	Ocorre quando a análise dos detalhes falha.
ERR_CRD_AUDIT_SAVE	"Falha ao salvar a auditoria. Por favor, tente novamente."	Ocorre quando o salvamento da auditoria falha.
ERR_CRD_INVALID_VERIFY_REQUEST	"Dados de verificação incorretos. Por favor, tente novamente."	Ocorre quando o payload de verificação é inválido.
ERR_CRD_IMAGE_FORMAT	"Falha ao verificar a imagem. Por favor, tente novamente."	Ocorre quando a formatação da imagem falha.
ERR_CRD_FACE_VERIFICATION	"Falha ao verificar a face. Por favor, tente novamente."	Ocorre quando a verificação da face falha.
ERR_CRD_FACE_COMPARISON	"Falha ao comparar as faces. Verifique e tente novamente."	Ocorre quando a comparação das faces falha.
ERR_CRD_IMAGE_UNREGISTER	"Falha ao remover o beneficiário. Por favor, tente novamente."	Ocorre quando a remoção do usuário de reconhecimento falha.
ERR_CRD_RECOGNITION_HISTORY_DELETE	"Falha ao excluir o histórico de reconhecimento. Por favor, tente novamente."	Ocorre quando a exclusão do histórico de reconhecimento falha.
ERR_CRD_RECOGNITION_IMAGE_DELETE	"Falha ao excluir a imagem cadastrada. Por favor, tente novamente."	Ocorre quando a exclusão da imagem de reconhecimento falha.
ERR_CRD_IMAGE_REMOVE	"Falha ao remover as imagens relacionadas à carteirinha. Por favor, tente novamente."	Ocorre quando a remoção das imagens relacionadas à carteirinha falha.
ERR_CRD_DELETE	"Falha ao excluir a carteirinha. Por favor, tente novamente."	Ocorre quando a exclusão da carteirinha falha.
ERR_CRD_NO_MAIN_IMAGE_FOUND	"Nenhuma imagem principal encontrada para a carteirinha. Por favor, tente novamente."	Ocorre quando nenhuma imagem principal é encontrada para a carteirinha.
ERR_CRD_INVALID_REGISTER_DATA	"Dados de registro do documento inválidos. Por favor, verifique e tente novamente."	Ocorre quando os dados de registro da carteirinha são inválidos.
ERR_CRD_PROVIDER_BLOCKED_FOR_REGISTRATION	"O fornecedor está bloqueado para registro. Por favor, tente novamente."	Ocorre quando o fornecedor está bloqueado para registro.
ERR_CRD_ID_ALREADY_REGISTERED	"O documento informado já está registrado na plataforma. Verifique os dados e tente novamente."	Ocorre quando o identificador já está registrado.
ERR_CRD_NO_FACE_DETECTED	"Não foi detectada uma face na imagem. Por favor, tente novamente."	Ocorre quando nenhuma face é detectada na imagem.
ERR_CRD_LIVENESS_CHECK	"Falha na verificação. Por favor, tente novamente."	Ocorre quando a verificação de vivacidade falha.
ERR_CRD_ASSIGN_COMPANY_OWNER	"Falha ao atribuir o cadastro ao documento. Por favor, tente novamente."	Ocorre quando a atribuição do proprietário da empresa falha.
ERR_CRD_IMAGE_SAVE	"Falha ao salvar a imagem do documento. Por favor, tente novamente."	Ocorre quando o salvamento da imagem da carteirinha falha.
ERR_CRD_STORAGE_UPLOAD	"Falha ao armazenar a imagem. Por favor, tente novamente."	Ocorre quando o armazenamento da imagem falha.
ERR_CRD_UPDATE_EXISTING_RECORD	"Falha ao atualizar o registro existente. Verifique os dados e tente novamente."	Ocorre quando a atualização de um registro existente falha.
ERR_CRD_PROVIDER_UPDATE	"Falha ao atualizar os dados do fornecedor. Por favor, tente novamente."	Ocorre quando a atualização dos dados do fornecedor falha.
ERR_CRD_UNAUTHORIZED_ACTION	"Ação não autorizada. Verifique as permissões e tente novamente."	Ocorre quando uma ação não autorizada é tentada.
ERR_CRD_TEMPORARY_ISSUE	"Ocorreu um problema temporário. Tente novamente mais tarde."	Ocorre quando há um problema temporário.
ERR_CRD_EXPIRED_TOKEN	"O token de autenticação expirou. Por favor, obtenha um novo token e tente novamente."	Ocorre quando o token de autenticação expira.
ERR_CRD_INVALID_FILE_FORMAT	"Formato de arquivo inválido. Por favor, envie um arquivo válido e tente novamente."	Ocorre quando o formato do arquivo enviado é inválido.

Endpoint: Charts

Código	Mensagem	Descrição
ERR_DSH_INVALID_INTERVAL	"O período informado é inválido. Verifique os dados e tente novamente."	Ocorre quando a duração do intervalo fornecido é inválida.
ERR_DSH_DATA_LOAD	"Não foi possível carregar o gráfico. Por favor, tente novamente."	Ocorre quando a recuperação dos dados do gráfico falha.
ERR_DSH_INVALID_PARAMS	"Parâmetros inválidos. Verifique os dados e tente novamente."	Ocorre quando os parâmetros fornecidos para o gráfico são inválidos.

Endpoint: Company

Código	Mensagem	Descrição
ERR_CMP_NOT_FOUND	"Não foi possível acessar a empresa. Verifique os dados e tente novamente."	Ocorre quando uma empresa não é encontrada.
ERR_CMP_TOKEN_ENCRYPTION	"Não foi possível acessar o token de autenticação. Verifique os dados e tente novamente."	Ocorre quando a criptografia do token falha.
ERR_CMP_LIST_FIND	"Nenhuma empresa foi encontrada com os parâmetros fornecidos. Verifique os dados e tente novamente."	Ocorre quando a recuperação da lista de empresas falha.
ERR_CMP_CREATE	"Falha ao criar a empresa. Verifique os dados e tente novamente."	Ocorre quando a criação de uma empresa falha.
ERR_CMP_USER_ASSOCIATE	"Falha ao associar o usuário à empresa. Verifique os dados e tente novamente."	Ocorre quando a associação de um usuário a uma empresa falha.
ERR_CMP_FIND	"Não foi possível recuperar os dados da empresa. Por favor, tente novamente."	Ocorre quando a recuperação dos dados da empresa falha.
ERR_CMP_UPDATE	"Falha ao atualizar a empresa. Por favor, tente novamente mais tarde."	Ocorre quando a atualização dos dados da empresa falha.
ERR_CMP_RELATIONS_FIND	"Falha ao recuperar as relações da empresa. Por favor, tente novamente mais tarde."	Ocorre quando a recuperação das relações da empresa falha.
ERR_CMP_INVALID_SLAVE	"A empresa especificada não é um local de captura."	Ocorre quando a empresa não é identificada como um "slave".
ERR_CMP_COUNT_GET	"Não foi possível recuperar os dados da empresa."	Ocorre quando a contagem de empresas falha.
ERR_CMP_TOKEN_GENERATE	"Não foi possível gerar um novo token."	Ocorre quando a geração de um novo token falha.
ERR_CMP_RELATED_COMPANIES_NOT_FOUND	"A empresa não possui locais de captura."	Ocorre quando nenhuma empresa relacionada é encontrada.
ERR_CMP_INVALID_MASTER	"Erro ao acessar a empresa. Por favor, tente novamente."	Ocorre quando a empresa não é identificada como um "master".
ERR_CMP_INVALID_ID	"Os dados de empresa fornecidos são inválidos. Verifique-os e tente novamente."	Ocorre quando o ID da empresa fornecido é inválido.
ERR_CMP_ACCESS_NOT_ALLOWED	"Acesso não autorizado."	Ocorre quando há uma tentativa de acesso não autorizada.
ERR_CMP_INVALID_REQUEST	"Requisição inválida. Por favor, verifique os dados fornecidos."	Ocorre quando uma requisição é inválida ou malformada.
ERR_CMP_LOCAL_SERVICE_DELETE	"Ocorreu um erro ao remover o local de captura."	Ocorre quando a remoção de um serviço local falha.
ERR_CMP_INVALID_PARAMS	"Parâmetros inválidos"	Ocorre quando os parâmetros fornecidos para a operação são inválidos.

Endpoint: CompanyConfig

Código	Mensagem	Descrição
ERR_CMP_CFG_FIND	"Não foi possível carregar as configurações da empresa. Por favor, tente novamente."	Ocorre quando a recuperação das configurações da empresa falha.
ERR_CMP_CFG_INVALID_REQUEST	"Requisição inválida. Verifique os dados e tente novamente."	Ocorre quando a requisição é inválida ou malformada.
ERR_CMP_CFG_ACCESS_NOT_ALLOWED	"Acesso não autorizado. Seu perfil de usuário não tem permissão para acessar esses dados."	Ocorre quando há uma tentativa de acesso não autorizada devido às permissões do perfil de usuário.

Endpoint: CompanySupervisor

Código	Mensagem	Descrição
ERR_CMP_SUP_DELETE	"Não foi possível remover o supervisor da empresa. Tente novamente."	Ocorre quando a remoção das relações entre supervisor e empresa falha.
ERR_CMP_SUP_CREATE	"Não foi possível criar o supervisor para a empresa. Tente novamente."	Ocorre quando a criação das relações entre supervisor e empresa falha.
ERR_CMP_SUP_FIND	"Nenhum supervisor foi encontrado para esta empresa."	Ocorre quando a recuperação das relações entre supervisor e empresa falha.
ERR_CMP_SUP_INVALID_REQUEST	"Requisição inválida. Verifique os dados e tente novamente."	Ocorre quando a requisição é inválida ou malformada.

Endpoint: Face

Código	Mensagem	Descrição
ERR_FCE_IMAGE_PROCESSING	"Falha ao processar a imagem. Tonte realizar a verificação novamente."	Ocorre quando o processamento da imagem falha.
ERR_FCE_VERIFICATION	"Falha ao verificar a face na imagem. Tente realizar a verificação novamente."	Ocorre quando a verificação de face na imagem falha.
ERR_FCE_INVALID_REQUEST	"Requisição inválida. Verifique os dados e tente novamente."	Ocorre quando a requisição é inválida ou malformada.
ERR_FCE_INVALID_PARAMS	"Parâmetros inválidos"	Ocorre quando a requisição contém parâmetros inválidos.

Endpoint: Integrations

Código	Mensagem	Descrição
ERR_INT_JUSTIFY_FIND	"Falha ao recuperar as justificativas. Verifique os dados e tente novamente."	Ocorre quando há falha ao recuperar justificativas do banco de dados.
ERR_INT_JUSTIFY_ALREADY_EXISTS	"A justificativa já existe. Verifique os dados e tente novamente."	Ocorre quando se tenta criar uma justificativa que já existe no sistema.
ERR_INT_JUSTIFY_CREATE	"Falha ao criar a justificativa. Verifique os dados e tente novamente."	Ocorre quando há falha ao criar uma nova justificativa.
ERR_INT_JUSTIFY_UPDATE	"Falha ao atualizar a justificativa. Tente novamente mais tarde."	Ocorre quando há falha ao atualizar a justificativa.
ERR_INT_ACCESS_NOT_ALLOWED	"Acesso não autorizado. Seu perfil de usuário não tem permissão para criar justificativas."	Ocorre quando o acesso não é autorizado.
ERR_INT_INVALID_REQUEST	"Requisição inválida. Verifique os dados e tente novamente."	Ocorre quando a requisição é inválida ou malformada.
ERR_INT_INVALID_PARAMS	"Parâmetros inválidos"	Ocorre quando a requisição contém parâmetros inválidos.

Endpoint: Justify

Código	Mensagem	Descrição
ERR_JUS_FIND	"Falha ao recuperar as justificativas. Verifique os dados e tente novamente."	Ocorre quando há falha ao recuperar justificativas.
ERR_JUS_COUNT_GET	"Falha ao recuperar a contagem total de justificativas. Verifique os dados e tente novamente."	Ocorre quando há falha ao recuperar a contagem total de justificativas.
ERR_JUS_NOT_FOUND	"Registro não encontrado para atualizar. Verifique os dados e tente novamente."	Ocorre quando um registro de justificativa não é encontrado.
ERR_JUS_UPDATE	"Falha ao atualizar a justificativa. Verifique os dados e tente novamente."	Ocorre quando há falha ao atualizar a justificativa.
ERR_JUS_ALREADY_EXISTS	"Justificativa já cadastrada."	Ocorre quando a justificativa já existe.
ERR_JUS_CREATE	"Falha ao criar a justificativa. Verifique os dados e tente novamente."	Ocorre quando há falha ao criar uma justificativa.
ERR_JUS_INVALID_REQUEST	"Requisição inválida. Verifique os dados e demais parâmetros e tente novamente."	Ocorre quando a requisição é inválida ou malformada.
ERR_JUS_ACCESS_NOT_ALLOWED	"Usuário não autorizado para atualizar a justificativa."	Ocorre quando o acesso não é autorizado.
ERR_JUS_INVALID_ID	"O ID da justificativa fornecido não é válido."	Ocorre quando o ID da justificativa é inválido.
ERR_JUS_INVALID_PARAMS	"Parâmetros inválidos"	Ocorre quando a requisição contém parâmetros inválidos.

Endpoint: Logs

Código	Mensagem	Descrição
ERR_LOG_LIVENESS_IMAGE_FIND	"Não foi possível verificar a imagem. Verifique os dados e tente novamente."	Ocorre quando há falha ao recuperar a imagem para verificação de liveness.
ERR_LOG_LIVENESS_VALIDATE	"Falha na validação do Liveness. Verifique os dados e tente novamente."	Ocorre quando a validação do Liveness falha.
ERR_LOG_FIND	"Falha ao recuperar os logs. Tente novamente."	Ocorre quando há falha ao recuperar os logs.
ERR_LOG_ACTION_LOGS_FIND	"Falha ao recuperar os registros. Tente novamente."	Ocorre quando há falha ao recuperar os registros de ações.
ERR_LOG_INVALID_DATA	"Logs inválidos. Verifique os dados fornecidos."	Ocorre quando os dados dos logs são inválidos.
ERR_LOG_MAIN_IMAGE_GET	"Falha ao recuperar a imagem principal. Tente novamente."	Ocorre quando há falha ao recuperar a imagem principal do S3.
ERR_LOG_INVALID_REQUEST	"Requisição inválida. Verifique os dados e demais parâmetros e tente novamente."	Ocorre quando a requisição é inválida ou malformada.
ERR_LOG_INTERACTION_STATUS_PARSING	"Falha ao verificar o status da interação. Verifique os dados e tente novamente."	Ocorre quando há falha ao analisar o status da interação.
ERR_LOG_IMAGE_PATH_GET	"Falha ao recuperar a imagem. Tente novamente."	Ocorre quando há falha ao recuperar o caminho da imagem no S3.
ERR_LOG_ACCESS_NOT_ALLOWED	"Acesso não permitido. Você não tem permissão para realizar esta ação."	Ocorre quando o acesso não é autorizado.
ERR_LOG_ID_REQUIRED	"O número de carteirinha não foi fornecido. Verifique os dados e tente novamente."	Ocorre quando o ID obrigatório não é fornecido na requisição.

Endpoint: Middleware

Código	Mensagem	Descrição
ERR_MDW_INVALID_BASIC	"Não autorizado. Basic token com formato incorreto."	Ocorre quando o formato do token Basic é inválido.
ERR_MDW_INVALID_BEARER	"Não autorizado. Bearer token com formato incorreto."	Ocorre quando o formato do token Bearer é inválido.
ERR_MDW_INVALID_SETTINGS	"Não autorizado. Não foi possível realizar as definições de acesso."	Ocorre quando os parâmetros das configurações da conta são inválidos.
ERR_MDW_INVALID_TOKEN	"Não autorizado. Token inválido."	Ocorre quando o token fornecido é inválido.
ERR_MDW_INVALID_DATA	"Não autorizado. Dados inválidos."	Ocorre quando os dados do token são inválidos.

Endpoint: ProcedureExempt

Código	Mensagem	Descrição
ERR_EXP_PROC_CREATE	"Falha ao criar a isenção. Verifique os dados e tente novamente."	Ocorre quando a criação de uma isenção de procedimento falha.
ERR_EXP_PROC_FIND	"Erro ao recuperar os dados de isenção. Verifique os dados e tente novamente."	Ocorre quando a recuperação de uma isenção de procedimento falha.
ERR_EXP_PROC_DELETE	"Falha ao excluir a isenção. Verifique os dados e tente novamente."	Ocorre quando a exclusão de uma isenção de procedimento falha.
ERR_EXP_PROC_INVALID_REQUEST	"Requisição inválida. Verifique os dados e demais parâmetros, e tente novamente."	Ocorre quando a requisição é inválida ou malformada.
ERR_EXP_PROC_INVALID_PARAMS	"Parâmetros inválidos"	Ocorre quando os parâmetros da isenção de procedimento são inválidos.

Endpoint: Procedures

Código	Mensagem	Descrição
ERR_PROC_RETRIEVAL	"Falha ao recuperar o registro. Verifique os dados e tente novamente."	Ocorre quando a recuperação de um procedimento falha.
ERR_PROC_ALREADY_EXISTS	"O registro já está cadastrado para a empresa. Por favor, escolha um diferente."	Ocorre quando o procedimento já existe para a empresa.
ERR_PROC_CREATION	"Falha ao criar o registro. Verifique os dados e tente novamente."	Ocorre quando a criação de um novo procedimento falha.
ERR_PROC_INVALID_REQUEST	"Requisição inválida ou mal formada. Verifique os dados e demais parâmetros e tente novamente."	Ocorre quando a requisição é inválida ou malformada.
ERR_PROC_INVALID_PARAMS	"Os parâmetros fornecidos são inválidos. Verifique os dados e tente novamente."	Ocorre quando os parâmetros fornecidos são inválidos.

Endpoint: Recognize

Código	Mensagem	Descrição
ERR_RCZ_RK_COLLECTION_NOT_FOUND	"Nenhuma coleção de imagens encontrada para a empresa."	Ocorre quando o sistema falha ao recuperar a coleção de reconhecimento.
ERR_RCZ_RK_COLLECTION_UPDATE	"Não foi possível atualizar a coleção de imagens."	Ocorre quando o sistema falha ao atualizar a coleção de reconhecimento.
ERR_RCZ_RK_COLLECTION_CREATE	"Não foi possível criar a coleção de imagens para a empresa."	Ocorre quando o sistema falha ao criar a coleção de reconhecimento.
ERR_RCZ_COLLECTION_CREATE	"Ocorreu um erro ao tentar criar a coleção de imagens para a empresa."	Ocorre quando o sistema falha ao criar a coleção no serviço de reconhecimento.
ERR_RCZ_COMPANY_CONFIG_NOT_FOUND	"Não foi possível encontrar as configurações da empresa."	Ocorre quando o sistema falha ao recuperar as configurações da empresa.
ERR_RCZ_COMPANY_CONFIG_UPDATE	"Não foi possível atualizar as configurações da empresa."	Ocorre quando o sistema falha ao atualizar as configurações da empresa.
ERR_RCZ_CARD_NOT_FOUND	"Não foi possível encontrar a pessoa com os parâmetros fornecidos."	Ocorre quando o sistema falha ao recuperar o cartão pelo ID.
ERR_RCZ_CARD_CREATE	"Ocorreu um erro ao salvar os dados da pessoa."	Ocorre quando o sistema falha ao criar um novo cartão.
ERR_RCZ_RK_USER_CREATE	"Não foi possível criar a pessoa referente à imagem fornecida."	Ocorre quando o sistema falha ao criar o usuário de reconhecimento.
ERR_RCZ_USER_CREATE	"Não foi possível criar o usuário."	Ocorre quando o sistema falha ao criar um novo usuário.
ERR_RCZ_CARD_IMAGE_CREATE	"Ocorreu um erro ao criar a imagem para a pessoa."	Ocorre quando o sistema falha ao criar a imagem do cartão.
ERR_RCZ_IMAGE_FORMAT	"Ocorreu um erro ao verificar o formato da imagem enviada."	Ocorre quando o sistema falha ao formatar a imagem.
ERR_RCZ_INDEX_USER_IMAGE	"Ocorreu um erro ao registrar a imagem da pessoa."	Ocorre quando o sistema falha ao indexar a imagem do usuário.
ERR_RCZ_RK_FACE_CREATE	"Ocorreu um erro ao salvar os dados da face da pessoa."	Ocorre quando o sistema falha ao criar a face de reconhecimento.
ERR_RCZ_ASSOCIATE_IMAGE	"Ocorreu um erro ao associar a imagem fornecida com a pessoa."	Ocorre quando o sistema falha ao associar a imagem ao usuário.
ERR_RCZ_RK_FACE_UPDATE	"Ocorreu um erro ao coletar e atualizar os dados da face da pessoa."	Ocorre quando o sistema falha ao atualizar a face de reconhecimento.
ERR_RCZ_RK_USER_IMAGE_NOT_FOUND	"Nenhuma pessoa foi encontrada para a imagem fornecida."	Ocorre quando o sistema falha ao pesquisar usuários pela imagem.
ERR_RCZ_RK_USER_NOT_FOUND	"Nenhuma pessoa foi encontrada com os parâmetros fornecidos."	Ocorre quando o sistema falha ao recuperar o usuário de reconhecimento.
ERR_RCZ_MAIN_IMAGE_NOT_FOUND	"Nenhuma imagem principal foi encontrada para a pessoa informada."	Ocorre quando o sistema falha ao recuperar a imagem principal pelo ID do cartão.
ERR_RCZ_OBJECT_NOT_FOUND	"Ocorreu um erro ao acessar os dados da imagem cadastrada."	Ocorre quando o sistema falha ao recuperar um objeto do S3.
ERR_RCZ_RK_USER_ALREADY_EXISTS	"A pessoa informada já está registrada no sistema."	Ocorre quando um usuário já existe na plataforma de reconhecimento.
ERR_RCZ_INVALID_REQUEST	"Requisição inválida ou mal formada. Verifique os dados e demais parâmetros e tente novamente."	Ocorre quando o sistema recebe uma requisição inválida.
ERR_RCZ_COMPANY_NOT_ALLOWED	"Empresa não autorizada para realizar este tipo de operação."	Ocorre quando o perfil da empresa não é permitido para a ação solicitada.

Endpoint: Report

Código	Mensagem	Descrição
ERR_RPT_FORMAT	"Ocorreu um erro ao formatar os dados do relatório."	Ocorre quando há um erro ao formatar a mensagem do relatório.
ERR_RPT_CREATE	"Ocorreu um erro ao gerar o relatório."	Ocorre quando há um erro ao salvar o relatório no banco de dados.
ERR_RPT_PROCESSING	"Ocorreu um erro ao processar o relatório."	Ocorre quando há um erro ao enviar o relatório para a fila de processamento.
ERR_RPT_UPDATE	"Ocorreu um erro ao atualizar o relatório."	Ocorre quando há um erro ao atualizar o relatório.
ERR_RPT_INVALID_REQUEST	"Requisição inválida ou mal formada. Verifique os dados e demais parâmetros e tente novamente."	Ocorre quando o sistema recebe uma requisição inválida.
ERR_RPT_INVALID_REQUEST_PARAMS	"Os parâmetros fornecidos não são válidos."	Ocorre quando os parâmetros da requisição são inválidos.
ERR_RPT_GET_COUNT	"Ocorreu um erro ao verificar o total de relatórios gerados."	Ocorre quando há um erro ao obter o total de relatórios no banco de dados.
ERR_RPT_NOT_FOUND	"Nenhum relatório gerado até o momento."	Ocorre quando o sistema falha ao recuperar relatórios do banco de dados.
ERR_RPT_CODE_NOT_FOUND	"Nenhum relatório encontrado para o código informado."	Ocorre quando o sistema falha ao recuperar relatórios pelo código.
ERR_RPT_INVALID_PARAMS	"Parâmetros inválidos."	Ocorre quando o sistema recebe parâmetros de relatório inválidos.
ERR_RPT_NOT_COMPLETED	"O relatório está sendo processado. Por favor, aguarde mais alguns instantes."	Ocorre quando o relatório ainda está sendo processado.
ERR_RPT_DOWNLOAD_FILE	"Ocorreu um erro ao baixar os dados do relatório gerado."	Ocorre quando há um erro ao baixar o arquivo do relatório do S3.
ERR_RPT_CREATE_FILE_NAME	"Ocorreu um erro ao gerar o nome do relatório."	Ocorre quando há um erro ao criar o nome do arquivo do relatório.
ERR_RPT_COMPANY_NOT_ALLOWED	"Empresa não autorizada para realizar este tipo de operação."	Ocorre quando a empresa não está autorizada para realizar a operação.
ERR_RPT_MISSING_REPORT_ID	"Um ID válido do relatório deve ser informado."	Ocorre quando o ID do relatório está ausente ou é inválido.

Endpoint: RequestNewImage

Código	Mensagem	Descrição
ERR_RNI_GET	"Falha na operação de obtenção do banco de dados."	Ocorre quando a operação de obtenção no banco de dados falha.
ERR_RNI_GET_COUNT	"Falha na operação de contagem no banco de dados."	Ocorre quando a operação de contagem no banco de dados falha.
ERR_RNI_NOT_FOUND	"Solicitação de mudança de imagem não encontrada."	Ocorre quando a solicitação de mudança de imagem não é encontrada.
ERR_RNI_APPROVAL_NOT_ALLOWED	"Empresa não autorizada a aprovar a solicitação."	Ocorre quando a empresa não está autorizada a aprovar a solicitação.
ERR_RNI_REJECTION_NOT_ALLOWED	"Empresa não autorizada a rejeitar a solicitação."	Ocorre quando a empresa não está autorizada a rejeitar a solicitação.
ERR_RNI_CARD_UPDATE	"Falha ao atualizar os dados do cartão e da solicitação."	Ocorre quando a atualização dos dados do cartão e da solicitação falha.
ERR_RNI_STATUS_UPDATE	"Falha ao atualizar o status da solicitação de nova imagem."	Ocorre quando a atualização do status da solicitação de nova imagem falha.
ERR_RNI_AUTO_UPDATE	"Falha ao atualizar automaticamente o status da solicitação de nova imagem."	Ocorre quando a atualização automática do status da solicitação falha.
ERR_RNI_FORMAT_IMAGE	"Falha ao formatar a imagem fornecida."	Ocorre quando a formatação da imagem fornecida falha.
ERR_RNI_FACE_NOT_DETECTED	"Nenhum rosto detectado na imagem fornecida."	Ocorre quando nenhum rosto é detectado na imagem fornecida.
ERR_RNI_LIVENESS_FAILED	"Falha na verificação de vivacidade devido a um erro interno."	Ocorre quando a verificação de vivacidade falha devido a um erro interno.
ERR_RNI_CARD_STATUS_UPDATE	"Falha ao atualizar o status do cartão no banco de dados."	Ocorre quando a atualização do status do cartão no banco de dados falha.
ERR_RNI_CARD_NOT_FOUND	"O cartão especificado não foi encontrado."	Ocorre quando o cartão especificado não é encontrado.
ERR_RNI_COMPANY_NOT_FOUND	"A empresa especificada não foi encontrada."	Ocorre quando a empresa especificada não é encontrada.
ERR_RNI_IMAGE_UPDATE_DISABLED	"A funcionalidade de mudança de imagem está desativada para esta empresa."	Ocorre quando a funcionalidade de mudança de imagem está desativada para a empresa.
ERR_RNI_SAVE	"Falha ao salvar a solicitação de nova imagem no banco de dados."	Ocorre quando o sistema falha ao salvar a solicitação de nova imagem.
ERR_RNI_INVALID_REQUEST	"Requisição inválida."	Ocorre quando a requisição é inválida.
ERR_RNI_INVALID_REQUEST_PARAMS	"Os parâmetros fornecidos na requisição são inválidos."	Ocorre quando os parâmetros fornecidos na requisição são inválidos.

Endpoint: User

Código	Mensagem	Descrição
ERR_USR_INVALID_REQUEST	"Requisição inválida ou mal formada."	Este erro ocorre quando a requisição do usuário não está corretamente formatada ou contém dados inválidos.
ERR_USR_INVALID_PARAMS	"Parâmetros inválidos"	Este erro ocorre quando os parâmetros fornecidos pelo usuário não são válidos.
ERR_USR_NOT_FOUND	"Nenhum usuário foi encontrado com os parâmetros fornecidos."	Este erro ocorre quando nenhum usuário correspondente aos parâmetros fornecidos é encontrado no sistema.
ERR_USR_UPDATE	"Não foi possível atualizar os dados do usuário."	Este erro ocorre quando o sistema falha ao tentar atualizar os dados do usuário no banco de dados.
ERR_USR_EMAIL_CONFIRMATION	"Não foi possível enviar o e-mail de confirmação."	Este erro ocorre quando o sistema não consegue enviar um e-mail de confirmação para o endereço fornecido.
ERR_USR_USER_COMPANY_NOT_FOUND	"Nenhuma empresa encontrada para este usuário."	Este erro ocorre quando não é encontrada nenhuma empresa vinculada ao usuário especificado.
ERR_USR_UPDATE_USER_COMPANY	"Não foi possível atualizar os dados da empresa."	Este erro ocorre quando o sistema falha ao tentar atualizar os dados da empresa associada ao usuário.
ERR_USR_UPDATE_USER_COMPANY_STATUS	"Não foi possível atualizar o status do usuário."	Este erro ocorre quando o sistema falha ao tentar atualizar o status do usuário para a empresa associada.
ERR_USR_CREATE_USER_COMPANY	"Não foi possível salvar os dados do usuário."	Este erro ocorre quando o sistema falha ao tentar salvar os dados da empresa para o usuário no banco de dados.
ERR_USR_INVALID_USER_ID	"O código de identificação do usuário não é válido."	Este erro ocorre quando o sistema falha ao analisar ou processar o código de identificação (ID) do usuário.
ERR_USR_EMAIL_ALREADY_CREATED	"Não foi possível criar um novo usuário."	Este erro ocorre quando já existe um usuário cadastrado com o e-mail fornecido.
ERR_USR_FIND	"Ocorreu um erro ao verificar os dados do usuário."	Este erro ocorre quando o sistema falha ao tentar buscar ou verificar os dados de um usuário no banco de dados.
ERR_USR_CREATE	"Não foi possível criar um novo usuário."	Este erro ocorre quando o sistema falha ao tentar criar um novo usuário no banco de dados.
ERR_USR_DELETE	"Ocorreu um erro ao tentar desativar o usuário."	Este erro ocorre quando o sistema falha ao tentar desativar ou excluir um usuário no banco de dados.