Executa consultas para um documento e retorna os resultados normalizados (best-effort por tipo).
curl --request POST \
--url https://api.example.com/api/services/app/Consultas/Consultar \
--header 'Content-Type: application/json-patch+json' \
--data '
{
"document": "<string>",
"types": [
123
],
"scrPeriod": "<string>",
"plate": "<string>"
}
'import requests
url = "https://api.example.com/api/services/app/Consultas/Consultar"
payload = {
"document": "<string>",
"types": [123],
"scrPeriod": "<string>",
"plate": "<string>"
}
headers = {"Content-Type": "application/json-patch+json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json-patch+json'},
body: JSON.stringify({document: '<string>', types: [123], scrPeriod: '<string>', plate: '<string>'})
};
fetch('https://api.example.com/api/services/app/Consultas/Consultar', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/services/app/Consultas/Consultar",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'document' => '<string>',
'types' => [
123
],
'scrPeriod' => '<string>',
'plate' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json-patch+json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/services/app/Consultas/Consultar"
payload := strings.NewReader("{\n \"document\": \"<string>\",\n \"types\": [\n 123\n ],\n \"scrPeriod\": \"<string>\",\n \"plate\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json-patch+json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/services/app/Consultas/Consultar")
.header("Content-Type", "application/json-patch+json")
.body("{\n \"document\": \"<string>\",\n \"types\": [\n 123\n ],\n \"scrPeriod\": \"<string>\",\n \"plate\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/services/app/Consultas/Consultar")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json-patch+json'
request.body = "{\n \"document\": \"<string>\",\n \"types\": [\n 123\n ],\n \"scrPeriod\": \"<string>\",\n \"plate\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"results": [
{
"type": 123,
"typeName": "<string>",
"reference": 123,
"consultationDate": "2023-11-07T05:31:56Z",
"data": "<unknown>"
}
],
"failures": [
{
"type": 123,
"error": "<string>"
}
]
}Base de Consultas
Consultar
POST
/
api
/
services
/
app
/
Consultas
/
Consultar
Executa consultas para um documento e retorna os resultados normalizados (best-effort por tipo).
curl --request POST \
--url https://api.example.com/api/services/app/Consultas/Consultar \
--header 'Content-Type: application/json-patch+json' \
--data '
{
"document": "<string>",
"types": [
123
],
"scrPeriod": "<string>",
"plate": "<string>"
}
'import requests
url = "https://api.example.com/api/services/app/Consultas/Consultar"
payload = {
"document": "<string>",
"types": [123],
"scrPeriod": "<string>",
"plate": "<string>"
}
headers = {"Content-Type": "application/json-patch+json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json-patch+json'},
body: JSON.stringify({document: '<string>', types: [123], scrPeriod: '<string>', plate: '<string>'})
};
fetch('https://api.example.com/api/services/app/Consultas/Consultar', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/services/app/Consultas/Consultar",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'document' => '<string>',
'types' => [
123
],
'scrPeriod' => '<string>',
'plate' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json-patch+json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/services/app/Consultas/Consultar"
payload := strings.NewReader("{\n \"document\": \"<string>\",\n \"types\": [\n 123\n ],\n \"scrPeriod\": \"<string>\",\n \"plate\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json-patch+json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/services/app/Consultas/Consultar")
.header("Content-Type", "application/json-patch+json")
.body("{\n \"document\": \"<string>\",\n \"types\": [\n 123\n ],\n \"scrPeriod\": \"<string>\",\n \"plate\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/services/app/Consultas/Consultar")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json-patch+json'
request.body = "{\n \"document\": \"<string>\",\n \"types\": [\n 123\n ],\n \"scrPeriod\": \"<string>\",\n \"plate\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"results": [
{
"type": 123,
"typeName": "<string>",
"reference": 123,
"consultationDate": "2023-11-07T05:31:56Z",
"data": "<unknown>"
}
],
"failures": [
{
"type": 123,
"error": "<string>"
}
]
}Executa uma ou mais consultas para um documento (CPF/CNPJ) e retorna os resultados
normalizados na mesma resposta. Informe o
O campo
O
document e a lista de types (ver
Listar tipos).
A execução é best-effort por tipo: cada tipo que dá certo entra em results (com o
resultado normalizado em data + uma reference para releitura); cada tipo que falha
entra em failures com o motivo, sem interromper os demais e sem custo para o que falhou.
Para o SCR, use
scrPeriod no formato "yyyy-MM" (mês de referência). Se omitido, usa-se o mês anterior. Tipos que não usam mês de referência ignoram o campo.Para a Consulta Veicular (tipo 103), informe
plate com a placa do veículo (formato ABC1234 ou ABC1D23). É o único tipo que usa esse campo, e os demais o ignoram. Sem uma placa válida, o tipo 103 volta em failures e nada é cobrado por ele.O Serasa (tipo 104) atende somente CPF. Enviá-lo para um CNPJ faz o tipo voltar em
failures. Confira acceptsCpf e acceptsCnpj em Listar tipos.O campo data por tipo
O data de cada resultado varia conforme o type:
type | Tipo | Formato de data (resumo) |
|---|---|---|
| 2 | Score | score, faixas de risco/pagamento/probabilidade |
| 3 | Restrições | totais + lista de restrições financeiras |
| 4 | Protestos | totais + lista de protestos (cartório, valor, datas) |
| 5 | Pendências | totais + consultas recentes + lista de pendências |
| 6 | Limites | creditLimit |
| 7 | Renda | monthIncome |
| 1 | Dados Básicos | nome, nascimento, endereços, e-mails, telefones |
| 9 | SCR (Bacen) | period + resumo do cliente + resumo por modalidade |
| 100 | KYC Ampliado | identidade + PEP + sanções |
| 101 | Notícias e Mídias | lista de matérias |
| 102 | Processos | processos ativos/passivos + partes |
| 103 | Consulta Veicular | identificação do veículo (placa, chassi, renavam, marca/modelo, ano, cor, município/UF) + indicators com os nove indicadores de risco |
| 104 | Serasa | score, faixa e taxa de inadimplência + dados cadastrais + negative por natureza (pefin, refin, protestos, cheques) |
Score, Restrições, Protestos, Pendências, Limites, SCR, KYC, Consulta Veicular e Serasa são executáveis por aqui. Renda, Dados Básicos, Notícias e Processos podem aparecer no seu histórico (originados por outros fluxos), mas não constam em Listar tipos.
curl -X POST "https://gateway.hubcred.com.br/external/v1/api/services/app/Consultas/Consultar" \
-H "Authorization: Bearer SEU_TOKEN" -H "Content-Type: application/json" \
-d '{ "document": "12345678900", "types": [2, 103, 104], "plate": "ABC1D23", "scrPeriod": null }'
Body
application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Dados para executar uma ou mais consultas para um documento.
CPF ou CNPJ do consultado (com ou sem máscara).
Tipos de consulta a executar (ver ListarTipos).
Período do SCR como "yyyy-MM". Ignorado por tipos sem mês de referência. Nulo = mês anterior.
Placa do veiculo. Obrigatoria quando o tipo 103 esta selecionado; os demais tipos ignoram.