APIs do Grupo Booz

Login

Autentica um usuário do portal a partir de login e senha e disponibiliza o token usado nas chamadas autenticadas das demais APIs.

Headers

Body

Exemplo de requisição

curl --request POST \
  --url https://api.grupobooz.com.br/portal/auth/login \
  --header 'Content-Type: application/json' \
  --data '{
    "login": "login",
    "senha": "senha"
}'

Consulta Analyst

Executa a consulta analítica de um CPF ou CNPJ: roda em paralelo os módulos solicitados, grava a consulta no histórico e devolve os dados de cada módulo, o parecer de crédito e o link público do relatório.

Headers

Como funciona

• Os parâmetros são agrupados por módulo. Todos os grupos são opcionais e todo flag tem padrão false: envie só o que deseja consultar.
• Com parecer de crédito (consultaParecerCredito ou consultaParecerCreditoIASpcSerasa) os módulos necessários ao parecer são ativados automaticamente: dados cadastrais, mercado financeiro (evolução semestral), processos, protestos e score; dados profissionais (CPF) ou Sintegra (CNPJ); e restrições SPC/Serasa no parecer com restrições.
• A chamada é síncrona e pode levar de alguns segundos até cerca de 2 minutos, conforme os módulos.

Body

cpfCnpj

Campo na raiz do body.

dadosCadastrais

Dados cadastrais e complementares.

dadosFinanceiros

Mercado financeiro (SCR).

parecerCredito

Parecer de crédito por IA e indicativo de liminar.

processosJudiciais

protestos

pendenciasTributarias

scoreRating

pefinRefinConsultas

compliance

Sem nenhum flag ativo, nenhuma validação roda e compliance volta null.

externo

Exemplo de requisição

curl --request POST \
  --url https://api.grupobooz.com.br/hub/consulta/completa \
  --header 'Authorization: Bearer TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "cpfCnpj": "00000000000191",
    "dadosCadastrais": {
      "consultaDadosCadastrais": true,
      "faturamentoMensalCliente": 150000
    },
    "parecerCredito": {
      "consultaParecerCreditoIASpcSerasa": true,
      "consultaIndicativoLiminar": true,
      "valorNegociacaoParecerCredito": 50000,
      "eCliente": false,
      "pontualidadePagamento": ""
    },
    "protestos": {
      "consultaProtestos": true,
      "consultaProtestosDetalhado": true
    },
    "processosJudiciais": {
      "consultaProcessosJudiciais": true,
      "consultaProcessosJudiciaisDetalhado": true
    },
    "compliance": {
      "validarBlacklistSocios": true,
      "validarLimpaNomeSocios": true
    }
  }'

Resposta da consulta Analyst

Retorno 200 em JSON. Os módulos só aparecem quando foram solicitados (ou ativados pelo parecer).

Erros do Analyst

Em erro, o corpo é { "error": "mensagem" }. Falhas de um módulo isolado não derrubam a consulta.

Como funciona o Boosting

O Boosting busca empresas (CNPJ) por filtros de mercado, enriquece cada uma e grava o resultado como leads. A extração é assíncrona: a chamada só dispara o processamento e devolve o id da consulta.

Fluxo

1. Monte os filtros. Opcionalmente, use /hub/boosting/listarCnaes e /hub/boosting/localidades para obter os códigos de CNAE e os nomes de cidade aceitos.
2. Estime. /hub/boosting/obterConsumoBoosting devolve quantas empresas a busca encontra e o custo. Nada é cobrado nessa etapa.
3. Extraia. /hub/boosting/obterEmpresas com os mesmos filtros cria a consulta, devolve o consultaBoostingId e processa as empresas em segundo plano, em lotes de 100.
4. Acompanhe. /hub/boosting/listarCapas mostra o status da consulta (Processando, Finalizado ou Erro). Se você informou webhookRetorno, também pode receber um aviso ao final.
5. Leia os leads. /hub/boosting/listarConsultasBoosting com o consultaBoostingId devolve as empresas extraídas e os dados enriquecidos.

Listar CNAEs

Lista os CNAEs disponíveis para o filtro, com descrição e agrupamento por segmento.

Headers

Body

Exemplo de requisição

curl --request POST \
  --url https://api.grupobooz.com.br/hub/boosting/listarCnaes \
  --header 'Authorization: Bearer TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "limit": 50,
    "offset": 0
}'

Resposta

Envelope { success, data }. Cada item de data:

Listar cidades de um estado

Devolve os municípios de uma UF com a grafia exata aceita no filtro cidades, sem duplicatas e em ordem alfabética.

Headers

Body

Exemplo de requisição

curl --request POST \
  --url https://api.grupobooz.com.br/hub/boosting/localidades \
  --header 'Authorization: Bearer TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "uf": "SC"
}'

Exemplo de resposta

{
  "uf": "SC",
  "cidades": ["Abdon Batista", "Abelardo Luz", "Agrolândia"]
}

Estimar extração

Conta as empresas que atendem aos filtros e calcula o custo da extração. Não cria consulta nem cobra nada.

Headers

Body

Filtros

Estimativa

Exemplo de requisição

curl --request POST \
  --url https://api.grupobooz.com.br/hub/boosting/obterConsumoBoosting \
  --header 'Authorization: Bearer TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "cnaes": ["47.11-3-02", "47.12-1-00"],
    "situacao": "ativa",
    "portes": ["ME", "EPP"],
    "estado": "SC",
    "cidades": ["Florianópolis"],
    "tipoContato": "email",
    "limite": 500
}'

Resposta

Exemplo de resposta

{
  "quantidadeEmpresas": 500,
  "valorConsultaPreQualificado": 995,
  "valorConsultaQualificado": 2995,
  "valorConsultaPreQualificadoBRL": "R$ 995,00",
  "valorConsultaQualificadoBRL": "R$ 2.995,00",
  "mensagem": "Sua busca com os filtros informados irá retornar 500 empresa(s), ...",
  "filtros": { ... },
  "versao": "2"
}

Extrair empresas

Cria a consulta de Boosting e inicia a extração dos leads em segundo plano. A resposta chega em poucos segundos com o consultaBoostingId; o processamento continua depois dela.

Headers

Como funciona

• Use os mesmos filtros da estimativa. Acompanhe o andamento pelo status em /hub/boosting/listarCapas.
• As empresas são processadas em lotes de 100. Cada empresa extraída é gravada como lead e cobrada pelo valor da versão contratada.
• Com webhookRetorno, ao terminar enviamos POST para a URL com o corpo { "consultaBoostingId": 42 }. O aviso é de melhor esforço: não há reenvio e ele pode não chegar. Confirme sempre pelo status em listarCapas.

Body

Filtros

Os mesmos de Estimar extração, exceto limite.

Extração

Exemplo de requisição

curl --request POST \
  --url https://api.grupobooz.com.br/hub/boosting/obterEmpresas \
  --header 'Authorization: Bearer TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "cnaes": ["47.11-3-02", "47.12-1-00"],
    "situacao": "ativa",
    "portes": ["ME", "EPP"],
    "estado": "SC",
    "cidades": ["Florianópolis"],
    "tipoContato": "email",
    "confirmacao": "preQualificado",
    "limit": 500,
    "validarBlacklist": true,
    "webhookRetorno": "https://minha-empresa.com.br/webhooks/boosting"
}'

Exemplo de resposta

{
  "consultaBoostingId": 42,
  "mensagem": "Processando..."
}

Listar consultas de Boosting

Lista as consultas (extrações) de Boosting da sua empresa, com o status de processamento de cada uma.

Headers

Body

Exemplo de requisição

curl --request POST \
  --url https://api.grupobooz.com.br/hub/boosting/listarCapas \
  --header 'Authorization: Bearer TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "status": "Finalizado",
    "limit": 20,
    "offset": 0
}'

Resposta

{ data, total, limit, offset }. Cada item de data:

Listar leads de uma consulta

Devolve as empresas extraídas por uma consulta de Boosting, com os dados cadastrais e o enriquecimento.

Headers

Body

Exemplo de requisição

curl --request POST \
  --url https://api.grupobooz.com.br/hub/boosting/listarConsultasBoosting \
  --header 'Authorization: Bearer TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "consultaBoostingId": 42,
    "limit": 100,
    "offset": 0
}'

Resposta

{ data, total, limit, offset }. Para paginar, avance offset até chegar a total. Cada item de data:

Erros do Boosting

Em erro, o corpo é { "error": "mensagem" }. Algumas respostas trazem também codigo.