Retorna o Pré-cadastro

🔒

Autenticação necessária

Esta API utiliza autenticação via e-mail e token nos headers da requisição.
Consulte o tutorial completo antes de fazer sua primeira chamada:
Como autenticar nas APIs do CV CRM (v1 — E-mail e Token)

Endpoint destinado à consulta de pré-cadastros (pastas) registrados no sistema CVCRM.

A requisição é realizada por meio dos parâmetros informados na URL, permitindo o filtro por identificador do pré-cadastro (idprecadastro) ou documento do cliente, além da utilização de limite e página para controle da paginação.

Quando informado um identificador ou documento, o endpoint retorna os dados específicos do pré-cadastro correspondente; caso contrário, retorna todos os pré-cadastros disponíveis.

O pré-cadastro representa a etapa inicial de coleta e análise de dados do cliente, utilizada para avaliar sua capacidade de crédito antes da simulação ou reserva de um imóvel — etapa fundamental para agilizar e organizar o processo comercial, especialmente em programas subsidiados pelo governo federal. A autenticação é realizada via headers utilizando e-mail e token.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Parâmetro de busca do pré-cadastro. Aceita o idprecadastro (identificador numérico do pré-cadastro no CVCRM) ou o documento do cliente (CPF ou CNPJ, com ou sem pontuação). O tipo é identificado automaticamente: quando o valor informado é um CPF ou CNPJ válido, a busca é feita pelo documento do cliente; caso contrário, pelo idprecadastro. Para listar todos os pré-cadastros, utilize a mesma rota sem informar este parâmetro (GET /v1/comercial/precadastro).

Query Params
integer

Limite de itens exibidos por página. Quando não informado, o padrão é 30.

integer

Página a ser exibida no controle da paginação. Quando não informada, o padrão é 1.

Headers
string
required
string
required
Responses

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json