Guides
API Reference

2. Cadastro

Suggest Edits

  1. Signup Match (Correspondência de cadastro)

    Endpoint:

Corpo da solicitação:

Deve incluir informações detalhadas do usuário e suas preferências de produtos financeiros.

{ 
  "cpf": "00000000191", 
  "name": "Fulano d'Tal", 
  "birthday": "1992-07-25", 
  "email": "[email protected]", 
  "phone": "62987654321", 
  "zipCode": "74180040", 
  "education": "POS_GRADUACAO", 
  "banks": "001", 
  "occupation": "ASSALARIADO", 
  "income": 1045, 
  "hasCreditCard": true, 
  "hasRestriction": true, 
  "hasOwnHouse": true, 
  "hasVehicle": true, 
  "hasAndroid": true, 
  "products": [...], 
  "logData": { 
    "latitude": -16.6982283, 
    "longitude": -49.2581201, 
    "occurrenceDate": "2019-08-21T14:31:17.459Z", 
    "userAgent": "Mozilla/5.0 ...", 
    "ip": "0.0.0.0", 
    "mac": "00:00:00:00:00:00" 
  } 
}

  1. Simple Signup (Cadastro Simples):

Este endpoint é utilizado para o registro básico do usuário na plataforma, sem correspondência inicial com produtos de crédito.

Endpoint:

Corpo da solicitação:

Inclui informações básicas do usuário.

{ 
  "cpf": "00000000191", 
  "name": "Fulano d'Tal", 
  "birthday": "1992-07-25", 
  "email": "[email protected]", 
  "phone": "62987654321", 
  "zipCode": "74180040" 
}

Respostas Comuns

Ambos endpoints podem retornar os seguintes códigos de status e mensagens, dependendo do resultado da operação:

StatusDescrição
201 Created:Sucesso no cadastro
400 Bad Request:Erro de validação de dados.
401 Unauthorized:Falha na autenticação
403 Forbidden:Acesso proibido devido a restrições
404 Not Found:Recurso não encontrado.
409 Conflict:Conflito, como um cadastro duplicado.

Exemplo de Resposta de Sucesso:

{ 
  "id": "20190805062216", 
  "status": "SIGNUP_COMPLETED", 
  "cpf": "191", 
  "name": "Fulano d'Tal", 
  "dateCreated": "2020-10-28T13:50:21.024Z", 
  "lastUpdated": "2020-10-28T13:50:21.024Z" 
}

⚠️

Considerações de Segurança

  • Limite de tentativas: o client_id é bloqueado caso a chamada seja realizada para o mesmo CPF mais de 20 vezes no mesmo dia.
  • Trate todos os dados pessoais com alto nível de segurança e conformidade com as regulamentações de privacidade aplicáveis.

Updated 5 days ago