Pular para o conteúdo principal

Guia de Integrações CredAluga

Imobiliária​

O realState é o endpoint para criar e registrar uma imobiliária/parceiro na plataforma. Sem a imobiliária criada, não é possível seguir com Simulações e Propostas.

Endpoints​

  • Criar imobiliária: POST /api/v1/realstate
  • Consultar imobiliária: GET /api/v1/realstate/{id}

Regras​

  • É obrigatório enviar o ApiKey no header de todas as requisições.
  • O ID retornado no POST deve ser usado obrigatoriamente no GET.

Criar imobiliária (POST)​

Simulação de Crédito​

A simulação é o primeiro passo para avaliar o perfil de crédito do inquilino. Com poucas informações do inquilino, da propriedade, dos corresponsáveis (se houver) e dos valores contratuais (aluguel, condomínio, IPTU, outros), é possível verificar se o cliente está pré-aprovado sem precisar preencher todos os dados de uma proposta.

Endpoints​

  • Criar simulação: POST /api/v1/simulations
  • Consultar simulação: GET /api/v1/simulations/{id}
  • Consultar planos disponíveis: GET /api/v1/simulations/{id}/plans

Regras​

  • É obrigatório enviar o ApiKey no header de todas as requisições.
  • O ID retornado no POST deve ser usado obrigatoriamente no GET.
  • A simulação não gera contrato nem reserva crédito, serve apenas como pré-análise.
  • Após consultar os planos, a imobiliária deve escolher um plano para seguir com a proposta.

Criar simulação (POST)​

Consultar simulação (GET)​

Consultar planos (GET)​

Proposta​

A proposta é o passo seguinte à simulação, ela formaliza a análise e permite acessar os planos de fiança disponíveis para contratação.

Para criar uma proposta é necessário informar:

  • ID da simulação aprovada.
  • ID do plano escolhido na API de planos da simulação.

Endpoints​

  • Criar uma proposta: POST /api/v1/proposal
  • Consultar informações da proposta: GET /api/v1/proposal/{id}

Regras​

  • É obrigatório enviar o ApiKey no header de todas as requisições.
  • A criação de uma proposta inicia o processo de onboarding do inquilino.
  • Cada proposta possui um ID único usado no GET.

Criar proposta (POST)​

Consultar proposta (GET)​

Ativação​

Após a proposta, inicia-se o processo de ativação do inquilino (onboarding).

Esse processo garante a autenticação e formalização do contrato (assinatura, biometria, pagamento, etc.).

Endpoints​

  • Consultar ativação: GET /api/v1/activation/{id}

Regras​

  • É obrigatório enviar o ApiKey no header de todas as requisições.
  • Se o inquilino não finalizar em tempo hábil, a proposta vai para Expired (-3), mas o onboarding permanece no último status registrado.

Status do onboarding​

CódigoStatus
(1)Link Enviado
(2)CPF Confirmado
(3)Termos Pendentes
(4)Rosto Identificado
(5)Contrato Assinado
(6)Pagamento Realizado
(8)Contrato Ativo

Consultar ativação (GET)​