1. Account
  • Introdução
    • Comece por aqui
  • Auth
    • Introdução
    • Geração de Token de Acesso
      POST
  • Account
    • Introdução
    • Criar um usuário
      POST
    • Esquemas
      • Schemas
        • Continental.NotaFacil.Domain.OperationMessages.OperationMessage
        • Continental.NotaFacil.Domain.OperationMessages.OperationMessageTypes
        • Continental.NotaFacil.Domain.OperationMessages.OperationResponse`1[Olive.Account.Domain.Models.AdminUserModel]
        • Continental.NotaFacil.Domain.OperationMessages.OperationResponse`1[Olive.Account.Domain.Models.AdminUserProfileModel]
        • Continental.NotaFacil.Domain.OperationMessages.OperationResponse`1[System.Boolean]
        • Continental.NotaFacil.Domain.OperationMessages.OperationResponse`1[System.Collections.Generic.List`1[Olive.Account.Domain.Models.AdminUserModel]]
        • Continental.NotaFacil.Domain.OperationMessages.OperationResponse`1[System.Collections.Generic.List`1[Olive.Account.Domain.Models.AdminUserProfileModel]]
        • Continental.NotaFacil.Domain.OperationMessages.OperationResponse`1[System.Collections.Generic.List`1[Olive.Account.Domain.Models.CompanyModel]]
        • Continental.NotaFacil.Domain.OperationMessages.OperationResponse`1[System.Collections.Generic.List`1[Olive.Account.Domain.Models.RoleRegisterModel]]
        • Continental.NotaFacil.Domain.OperationMessages.OperationResponse`1[System.Collections.Generic.List`1[Olive.Account.Domain.Models.UserModel]]
        • Continental.NotaFacil.Domain.OperationMessages.OperationResponse`1[System.Guid]
        • Olive.Account.Domain.Enums.EnumAccountRole
        • Olive.Account.Domain.Enums.EnumAdminRole
        • Olive.Account.Domain.Enums.EnumGender
        • Olive.Account.Domain.Enums.EnumRole
        • Olive.Account.Domain.Enums.OrderByEnum
        • Olive.Account.Domain.InputModel.AddressInputModel
        • Olive.Account.Domain.InputModel.AdminUserFilterInputModel
        • Olive.Account.Domain.InputModel.AdminUserInputModel
        • Olive.Account.Domain.InputModel.AdminUserProfileFilterInputModel
        • Olive.Account.Domain.InputModel.PartnerUserInputModel
        • Olive.Account.Domain.InputModel.UpdateAdminUserProfileFeaturePermissionInputModel
        • Olive.Account.Domain.InputModel.UpdateAdminUserProfileInputModel
        • Olive.Account.Domain.InputModel.UserFilterInputModel
        • Olive.Account.Domain.InputModel.UserInputModel
        • Olive.Account.Domain.InputModel.UserUpdateInputModel
        • Olive.Account.Domain.Models.AddressModel
        • Olive.Account.Domain.Models.AdminUserModel
        • Olive.Account.Domain.Models.AdminUserProfileModel
        • Olive.Account.Domain.Models.CompanyModel
        • Olive.Account.Domain.Models.RoleRegisterModel
        • Olive.Account.Domain.Models.UserModel
        • Olive.Account.Domain.ViewModel.AddressViewModel
        • Olive.Account.Domain.ViewModel.ErrorsViewModel
        • Olive.Account.Domain.ViewModel.ResponseViewModel`1[Olive.Account.Domain.ViewModel.UserDetailsViewModel]
        • Olive.Account.Domain.ViewModel.ResponseViewModel`1[System.String]
        • Olive.Account.Domain.ViewModel.UserDetailsViewModel
        • System.IO.File
  • Questionnaire
    • Introdução
    • Idade Biológica
      • Listar perguntas do formulário de Idade Biológica
      • Buscar resultado do usuário
      • Buscar respostas do usuário
      • Calcular Idade Biológica
    • Fatores de Risco
      • Listar formulários de Risco
      • Lista formulários disponíveis e os já respondidos pelo usuário
      • Lista perguntas de um formulário de risco
      • Lista as respostas de um usuário em um questionário
      • Calcula o índice de risco a partir das respostas do usuário
      • Lista índice de risco do usuário a partir de formulários respondidos
    • Esquemas
      • Schemas
        • AnswerViewModel
        • BiologicalAgeAnswer
        • BiologicalAgeAnswerInputModel
        • BiologicalAgeQuestion
        • BiologicalAgeQuestionInputModel
        • BiologicalAgeQuestionnaire
        • BiologicalAgeUserAnswer
        • BiologicalAgeUserAnswersViewModel
        • BiologicalAgeUserAnswersViewModelListResponseViewModel
        • CalculateBiologicalAgeInputModel
        • CalculateRiskInputModel
        • Category
        • CustomAnswer
        • CustomQuestion
        • CustomQuestionInputModel
        • CustomQuestionnaire
        • CustomUserAnswer
        • EnumGender
        • EnumStatus
        • ErrorsViewModel
        • Int32ResponseViewModel
        • QuestionViewModel
        • QuestionnaireViewModel
        • RiskAnswer
        • RiskAnswerInputModel
        • RiskQuestion
        • RiskQuestionInputModel
        • RiskQuestionnaire
        • RiskQuestionnaireBasicInfoViewModel
        • RiskQuestionnaireBySessionViewModel
        • RiskScore
        • RiskUserAnswer
        • SaveCustomInputModel
        • SavePublicCustomQuestionnaireInputModel
        • StringResponseViewModel
        • User
        • UserBiologicalAgeQuestionnaire
        • UserCustomQuestionnaire
        • UserRiskQuestionnaire
        • UserRisksViewModel
        • UserRisksViewModelListResponseViewModel
  • Dr. Olive
    • Introdução
    • Listar diagnósticos
      GET
    • Listar diagnóstico
      GET
    • Buscar sintomas
      GET
    • Detalhar sintomas
      GET
    • Lista fatores de risco por idade
      GET
    • Busca sintomas
      GET
    • Submete formulário
      POST
    • Esquemas
      • Schemas
        • AgeInputModel
        • ChoiceViewModel
        • ConditionViewModel
        • ConflictingEvidence
        • DiagnosisInputModel
        • DiagnosisViewModel
        • DiagnosisViewModelPaginationViewModel
        • EnumGender
        • ErrorsViewModel
        • EvidenceInputModel
        • EvidenceViewModel
        • ExtrasInputModel
        • ResponseApiInfermedicaConcepts
        • ResponseApiInfermedicaDiagnosis
        • ResponseApiInfermedicaExplain
        • ResponseApiInfermedicaSearch
        • ResponseApiInfermedicaSymptoms
        • ResponseApiIntemedicaRecommendSpecialist
        • ResponseCategory
        • ResponseChild
        • ResponseChoice
        • ResponseCondition
        • ResponseConditionDetails
        • ResponseExtras
        • ResponseItem
        • ResponseQuestion
        • ResponseRecommendedSpecialist
        • RiskFactorViewModel
        • SupportingEvidence
        • UnconfirmedEvidence
        • UserDiagnosisViewModel
        • UserListDiagnosisViewModel
        • UserListDiagnosisViewModelPaginationViewModel
  • Clinical Metrics
    • Introdução
    • Listar histórico por usuários
      GET
  1. Account

Introdução

2.png

O que é o Account?#

Account é o serviço de contas de usuário, que visa cadastrar usuários afim de manter registros médicos de um usuário.

Resumo#

Cadastra um novo usuário vindo da integração com um parceiro.
Associa o usuário à empresa do parceiro responsável pela requisição.
Opcionalmente, registra o endereço do usuário no ato da criação.

Quando usar#

Onboarding de clientes oriundos do parceiro.
Campanhas e conversões em que o parceiro precisa provisionar o acesso do usuário.
Criação de conta durante fluxos de contratação, cadastro ou elegibilidade.

Entradas esperadas (visão funcional)#

Identificação pessoal: nome, sobrenome, documento nacional, data de nascimento, gênero.
Contato: e-mail, telefone com DDD.
Opcional: endereço (CEP, cidade, bairro, estado, rua, número e complemento).

Validações e regras de negócio (alto nível)#

O e-mail deve estar disponível (sem duplicidade).
O documento nacional (CPF) deve ser válido e único.
O telefone deve ser compatível com o formato esperado.
Dados de endereço, quando enviados, devem estar completos o suficiente para cadastro.
O usuário criado permanece vinculado à empresa do parceiro.

Resultados#

Sucesso: confirmação de criação do usuário.
Com endereço enviado: endereço incluído e associado ao perfil.
Erros: mensagens claras em casos de dados inválidos, duplicidade ou campos obrigatórios ausentes.

Boas práticas para parceiros#

Garanta o envio de dados de identificação e contato consistentes.
Evite duplicidades verificando previamente e-mail e documento.
Para fluxos automatizados, padronize formatos de entrada (datas, telefone, CEP).
Inclua endereço quando isso fizer parte do seu fluxo de negócio, para evitar cadastros incompletos.

Observações#

Processos internos podem ser disparados após a criação para provisionamento e sincronizações em outros módulos do ecossistema.
Modificado em 2025-09-22 14:34:21
Página anterior
Geração de Token de Acesso
Próxima página
Criar um usuário
Built with