CADASTRO DE USUÁRIOS PESSOA FÍSICA

Deprecated

Está API está depreciada e disponível apenas para fins de consulta de sistemas legados.

CRIAR USUÁRIOS PESSOA FÍSICA

A criação de um usuário pessoa física na plataforma, é dividida em três etapas:

  1. Pré-cadastro: Envio dos dados básicos para a criação do usuário, incluindo o cadastro da sua senha;
  2. Token e verificação: Validação do código de verificação e token de criação;
  3. Criação do usuário: Envio dos dados complementares e acesso à plataforma.

Chave única de cadastro

Os seguintes dados são chaves únicas de validação da sua conta. Portanto, não poderão ser utilizados em outro cadastro:

  • CPF
  • E-mail
  • Telefone

Criar usuário pessoa física

  1. Na primeira etapa é dado o início ao cadastro do usuário** com o envio dos seus dados básicos obrigatórios:
  • Número do documento CPF
  • E-mail
  • Telefone (código de área + ddd + número)

Nessa etapa o CPF passará por uma validação de segurança e só será permitido dar sequência ao cadastro se o documento for aprovado nos seguintes itens:

  • Consulta CPF na receita federal - status ativo e regular
  • Maioridade - acima de 18 anos
  • Exposição política - pessoa não exposta
  • Listas de sanções - ausente de sanções
  • Listas de restrições - ausente de restrições

Após a conclusão desta etapa o usuário terá o status de pré-criado, e só será considerado como finalizado depois da conclusão das demais etapas.

As validações descritas serão parametrizáveis e poderão ser desativadas ou ativadas de acordo com o cliente.

Validação de Token

  1. Na segunda etapa é feita a verificação do dispositivo:
  • O código de verificação é um código numérico de 6 dígitos enviado ao usuário através número de telefone e/ou endereço de e-mail informados na requisição. Ele é utilizado para validar ao dispositivo que o usuário que está utilizando para fazer o cadastro.
  • Quando essa etapa for concluída com sucesso, um token será retornado no header chamado Creation-Token. O token de criação do usuário será utilizado mais tarde para identificar o usuário na plataforma e prosseguir com seu cadastro.
  • Tanto o código de verificação quanto o token de criação, deverão ser utilizados na segunda e terceira etapas do processo para validar informações e finalizar o cadastro.

Finalizar criação do usuário pessoa física

  1. Na terceira etapa o cadastro do usuário é finalizado e acontece a criação da senha:

Dados complementares obrigatórios:

  • Nome completo
  • Data de nascimento
  • Nome completo da mãe do cliente

O cadastro da senha deve respeitar as seguintes regras – essas regras podem ser parametrizadas:

Máximo de caracteres: 6

Mínimo de caracteres: 6

Permite alfanumérico: sim Diferente do e-mail: sim

Permite repetição de números: não

Diferente do documento: sim

Permite sequência de números: não

Diferente do telefone: sim Permite sequência de caracteres: não

Nessa etapa será necessário possuir o token de criação do usuário e o código de verificação para dar seguimento ao processo.

Quando essa etapa for concluída com sucesso, um token será retornado no header chamado Creation-Token. O token de criação do usuário será utilizado mais tarde para identificar o usuário na plataforma e prosseguir com seu cadastro

Testes no ambiente de Desenvolvimento

Para viabilizar os testes de cadastros de usuários criamos um código de verificação padrão, que pode ser utilizado quando não houver um número de telefone válido para que o SMS com o código de verificação possa ser enviado.

Para isso, envie o código de verificação no header Challenge com o valor 444444 para que a validação seja confirmada.

Fluxo simplificado do processo

Essas são as etapas que devem ser realizadas para que um usuário pessoa física esteja cadastrado na plataforma.

graph LR
    A(1- Pré-cadastro <br> POST /v1/signup) --> B{CPF<br>Aprovado}
    B -- SIM --> C(2 - Token e verificação <br> PUT v1/signup/validate-<br>sms)

    C --> D{Token e código validados}
    D -- SIM ---> E(3 - Criação do usuário <br> PUT v1/signup) 
    B -- NÃO ---> A
    D -- NÃO ---> C
    
classDef orange fill:#FFEEBB,stroke:#FFAAA7,stroke-width:1px,color:#DF7861;
classDef purple color:#7B6079;
class A,B,C,D,E white;

CADASTRO DE USUÁRIO PESSOA JURÍDICA

Deprecated

Está API está depreciada e disponível apenas para fins de consulta de sistemas legados.

A criação de um usuário pessoa jurídica na plataforma, é dividida em três etapas: sendo a primeira o envio dos dados básicos para a criação do usuário, a segunda etapa, a validação do código de verificação e token de criação, e a terceira etapa, a finalização do cadastro, com o envio dos dados complementares, incluindo o cadastro da sua senha.

Criar usuários e estabelecimentos

Na primeira etapa, é dado o início ao cadastro do usuário pessoa jurídica com o envio dos seus dados básicos, como nome, e-mail e telefone. Será necessário fornecer informações como CNPJ, nome fantasia, CNAE, dentre outros.

Após a conclusão desta etapa, o usuário possuirá o status de pré-criado, e só será considerado como finalizado depois da conclusão das demais etapas.

Código de verificação

O código de verificação é um código numérico de 6 dígitos que é enviado ao usuário através número de telefone e/ou endereço de e-mail informados na requisição. Ele será utilizado para validar a identidade do usuário que está sendo cadastrado.

Token de criação

Quando essa etapa for concluída com sucesso, um token será retornado no header chamado Creation-Token. O token de criação do usuário será utilizado mais tarde para identificar o usuário na plataforma e prosseguir com seu cadastro.

Tanto o código de verificação quanto o token de criação, deverão ser utilizados na segunda e terceira etapas do processo (Validar token de criação e código de verificação e finalizar a criação de um usuário) para validar informações e finalizar o cadastro.

Validar token de criação e código de verificação

A segunda etapa consiste em validar o código de verificação e token de criação antes que o processo de criação de um usuário pessoa jurídica possa ser finalizado, adicionando uma camada extra de segurança ao processo.

Finalizar a criação de um usuário ou estabelecimento

Nesta etapa, o cadastro do usuário é finalizado com o envio dos dados complementares e o cadastro de sua senha. Aqui você ainda precisará possuir o token de criação do usuário e o código de verificação para dar seguimento ao processo.