API Parceiros
Bem-vindo à documentação da API de integração com o sistema Crefaz On.
A API do Crefaz On pode ser utilizada para o envio e acompanhamento de propostas.
A integração com a API é gratuita! Não cobramos taxas ou mensalidades por sua utilização. Atuamos dessa forma para proporcionar comodidade aos nossos parceiros e estimular a integração com nossos serviços, contribuindo assim para uma operacionalização muito mais otimizada.
Ultíma Atualização: 15/07/2024 14:30
Introdução a API
Autenticação
A API utiliza autenticação através de uma chave de API (apiKey) e credenciais do usuário (login e...
Contexto
Este sistema disponibiliza diversas rotas para acesso a informações relacionadas ao contexto de o...
Informações de Contexto
Contexto Este documento fornece informações sobre as rotas disponíveis para acessar dados relaci...
GET Listar Contexto Ocupação
Introdução Retorna uma lista com diversas opções de ocupação, que podem ser utilizadas na propos...
GET Listar Contexto Proposta
Introdução Retorna uma lista com diversas opções e diferentes contextos, que podem ser utilizada...
GET Listar Contexto Grau Instrução
Introdução Retorna uma lista com diversas opções de grau de instrução, que podem ser utilizadas ...
Endereço
Informações de Endereço
Endereço Esta seção descreve as rotas disponíveis para consultar informações sobre endereços. R...
POST Consultar Cidade
Introdução Retorna os dados de uma determinada cidade/UF informada. Rota /Endereco/Cidade A...
GET Listar Países
Introdução Retorna uma listagem de países e alguns parâmetros relacionados. Rota /Endereco/P...
Proposta
Informações da Proposta
Proposta Este documento fornece informações sobre as rotas disponíveis para acessar dados relaci...
GET Consultar Disponibilidade Produto
Introdução Retorna uma lista de produtos disponíveis a partir da cidade consultada, informada at...
POST Cadastrar Proposta
Introdução Cadastra uma nova proposta e aciona o motor de crédito. Rota /Proposta Authoriza...
POST Consultar proposta em andamento
Introdução Cadastra uma nova proposta e aciona o motor de crédito. Rota /Proposta/proposta-e...
GET Listar Ofertas
Introdução Retorna uma lista de produtos ofertados para a proposta, juntamente com os valores di...
POST Calcular Vencimento
Introdução Retorna o vencimento previsto da primeira cobrança para o cliente. Rota /Proposta...
POST Consultar Valor Limite
Introdução Retorna o valor limite que pode ser solicitado e o valor máximo das parcelas. Rota...
POST Simular Oferta
Introdução Retorna as opções disponíveis de quantidade de parcelas e valor das respectivas parce...
PUT Selecionar Oferta
Introdução Seleciona a oferta de acordo com os parâmetros fornecidos. Rota /Proposta/oferta-...
POST Listar Tipos Anexos
Introdução Retorna uma lista contendo os documentos que devem/podem ser enviados, de acordo com ...
PUT Efetuar Upload Arquivos
Introdução Efetua o upload de arquivos em Base64. É necessário utilizar o prefixo "data:image...
PUT Cadastrar / Atualizar Proposta
Introdução Completa o envio da proposta (cadastro), deixando a mesma no status de aguardando a...
GET Consultar Proposta
Introdução Retorna todos os dados da proposta que foram cadastrados até o momento da chamada. ...