{"openapi":"3.1.0","info":{"title":"BitBusca para Desenvolvedores","version":"1.0.0","description":"API única das bases da BitBusca: consultas de pessoa, veículo e empresa; empresas em lista (base CNPJ); ficha de imóvel; publicações judiciais (DJEN), processos e prazos; editais de licitação; advogados (cadastro nacional); leads de pessoas físicas; webhooks assinados.\n\nAutenticação: Authorization: Bearer <chave> (ou X-API-Key). Chave de teste bk_test_ devolve dados fictícios e não cobra; bk_live_ usa os créditos do plano. Chaves em https://bitbusca.net/desenvolvedor.\n\nCréditos: cada operação diz o custo. 404 e erros 5xx não cobram. Bases sensíveis têm teto diário (429 COTA_DIARIA).\n\nErros: corpo { error, code }. Códigos estáveis: TOKEN_AUSENTE, TOKEN_INVALIDO, IP_NAO_PERMITIDO, CONTA_INDISPONIVEL, PLANO_DEV_NECESSARIO, ESCOPO_AUSENTE, RECURSO_FORA_DO_PLANO, NO_CREDITS, RATE, LIMITE_DIARIO_CHAVE, COTA_DIARIA, ENUMERACAO, NOT_FOUND, INVALID_INPUT, URL_INVALIDA, PAGE_CAP, BUSCA_AMPLA, LIMITE_CHAVES, LIMITE_WEBHOOKS, LIMITE_DO_PLANO, WEBHOOK_DESLIGADO. 503 = indisponibilidade temporária (tente de novo).\n\nLGPD: dados pessoais só com finalidade legítima. Proibido revender, redistribuir ou montar base derivada.\n\nMCP (Claude, ChatGPT, Cursor…): POST https://api.bitbusca.net/api/v1/mcp.","termsOfService":"https://bitbusca.net/termos","contact":{"name":"BitBusca","url":"https://bitbusca.net/desenvolvedores","email":"sac@bitbusca.net"}},"servers":[{"url":"https://api.bitbusca.net/api","description":"Produção (a chave define se é teste ou produção)"}],"security":[{"bearer":[]},{"apiKey":[]}],"tags":[{"name":"Consultas"},{"name":"Empresas"},{"name":"Imóveis"},{"name":"Jurídico"},{"name":"Licitações"},{"name":"Advogados"},{"name":"Pessoas"},{"name":"Webhooks"},{"name":"Conta"}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Authorization: Bearer bk_live_… (produção) ou bk_test_… (teste, dados fictícios)."},"apiKey":{"type":"apiKey","in":"header","name":"X-API-Key","description":"Alternativa ao Bearer."}},"schemas":{"Erro":{"type":"object","required":["error"],"properties":{"error":{"type":"string","description":"Mensagem pronta para mostrar ao usuário."},"code":{"type":"string","description":"Código estável para o app tratar (TOKEN_AUSENTE, TOKEN_INVALIDO, IP_NAO_PERMITIDO, CONTA_INDISPONIVEL, PLANO_DEV_NECESSARIO, ESCOPO_AUSENTE, RECURSO_FORA_DO_PLANO, NO_CREDITS, RATE, LIMITE_DIARIO_CHAVE, COTA_DIARIA, ENUMERACAO, NOT_FOUND, INVALID_INPUT, URL_INVALIDA, PAGE_CAP, BUSCA_AMPLA, LIMITE_CHAVES, LIMITE_WEBHOOKS, LIMITE_DO_PLANO, WEBHOOK_DESLIGADO…)."}},"additionalProperties":true}},"responses":{"Invalido":{"description":"INVALID_INPUT (valor inválido) ou PAGE_CAP (página além do máximo).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"CPF inválido.","code":"INVALID_INPUT"}}}},"NaoAutenticado":{"description":"TOKEN_AUSENTE ou TOKEN_INVALIDO.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"Chave inválida, revogada ou vencida.","code":"TOKEN_INVALIDO"}}}},"SemCreditos":{"description":"NO_CREDITS: pool e recarga esgotados.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"Créditos de API esgotados.","code":"NO_CREDITS","recarga":"https://bitbusca.net/desenvolvedor/plano"}}}},"Proibido":{"description":"IP_NAO_PERMITIDO, CONTA_INDISPONIVEL, PLANO_DEV_NECESSARIO, ESCOPO_AUSENTE ou RECURSO_FORA_DO_PLANO.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"Esta chave não tem o escopo \"juridico\".","code":"ESCOPO_AUSENTE"}}}},"NaoEncontrado":{"description":"NOT_FOUND: nada encontrado (não cobra).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"Nada encontrado.","code":"NOT_FOUND"}}}},"Limite":{"description":"RATE (req/min; veja Retry-After), LIMITE_DIARIO_CHAVE, COTA_DIARIA ou ENUMERACAO (varredura: chave pausada 1 h).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"Limite de 60 requisições por minuto atingido.","code":"RATE"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Segundos até tentar de novo."}}},"Indisponivel":{"description":"Indisponibilidade temporária. Tente de novo em instantes.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"},"example":{"error":"Consulta temporariamente indisponível."}}}}}},"paths":{"/v1/cpf/{cpf}":{"get":{"operationId":"consultar_cpf","summary":"CPF completo","description":"Dossiê completo: documentos, endereços, telefones, parentes, vínculos e renda. Custo: 1 crédito por consulta encontrada (404 não cobra). Dado pessoal (LGPD): use só com finalidade legítima. Chave de teste (bk_test_) devolve dados fictícios.","tags":["Consultas"],"x-bitbusca-escopo":"consultas:pessoa","x-bitbusca-custo":"1 crédito","x-bitbusca-erros":["TOKEN_AUSENTE","TOKEN_INVALIDO","IP_NAO_PERMITIDO","CONTA_INDISPONIVEL","PLANO_DEV_NECESSARIO","ESCOPO_AUSENTE","RATE","NOT_FOUND","NO_CREDITS","LIMITE_DIARIO_CHAVE","ENUMERACAO"],"parameters":[{"name":"cpf","in":"path","required":true,"description":"CPF, com ou sem pontuação (11 dígitos).","schema":{"type":"string","minLength":1,"maxLength":200}}],"responses":{"200":{"description":"Sucesso.","content":{"application/json":{"schema":{"type":["object","array"]},"example":{"tipo":"CPF","consulta":"valor consultado","custo":1,"dados":{"nome":"FULANO DE TAL EXEMPLO","nascimento":"1985-03-12","situacao":"REGULAR","telefones":["(67) 99999-0000"],"enderecos":[{"logradouro":"RUA EXEMPLO","numero":"100","cidade":"CAMPO GRANDE","uf":"MS"}]}}}}},"400":{"$ref":"#/components/responses/Invalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"402":{"$ref":"#/components/responses/SemCreditos"},"403":{"$ref":"#/components/responses/Proibido"},"404":{"$ref":"#/components/responses/NaoEncontrado"},"422":{"$ref":"#/components/responses/Invalido"},"429":{"$ref":"#/components/responses/Limite"},"503":{"$ref":"#/components/responses/Indisponivel"}}}},"/v1/cpf-basico/{cpf}":{"get":{"operationId":"consultar_cpf_basico","summary":"CPF básico","description":"Só a identificação: nome, nascimento, filiação e situação na Receita. Custo: 1 crédito por consulta encontrada (404 não cobra). Dado pessoal (LGPD): use só com finalidade legítima. Resposta instantânea, para confirmar quem é o titular. Se quiser o histórico completo, use o CPF completo. Chave de te…","tags":["Consultas"],"x-bitbusca-escopo":"consultas:pessoa","x-bitbusca-custo":"1 crédito","x-bitbusca-erros":["TOKEN_AUSENTE","TOKEN_INVALIDO","IP_NAO_PERMITIDO","CONTA_INDISPONIVEL","PLANO_DEV_NECESSARIO","ESCOPO_AUSENTE","RATE","NOT_FOUND","NO_CREDITS","LIMITE_DIARIO_CHAVE","ENUMERACAO"],"parameters":[{"name":"cpf","in":"path","required":true,"description":"CPF, com ou sem pontuação (11 dígitos).","schema":{"type":"string","minLength":1,"maxLength":200}}],"responses":{"200":{"description":"Sucesso.","content":{"application/json":{"schema":{"type":["object","array"]},"example":{"tipo":"CPF_BASICO","consulta":"valor consultado","custo":1,"dados":{"nome":"FULANO DE TAL EXEMPLO","nascimento":"1985-03-12","mae":"MARIA EXEMPLO","situacao":"REGULAR"}}}}},"400":{"$ref":"#/components/responses/Invalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"402":{"$ref":"#/components/responses/SemCreditos"},"403":{"$ref":"#/components/responses/Proibido"},"404":{"$ref":"#/components/responses/NaoEncontrado"},"422":{"$ref":"#/components/responses/Invalido"},"429":{"$ref":"#/components/responses/Limite"},"503":{"$ref":"#/components/responses/Indisponivel"}}}},"/v1/nome/{nome}":{"get":{"operationId":"consultar_nome","summary":"Nome","description":"Encontra pessoas pelo nome e devolve o CPF de cada uma. Custo: 1 crédito por consulta encontrada (404 não cobra). Dado pessoal (LGPD): use só com finalidade legítima. Chave de teste (bk_test_) devolve dados fictícios.","tags":["Consultas"],"x-bitbusca-escopo":"consultas:pessoa","x-bitbusca-custo":"1 crédito","x-bitbusca-erros":["TOKEN_AUSENTE","TOKEN_INVALIDO","IP_NAO_PERMITIDO","CONTA_INDISPONIVEL","PLANO_DEV_NECESSARIO","ESCOPO_AUSENTE","RATE","NOT_FOUND","NO_CREDITS","LIMITE_DIARIO_CHAVE","ENUMERACAO"],"parameters":[{"name":"nome","in":"path","required":true,"description":"Nome completo da pessoa (quanto mais completo, menos homônimos).","schema":{"type":"string","minLength":1,"maxLength":200}}],"responses":{"200":{"description":"Sucesso.","content":{"application/json":{"schema":{"type":["object","array"]},"example":{"tipo":"NOME","consulta":"valor consultado","custo":1,"dados":{"itens":[{"nome":"FULANO DE TAL EXEMPLO","cpf":"000.000.000-00","nascimento":"1985-03-12","cidade":"CAMPO GRANDE/MS"}]}}}}},"400":{"$ref":"#/components/responses/Invalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"402":{"$ref":"#/components/responses/SemCreditos"},"403":{"$ref":"#/components/responses/Proibido"},"404":{"$ref":"#/components/responses/NaoEncontrado"},"422":{"$ref":"#/components/responses/Invalido"},"429":{"$ref":"#/components/responses/Limite"},"503":{"$ref":"#/components/responses/Indisponivel"}}}},"/v1/telefone/{numero}":{"get":{"operationId":"consultar_telefone","summary":"Telefone","description":"Titular da linha, com CPF e endereço de cadastro. Custo: 1 crédito por consulta encontrada (404 não cobra). Dado pessoal (LGPD): use só com finalidade legítima. Chave de teste (bk_test_) devolve dados fictícios.","tags":["Consultas"],"x-bitbusca-escopo":"consultas:pessoa","x-bitbusca-custo":"1 crédito","x-bitbusca-erros":["TOKEN_AUSENTE","TOKEN_INVALIDO","IP_NAO_PERMITIDO","CONTA_INDISPONIVEL","PLANO_DEV_NECESSARIO","ESCOPO_AUSENTE","RATE","NOT_FOUND","NO_CREDITS","LIMITE_DIARIO_CHAVE","ENUMERACAO"],"parameters":[{"name":"numero","in":"path","required":true,"description":"Valor a consultar.","schema":{"type":"string","minLength":1,"maxLength":200}}],"responses":{"200":{"description":"Sucesso.","content":{"application/json":{"schema":{"type":["object","array"]},"example":{"tipo":"TELEFONE","consulta":"valor consultado","custo":1,"dados":{"itens":[{"nome":"FULANO DE TAL EXEMPLO","cpf":"000.000.000-00","telefone":"(67) 99999-0000"}]}}}}},"400":{"$ref":"#/components/responses/Invalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"402":{"$ref":"#/components/responses/SemCreditos"},"403":{"$ref":"#/components/responses/Proibido"},"404":{"$ref":"#/components/responses/NaoEncontrado"},"422":{"$ref":"#/components/responses/Invalido"},"429":{"$ref":"#/components/responses/Limite"},"503":{"$ref":"#/components/responses/Indisponivel"}}}},"/v1/parentes/{cpf}":{"get":{"operationId":"consultar_parentes","summary":"Parentes","description":"Árvore familiar: pais, irmãos, meio-irmãos, cônjuge, sobrinhos e avós. Custo: 1 crédito por consulta encontrada (404 não cobra). Dado pessoal (LGPD): use só com finalidade legítima. Sai do mesmo dossiê da consulta de CPF. Se você já consultou este CPF nos últimos 30 dias, a resposta é imediata. Cha…","tags":["Consultas"],"x-bitbusca-escopo":"consultas:pessoa","x-bitbusca-custo":"1 crédito","x-bitbusca-erros":["TOKEN_AUSENTE","TOKEN_INVALIDO","IP_NAO_PERMITIDO","CONTA_INDISPONIVEL","PLANO_DEV_NECESSARIO","ESCOPO_AUSENTE","RATE","NOT_FOUND","NO_CREDITS","LIMITE_DIARIO_CHAVE","ENUMERACAO"],"parameters":[{"name":"cpf","in":"path","required":true,"description":"CPF, com ou sem pontuação (11 dígitos).","schema":{"type":"string","minLength":1,"maxLength":200}}],"responses":{"200":{"description":"Sucesso.","content":{"application/json":{"schema":{"type":["object","array"]},"example":{"tipo":"PARENTES","consulta":"valor consultado","custo":1,"dados":{"exemplo":"dados fictícios"}}}}},"400":{"$ref":"#/components/responses/Invalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"402":{"$ref":"#/components/responses/SemCreditos"},"403":{"$ref":"#/components/responses/Proibido"},"404":{"$ref":"#/components/responses/NaoEncontrado"},"422":{"$ref":"#/components/responses/Invalido"},"429":{"$ref":"#/components/responses/Limite"},"503":{"$ref":"#/components/responses/Indisponivel"}}}},"/v1/placa/{placa}":{"get":{"operationId":"consultar_placa","summary":"Placa","description":"Veículo, proprietário atual, histórico de donos, restrições e ocorrências. Custo: 5 créditos por consulta encontrada (404 não cobra). Chave de teste (bk_test_) devolve dados fictícios.","tags":["Consultas"],"x-bitbusca-escopo":"consultas:veiculo","x-bitbusca-custo":"5 créditos","x-bitbusca-erros":["TOKEN_AUSENTE","TOKEN_INVALIDO","IP_NAO_PERMITIDO","CONTA_INDISPONIVEL","PLANO_DEV_NECESSARIO","ESCOPO_AUSENTE","RATE","NOT_FOUND","NO_CREDITS","LIMITE_DIARIO_CHAVE","ENUMERACAO"],"parameters":[{"name":"placa","in":"path","required":true,"description":"Placa do veículo (padrão antigo ou Mercosul, ex.: ABC1D23).","schema":{"type":"string","minLength":1,"maxLength":200}}],"responses":{"200":{"description":"Sucesso.","content":{"application/json":{"schema":{"type":["object","array"]},"example":{"tipo":"PLACA","consulta":"valor consultado","custo":5,"dados":{"placa":"ABC1D23","marcaModelo":"MARCA/MODELO EXEMPLO","ano":"2020/2021","cor":"PRATA","municipio":"CAMPO GRANDE","uf":"MS"}}}}},"400":{"$ref":"#/components/responses/Invalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"402":{"$ref":"#/components/responses/SemCreditos"},"403":{"$ref":"#/components/responses/Proibido"},"404":{"$ref":"#/components/responses/NaoEncontrado"},"422":{"$ref":"#/components/responses/Invalido"},"429":{"$ref":"#/components/responses/Limite"},"503":{"$ref":"#/components/responses/Indisponivel"}}}},"/v1/motor/{motor}":{"get":{"operationId":"consultar_motor","summary":"Número do motor","description":"Identifica o veículo pelo número gravado no motor. Custo: 5 créditos por consulta encontrada (404 não cobra). Chave de teste (bk_test_) devolve dados fictícios.","tags":["Consultas"],"x-bitbusca-escopo":"consultas:veiculo","x-bitbusca-custo":"5 créditos","x-bitbusca-erros":["TOKEN_AUSENTE","TOKEN_INVALIDO","IP_NAO_PERMITIDO","CONTA_INDISPONIVEL","PLANO_DEV_NECESSARIO","ESCOPO_AUSENTE","RATE","NOT_FOUND","NO_CREDITS","LIMITE_DIARIO_CHAVE","ENUMERACAO"],"parameters":[{"name":"motor","in":"path","required":true,"description":"Número do motor.","schema":{"type":"string","minLength":1,"maxLength":200}}],"responses":{"200":{"description":"Sucesso.","content":{"application/json":{"schema":{"type":["object","array"]},"example":{"tipo":"MOTOR","consulta":"valor consultado","custo":5,"dados":{"exemplo":"dados fictícios"}}}}},"400":{"$ref":"#/components/responses/Invalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"402":{"$ref":"#/components/responses/SemCreditos"},"403":{"$ref":"#/components/responses/Proibido"},"404":{"$ref":"#/components/responses/NaoEncontrado"},"422":{"$ref":"#/components/responses/Invalido"},"429":{"$ref":"#/components/responses/Limite"},"503":{"$ref":"#/components/responses/Indisponivel"}}}},"/v1/cnpj/{cnpj}":{"get":{"operationId":"consultar_cnpj","summary":"CNPJ","description":"Empresa, situação cadastral e quadro societário completo. Custo: 1 crédito por consulta encontrada (404 não cobra). Chave de teste (bk_test_) devolve dados fictícios.","tags":["Consultas"],"x-bitbusca-escopo":"consultas:empresa","x-bitbusca-custo":"1 crédito","x-bitbusca-erros":["TOKEN_AUSENTE","TOKEN_INVALIDO","IP_NAO_PERMITIDO","CONTA_INDISPONIVEL","PLANO_DEV_NECESSARIO","ESCOPO_AUSENTE","RATE","NOT_FOUND","NO_CREDITS","LIMITE_DIARIO_CHAVE","ENUMERACAO"],"parameters":[{"name":"cnpj","in":"path","required":true,"description":"CNPJ, com ou sem pontuação (14 dígitos).","schema":{"type":"string","minLength":1,"maxLength":200}}],"responses":{"200":{"description":"Sucesso.","content":{"application/json":{"schema":{"type":["object","array"]},"example":{"tipo":"CNPJ","consulta":"valor consultado","custo":1,"dados":{"cnpj":"00.000.000/0001-00","razaoSocial":"EMPRESA EXEMPLO LTDA","situacao":"ATIVA","abertura":"2015-06-01","cnae":"6201-5/01","municipio":"CAMPO GRANDE","uf":"MS","socios":[{"nome":"FULANO DE TAL EXEMPLO","qualificacao":"SÓCIO-ADMINISTRADOR"}]}}}}},"400":{"$ref":"#/components/responses/Invalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"402":{"$ref":"#/components/responses/SemCreditos"},"403":{"$ref":"#/components/responses/Proibido"},"404":{"$ref":"#/components/responses/NaoEncontrado"},"422":{"$ref":"#/components/responses/Invalido"},"429":{"$ref":"#/components/responses/Limite"},"503":{"$ref":"#/components/responses/Indisponivel"}}}},"/v1/imoveis/{cpfOuCnpj}":{"get":{"operationId":"consultar_imoveis","summary":"Imóveis por CPF/CNPJ","description":"Patrimônio imobiliário no nome de um documento. Custo: 3 créditos por consulta encontrada (404 não cobra). Chave de teste (bk_test_) devolve dados fictícios.","tags":["Consultas"],"x-bitbusca-escopo":"imoveis","x-bitbusca-custo":"3 créditos","x-bitbusca-erros":["TOKEN_AUSENTE","TOKEN_INVALIDO","IP_NAO_PERMITIDO","CONTA_INDISPONIVEL","PLANO_DEV_NECESSARIO","ESCOPO_AUSENTE","RATE","NOT_FOUND","NO_CREDITS","LIMITE_DIARIO_CHAVE","ENUMERACAO"],"parameters":[{"name":"cpfOuCnpj","in":"path","required":true,"description":"Valor a consultar.","schema":{"type":"string","minLength":1,"maxLength":200}}],"responses":{"200":{"description":"Sucesso.","content":{"application/json":{"schema":{"type":["object","array"]},"example":{"tipo":"IMOVEL_DOC","consulta":"valor consultado","custo":3,"dados":{"exemplo":"dados fictícios"}}}}},"400":{"$ref":"#/components/responses/Invalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"402":{"$ref":"#/components/responses/SemCreditos"},"403":{"$ref":"#/components/responses/Proibido"},"404":{"$ref":"#/components/responses/NaoEncontrado"},"422":{"$ref":"#/components/responses/Invalido"},"429":{"$ref":"#/components/responses/Limite"},"503":{"$ref":"#/components/responses/Indisponivel"}}}},"/v1/enderecos/{cpf}":{"get":{"operationId":"consultar_enderecos","summary":"Endereços do CPF","description":"Todos os endereços conhecidos da pessoa, do mais recente ao mais antigo. Custo: 1 crédito por consulta encontrada (404 não cobra). Dado pessoal (LGPD): use só com finalidade legítima. Sai do mesmo dossiê da consulta de CPF. Se você já consultou este CPF nos últimos 30 dias, a resposta é imediata. C…","tags":["Consultas"],"x-bitbusca-escopo":"consultas:pessoa","x-bitbusca-custo":"1 crédito","x-bitbusca-erros":["TOKEN_AUSENTE","TOKEN_INVALIDO","IP_NAO_PERMITIDO","CONTA_INDISPONIVEL","PLANO_DEV_NECESSARIO","ESCOPO_AUSENTE","RATE","NOT_FOUND","NO_CREDITS","LIMITE_DIARIO_CHAVE","ENUMERACAO"],"parameters":[{"name":"cpf","in":"path","required":true,"description":"CPF, com ou sem pontuação (11 dígitos).","schema":{"type":"string","minLength":1,"maxLength":200}}],"responses":{"200":{"description":"Sucesso.","content":{"application/json":{"schema":{"type":["object","array"]},"example":{"tipo":"ENDERECOS","consulta":"valor consultado","custo":1,"dados":{"exemplo":"dados fictícios"}}}}},"400":{"$ref":"#/components/responses/Invalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"402":{"$ref":"#/components/responses/SemCreditos"},"403":{"$ref":"#/components/responses/Proibido"},"404":{"$ref":"#/components/responses/NaoEncontrado"},"422":{"$ref":"#/components/responses/Invalido"},"429":{"$ref":"#/components/responses/Limite"},"503":{"$ref":"#/components/responses/Indisponivel"}}}},"/v1/cep/{cep}/moradores":{"get":{"operationId":"consultar_cep_moradores","summary":"Moradores do CEP","description":"Quem mora no endereço, com nome, CPF e número da casa. Custo: 3 créditos por consulta encontrada (404 não cobra). Dado pessoal (LGPD): use só com finalidade legítima. A fonte devolve no máximo 25 moradores por CEP, e não avisa quando há mais. Chave de teste (bk_test_) devolve dados fictícios.","tags":["Consultas"],"x-bitbusca-escopo":"consultas:pessoa","x-bitbusca-custo":"3 créditos","x-bitbusca-erros":["TOKEN_AUSENTE","TOKEN_INVALIDO","IP_NAO_PERMITIDO","CONTA_INDISPONIVEL","PLANO_DEV_NECESSARIO","ESCOPO_AUSENTE","RATE","NOT_FOUND","NO_CREDITS","LIMITE_DIARIO_CHAVE","ENUMERACAO"],"parameters":[{"name":"cep","in":"path","required":true,"description":"CEP, com ou sem hífen (8 dígitos).","schema":{"type":"string","minLength":1,"maxLength":200}}],"responses":{"200":{"description":"Sucesso.","content":{"application/json":{"schema":{"type":["object","array"]},"example":{"tipo":"CEP_MORADORES","consulta":"valor consultado","custo":3,"dados":{"exemplo":"dados fictícios"}}}}},"400":{"$ref":"#/components/responses/Invalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"402":{"$ref":"#/components/responses/SemCreditos"},"403":{"$ref":"#/components/responses/Proibido"},"404":{"$ref":"#/components/responses/NaoEncontrado"},"422":{"$ref":"#/components/responses/Invalido"},"429":{"$ref":"#/components/responses/Limite"},"503":{"$ref":"#/components/responses/Indisponivel"}}}},"/v1/cep/{cep}":{"get":{"operationId":"consultar_cep","summary":"CEP","description":"Endereço completo e localização no mapa. Custo: grátis por consulta encontrada (404 não cobra). Chave de teste (bk_test_) devolve dados fictícios.","tags":["Consultas"],"x-bitbusca-escopo":"consultas:empresa","x-bitbusca-custo":"grátis","x-bitbusca-erros":["TOKEN_AUSENTE","TOKEN_INVALIDO","IP_NAO_PERMITIDO","CONTA_INDISPONIVEL","PLANO_DEV_NECESSARIO","ESCOPO_AUSENTE","RATE","NOT_FOUND","NO_CREDITS","LIMITE_DIARIO_CHAVE","ENUMERACAO"],"parameters":[{"name":"cep","in":"path","required":true,"description":"CEP, com ou sem hífen (8 dígitos).","schema":{"type":"string","minLength":1,"maxLength":200}}],"responses":{"200":{"description":"Sucesso.","content":{"application/json":{"schema":{"type":["object","array"]},"example":{"tipo":"CEP","consulta":"valor consultado","custo":0,"dados":{"cep":"79000-000","logradouro":"RUA EXEMPLO","bairro":"CENTRO","cidade":"CAMPO GRANDE","uf":"MS","lat":-20.46,"lng":-54.62}}}}},"400":{"$ref":"#/components/responses/Invalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"402":{"$ref":"#/components/responses/SemCreditos"},"403":{"$ref":"#/components/responses/Proibido"},"404":{"$ref":"#/components/responses/NaoEncontrado"},"422":{"$ref":"#/components/responses/Invalido"},"429":{"$ref":"#/components/responses/Limite"},"503":{"$ref":"#/components/responses/Indisponivel"}}}},"/v1/me":{"get":{"operationId":"meu_saldo","summary":"Plano, saldo e limites","description":"Plano de desenvolvedor, créditos restantes no ciclo (pool + recarga), limites (req/min, tetos diários) e uso das bases hoje. Grátis. Chame antes de operações caras.","tags":["Conta"],"x-bitbusca-escopo":"conta","x-bitbusca-custo":"grátis","x-bitbusca-erros":["TOKEN_AUSENTE","TOKEN_INVALIDO","IP_NAO_PERMITIDO","CONTA_INDISPONIVEL","PLANO_DEV_NECESSARIO","ESCOPO_AUSENTE","RATE"],"responses":{"200":{"description":"Sucesso.","content":{"application/json":{"schema":{"type":["object","array"]},"example":{"ambiente":"producao","plano":"dev-builder","saldo":{"pool":2310,"recarga":0,"total":2310},"ciclo":{"inicio":"2026-10-01","fim":"2026-10-31"},"limites":{"rpm":60,"empresasLinhasDia":2000,"advogadosDia":300,"pessoasDia":0},"hoje":{"empresas":120,"advogados":4,"pessoas":0}}}}},"400":{"$ref":"#/components/responses/Invalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"402":{"$ref":"#/components/responses/SemCreditos"},"403":{"$ref":"#/components/responses/Proibido"},"404":{"$ref":"#/components/responses/NaoEncontrado"},"422":{"$ref":"#/components/responses/Invalido"},"429":{"$ref":"#/components/responses/Limite"},"503":{"$ref":"#/components/responses/Indisponivel"}}}},"/v1/consultas":{"get":{"operationId":"listar_consultas","summary":"Catálogo de consultas","description":"Lista as consultas no ar agora, com rota, parâmetro, custo em créditos e escopo. Grátis.","tags":["Conta"],"x-bitbusca-escopo":"conta","x-bitbusca-custo":"grátis","x-bitbusca-erros":["TOKEN_AUSENTE","TOKEN_INVALIDO","IP_NAO_PERMITIDO","CONTA_INDISPONIVEL","PLANO_DEV_NECESSARIO","ESCOPO_AUSENTE","RATE"],"responses":{"200":{"description":"Sucesso.","content":{"application/json":{"schema":{"type":["object","array"]},"example":{"itens":[{"tipo":"CPF","rota":"/v1/cpf/{cpf}","custo":1,"escopo":"consultas:pessoa"}]}}}},"400":{"$ref":"#/components/responses/Invalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"402":{"$ref":"#/components/responses/SemCreditos"},"403":{"$ref":"#/components/responses/Proibido"},"404":{"$ref":"#/components/responses/NaoEncontrado"},"422":{"$ref":"#/components/responses/Invalido"},"429":{"$ref":"#/components/responses/Limite"},"503":{"$ref":"#/components/responses/Indisponivel"}}}},"/v1/status":{"get":{"operationId":"status_chave","summary":"Status da chave (legado)","description":"Mantido para as chaves antigas do plano Pro. Prefira /v1/me.","tags":["Conta"],"x-bitbusca-escopo":"conta","x-bitbusca-custo":"grátis","x-bitbusca-erros":["TOKEN_AUSENTE","TOKEN_INVALIDO","IP_NAO_PERMITIDO","CONTA_INDISPONIVEL","PLANO_DEV_NECESSARIO","ESCOPO_AUSENTE","RATE"],"responses":{"200":{"description":"Sucesso.","content":{"application/json":{"schema":{"type":["object","array"]},"example":{"ok":true,"plano":"dev-builder","validoAte":"2026-11-30T03:00:00.000Z"}}}},"400":{"$ref":"#/components/responses/Invalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"402":{"$ref":"#/components/responses/SemCreditos"},"403":{"$ref":"#/components/responses/Proibido"},"404":{"$ref":"#/components/responses/NaoEncontrado"},"422":{"$ref":"#/components/responses/Invalido"},"429":{"$ref":"#/components/responses/Limite"},"503":{"$ref":"#/components/responses/Indisponivel"}}}},"/v1/empresas":{"get":{"operationId":"buscar_empresas","summary":"Empresas em lista (base CNPJ)","description":"Lista empresas da base CNPJ por UF, município, bairro, CNAE, abertura, porte etc. Custo: 1 crédito por página; as linhas contam no teto diário do plano. Sócios só na ficha (/v1/cnpj). Página com profundidade limitada.","tags":["Empresas"],"x-bitbusca-escopo":"empresas:lista","x-bitbusca-custo":"1 crédito por página","x-bitbusca-erros":["TOKEN_AUSENTE","TOKEN_INVALIDO","IP_NAO_PERMITIDO","CONTA_INDISPONIVEL","PLANO_DEV_NECESSARIO","ESCOPO_AUSENTE","RATE","COTA_DIARIA","NO_CREDITS","RECURSO_FORA_DO_PLANO"],"parameters":[{"name":"uf","in":"query","required":false,"description":"UF (ex.: MS).","schema":{"type":"string","minLength":2,"maxLength":2}},{"name":"municipio","in":"query","required":false,"description":"Município (nome ou código IBGE).","schema":{"type":"string","maxLength":120}},{"name":"bairro","in":"query","required":false,"description":"Bairro.","schema":{"type":"string","maxLength":120}},{"name":"cnae","in":"query","required":false,"description":"Códigos CNAE separados por vírgula (ex.: 6201501,6202300).","schema":{"type":"string","maxLength":400}},{"name":"aberturaDias","in":"query","required":false,"description":"Abertas nos últimos N dias.","schema":{"type":"integer","minimum":1,"maximum":3650}},{"name":"porte","in":"query","required":false,"description":"Porte (ME, EPP, DEMAIS).","schema":{"type":"string","maxLength":40}},{"name":"somenteAtivas","in":"query","required":false,"description":"Só situação ATIVA.","schema":{"type":"boolean"}},{"name":"comTelefone","in":"query","required":false,"description":"Só com telefone.","schema":{"type":"boolean"}},{"name":"comEmail","in":"query","required":false,"description":"Só com e-mail.","schema":{"type":"boolean"}},{"name":"mei","in":"query","required":false,"description":"Só MEI.","schema":{"type":"boolean"}},{"name":"page","in":"query","required":false,"description":"Página (começa em 0; máximo 20 — além disso 422 PAGE_CAP).","schema":{"type":"integer","minimum":0,"maximum":20}},{"name":"pageSize","in":"query","required":false,"description":"Linhas por página (padrão 25).","schema":{"type":"integer","minimum":1,"maximum":100}}],"responses":{"200":{"description":"Sucesso.","content":{"application/json":{"schema":{"type":["object","array"]},"example":{"total":1250,"page":0,"pageSize":25,"items":[{"cnpj":"00000000000100","razaoSocial":"EMPRESA EXEMPLO LTDA","fantasia":"EXEMPLO","municipio":"CAMPO GRANDE","uf":"MS","abertura":"2026-09-15","cnae":"6201501"}]}}}},"400":{"$ref":"#/components/responses/Invalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"402":{"$ref":"#/components/responses/SemCreditos"},"403":{"$ref":"#/components/responses/Proibido"},"404":{"$ref":"#/components/responses/NaoEncontrado"},"422":{"$ref":"#/components/responses/Invalido"},"429":{"$ref":"#/components/responses/Limite"},"503":{"$ref":"#/components/responses/Indisponivel"}}}},"/v1/imovel/cidades":{"get":{"operationId":"cidades_imovel","summary":"Cidades com cadastro de imóveis","description":"Cidades com cadastro municipal de imóveis disponível (cobertura parcial: só as listadas). Grátis.","tags":["Imóveis"],"x-bitbusca-escopo":"imoveis","x-bitbusca-custo":"grátis","x-bitbusca-erros":["TOKEN_AUSENTE","TOKEN_INVALIDO","IP_NAO_PERMITIDO","CONTA_INDISPONIVEL","PLANO_DEV_NECESSARIO","ESCOPO_AUSENTE","RATE","RECURSO_FORA_DO_PLANO"],"responses":{"200":{"description":"Sucesso.","content":{"application/json":{"schema":{"type":["object","array"]},"example":[{"cidade":"campo-grande","nome":"Campo Grande/MS"}]}}},"400":{"$ref":"#/components/responses/Invalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"402":{"$ref":"#/components/responses/SemCreditos"},"403":{"$ref":"#/components/responses/Proibido"},"404":{"$ref":"#/components/responses/NaoEncontrado"},"422":{"$ref":"#/components/responses/Invalido"},"429":{"$ref":"#/components/responses/Limite"},"503":{"$ref":"#/components/responses/Indisponivel"}}}},"/v1/imovel/busca":{"get":{"operationId":"buscar_imovel","summary":"Achar o lote pelo endereço","description":"Procura imóveis no cadastro municipal por endereço ou inscrição e devolve o código do lote para a ficha. Grátis (cobra ao abrir a ficha).","tags":["Imóveis"],"x-bitbusca-escopo":"imoveis","x-bitbusca-custo":"grátis","x-bitbusca-erros":["TOKEN_AUSENTE","TOKEN_INVALIDO","IP_NAO_PERMITIDO","CONTA_INDISPONIVEL","PLANO_DEV_NECESSARIO","ESCOPO_AUSENTE","RATE","RECURSO_FORA_DO_PLANO"],"parameters":[{"name":"cidade","in":"query","required":true,"description":"Cidade do cadastro (veja /v1/imovel/cidades).","schema":{"type":"string","minLength":2,"maxLength":60}},{"name":"termo","in":"query","required":true,"description":"Endereço (rua e número) ou inscrição.","schema":{"type":"string","minLength":2,"maxLength":120}},{"name":"limite","in":"query","required":false,"description":"Máximo de resultados (padrão 30).","schema":{"type":"integer","minimum":1,"maximum":100}}],"responses":{"200":{"description":"Sucesso.","content":{"application/json":{"schema":{"type":["object","array"]},"example":{"itens":[{"codlote":"000.000.0000-0","endereco":"RUA EXEMPLO, 100","bairro":"CENTRO"}]}}}},"400":{"$ref":"#/components/responses/Invalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"402":{"$ref":"#/components/responses/SemCreditos"},"403":{"$ref":"#/components/responses/Proibido"},"404":{"$ref":"#/components/responses/NaoEncontrado"},"422":{"$ref":"#/components/responses/Invalido"},"429":{"$ref":"#/components/responses/Limite"},"503":{"$ref":"#/components/responses/Indisponivel"}}}},"/v1/imovel/{cidade}/{valor}":{"get":{"operationId":"ficha_imovel","summary":"Ficha do imóvel","description":"Ficha do lote no cadastro municipal (área, uso, venal, endereço). Custo: 5 créditos. Ache o código com /v1/imovel/busca. Só cidades de /v1/imovel/cidades.","tags":["Imóveis"],"x-bitbusca-escopo":"imoveis","x-bitbusca-custo":"5 créditos","x-bitbusca-erros":["TOKEN_AUSENTE","TOKEN_INVALIDO","IP_NAO_PERMITIDO","CONTA_INDISPONIVEL","PLANO_DEV_NECESSARIO","ESCOPO_AUSENTE","RATE","NOT_FOUND","NO_CREDITS","RECURSO_FORA_DO_PLANO"],"parameters":[{"name":"cidade","in":"path","required":true,"description":"Cidade do cadastro (veja /v1/imovel/cidades), ex.: campo-grande.","schema":{"type":"string","minLength":2,"maxLength":60}},{"name":"valor","in":"path","required":true,"description":"Inscrição/código do lote (vem de /v1/imovel/busca).","schema":{"type":"string","minLength":1,"maxLength":60}}],"responses":{"200":{"description":"Sucesso.","content":{"application/json":{"schema":{"type":["object","array"]},"example":{"tipo":"IMOVEL","custo":5,"dados":{"codlote":"000.000.0000-0","areaTerreno":360,"areaConstruida":120,"uso":"RESIDENCIAL","bairro":"CENTRO"}}}}},"400":{"$ref":"#/components/responses/Invalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"402":{"$ref":"#/components/responses/SemCreditos"},"403":{"$ref":"#/components/responses/Proibido"},"404":{"$ref":"#/components/responses/NaoEncontrado"},"422":{"$ref":"#/components/responses/Invalido"},"429":{"$ref":"#/components/responses/Limite"},"503":{"$ref":"#/components/responses/Indisponivel"}}}},"/v1/juridico/publicacoes":{"get":{"operationId":"buscar_publicacoes_djen","summary":"Buscar publicações (DJEN)","description":"Intimações e publicações do Diário de Justiça Eletrônico Nacional (desde 2021) por processo, OAB, parte, advogado ou palavras. Custo: 1 crédito por página. Sem CPF/CNPJ: nome pode ter homônimo.","tags":["Jurídico"],"x-bitbusca-escopo":"juridico","x-bitbusca-custo":"1 crédito por página","x-bitbusca-erros":["TOKEN_AUSENTE","TOKEN_INVALIDO","IP_NAO_PERMITIDO","CONTA_INDISPONIVEL","PLANO_DEV_NECESSARIO","ESCOPO_AUSENTE","RATE","NO_CREDITS"],"parameters":[{"name":"processo","in":"query","required":false,"description":"Número CNJ do processo (20 dígitos, com ou sem pontuação).","schema":{"type":"string","maxLength":40}},{"name":"oab","in":"query","required":false,"description":"OAB, ex.: 123456/SP.","schema":{"type":"string","maxLength":20}},{"name":"parte","in":"query","required":false,"description":"Nome da parte (pessoa ou empresa).","schema":{"type":"string","maxLength":150}},{"name":"advogado","in":"query","required":false,"description":"Nome do advogado.","schema":{"type":"string","maxLength":150}},{"name":"palavras","in":"query","required":false,"description":"Palavras no texto (aceita \"frase\", OR e -exclusão). Cobre só meses recentes.","schema":{"type":"string","maxLength":300}},{"name":"tribunais","in":"query","required":false,"description":"Siglas separadas por vírgula (ex.: TJSP,TRT2). Vazio = todos.","schema":{"type":"string","maxLength":400}},{"name":"de","in":"query","required":false,"description":"Data inicial (AAAA-MM-DD).","schema":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"}},{"name":"ate","in":"query","required":false,"description":"Data final (AAAA-MM-DD).","schema":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"}},{"name":"exato","in":"query","required":false,"description":"Nome exato (menos homônimos). Padrão: \"começa com\".","schema":{"type":"boolean"}},{"name":"cursor","in":"query","required":false,"description":"\"proximoCursor\" da resposta anterior.","schema":{"type":"string","maxLength":40}},{"name":"limite","in":"query","required":false,"description":"Itens por página (padrão 20).","schema":{"type":"integer","minimum":1,"maximum":50}}],"responses":{"200":{"description":"Sucesso.","content":{"application/json":{"schema":{"type":["object","array"]},"example":{"itens":[{"id":"123456789","data":"2026-10-20","processo":"0000000-00.2026.8.12.0001","tribunal":"TJMS","tipo":"Intimação","trecho":"Fica intimada a parte autora para..."}],"proximoCursor":null}}}},"400":{"$ref":"#/components/responses/Invalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"402":{"$ref":"#/components/responses/SemCreditos"},"403":{"$ref":"#/components/responses/Proibido"},"404":{"$ref":"#/components/responses/NaoEncontrado"},"422":{"$ref":"#/components/responses/Invalido"},"429":{"$ref":"#/components/responses/Limite"},"503":{"$ref":"#/components/responses/Indisponivel"}}}},"/v1/juridico/publicacoes/{id}":{"get":{"operationId":"ler_publicacao","summary":"Texto integral da publicação","description":"Texto completo de uma publicação do DJEN, com partes e advogados. Custo: grátis.","tags":["Jurídico"],"x-bitbusca-escopo":"juridico","x-bitbusca-custo":"grátis","x-bitbusca-erros":["TOKEN_AUSENTE","TOKEN_INVALIDO","IP_NAO_PERMITIDO","CONTA_INDISPONIVEL","PLANO_DEV_NECESSARIO","ESCOPO_AUSENTE","RATE","NOT_FOUND"],"parameters":[{"name":"id","in":"path","required":true,"description":"Id da publicação (campo \"id\" da busca) ou id composto \"AAAA-MM-DD:id\".","schema":{"type":"string","minLength":1,"maxLength":40}},{"name":"data","in":"query","required":false,"description":"Data da publicação (campo \"data\" da busca), obrigatória se o id não for composto.","schema":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"}}],"responses":{"200":{"description":"Sucesso.","content":{"application/json":{"schema":{"type":["object","array"]},"example":{"id":"123456789","data":"2026-10-20","processo":"0000000-00.2026.8.12.0001","tribunal":"TJMS","partes":[{"nome":"FULANO EXEMPLO","polo":"ativo"}],"texto":"Texto fictício da publicação."}}}},"400":{"$ref":"#/components/responses/Invalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"402":{"$ref":"#/components/responses/SemCreditos"},"403":{"$ref":"#/components/responses/Proibido"},"404":{"$ref":"#/components/responses/NaoEncontrado"},"422":{"$ref":"#/components/responses/Invalido"},"429":{"$ref":"#/components/responses/Limite"},"503":{"$ref":"#/components/responses/Indisponivel"}}}},"/v1/juridico/processos/{numero}":{"get":{"operationId":"ficha_processo","summary":"Ficha do processo","description":"Capa e movimentações do processo (classe, assuntos, órgão, últimos movimentos). Custo: 2 créditos. A 1ª consulta pode levar ~30 s: se vier \"em_processamento\", repita.","tags":["Jurídico"],"x-bitbusca-escopo":"juridico","x-bitbusca-custo":"2 créditos","x-bitbusca-erros":["TOKEN_AUSENTE","TOKEN_INVALIDO","IP_NAO_PERMITIDO","CONTA_INDISPONIVEL","PLANO_DEV_NECESSARIO","ESCOPO_AUSENTE","RATE","NOT_FOUND","NO_CREDITS"],"parameters":[{"name":"numero","in":"path","required":true,"description":"Número CNJ do processo (20 dígitos).","schema":{"type":"string","minLength":15,"maxLength":40}}],"responses":{"200":{"description":"Sucesso.","content":{"application/json":{"schema":{"type":["object","array"]},"example":{"status":"pronto","processo":"0000000-00.2026.8.12.0001","registros":[{"tribunal":"TJMS","classe":"Procedimento Comum Cível","ultimos_movimentos":[{"data":"2026-10-20","movimento":"Conclusos para despacho"}]}]}}}},"400":{"$ref":"#/components/responses/Invalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"402":{"$ref":"#/components/responses/SemCreditos"},"403":{"$ref":"#/components/responses/Proibido"},"404":{"$ref":"#/components/responses/NaoEncontrado"},"422":{"$ref":"#/components/responses/Invalido"},"429":{"$ref":"#/components/responses/Limite"},"503":{"$ref":"#/components/responses/Indisponivel"}}}},"/v1/juridico/prazos":{"post":{"operationId":"calcular_prazo","summary":"Calcular prazo processual","description":"Publicação, início e vencimento de um prazo a partir da disponibilização no diário, com dias úteis/corridos, feriados e recesso do tribunal. Grátis. Cálculo auxiliar: confira antes de protocolar.","tags":["Jurídico"],"x-bitbusca-escopo":"juridico","x-bitbusca-custo":"grátis","x-bitbusca-erros":["TOKEN_AUSENTE","TOKEN_INVALIDO","IP_NAO_PERMITIDO","CONTA_INDISPONIVEL","PLANO_DEV_NECESSARIO","ESCOPO_AUSENTE","RATE"],"responses":{"200":{"description":"Sucesso.","content":{"application/json":{"schema":{"type":["object","array"]},"example":{"disponibilizacao":"2026-10-20","publicacao":"2026-10-21","inicio":"2026-10-22","vencimento":"2026-11-12","dias":15,"tipo":"uteis"}}}},"400":{"$ref":"#/components/responses/Invalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"402":{"$ref":"#/components/responses/SemCreditos"},"403":{"$ref":"#/components/responses/Proibido"},"404":{"$ref":"#/components/responses/NaoEncontrado"},"422":{"$ref":"#/components/responses/Invalido"},"429":{"$ref":"#/components/responses/Limite"},"503":{"$ref":"#/components/responses/Indisponivel"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"disponibilizacao":{"description":"Data de DISPONIBILIZAÇÃO no diário (AAAA-MM-DD).","type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"dias":{"description":"Dias do prazo (ex.: 15).","type":"integer","minimum":1,"maximum":365},"tipo":{"description":"Dias úteis (padrão) ou corridos.","type":"string","enum":["uteis","corridos"]},"tribunal":{"description":"Sigla do tribunal (TJSP, TRT2, TRF3…): define feriados e recesso.","type":"string","maxLength":12},"comarca":{"description":"Comarca, para feriados locais.","type":"string","maxLength":80},"materia":{"description":"Matéria (muda o recesso).","type":"string","enum":["civel","trabalho","penal","penal_urgente","eleitoral"]},"ja_publicada":{"description":"true se a data já é a de PUBLICAÇÃO.","type":"boolean"}},"required":["disponibilizacao","dias","tribunal"]}}}}}},"/v1/juridico/monitores":{"get":{"operationId":"listar_monitores_djen","summary":"Listar monitores do DJEN","description":"Monitores ativos (OAB, nome ou processo) que avisam por webhook quando sai publicação nova. Grátis.","tags":["Jurídico"],"x-bitbusca-escopo":"juridico","x-bitbusca-custo":"grátis","x-bitbusca-erros":["TOKEN_AUSENTE","TOKEN_INVALIDO","IP_NAO_PERMITIDO","CONTA_INDISPONIVEL","PLANO_DEV_NECESSARIO","ESCOPO_AUSENTE","RATE"],"responses":{"200":{"description":"Sucesso.","content":{"application/json":{"schema":{"type":["object","array"]},"example":{"itens":[{"id":"mon_exemplo","tipo":"OAB","valor":"123456/SP","ativo":true}]}}}},"400":{"$ref":"#/components/responses/Invalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"402":{"$ref":"#/components/responses/SemCreditos"},"403":{"$ref":"#/components/responses/Proibido"},"404":{"$ref":"#/components/responses/NaoEncontrado"},"422":{"$ref":"#/components/responses/Invalido"},"429":{"$ref":"#/components/responses/Limite"},"503":{"$ref":"#/components/responses/Indisponivel"}}},"post":{"operationId":"criar_monitor_djen","summary":"Criar monitor do DJEN","description":"Monitora uma OAB, nome de parte ou processo e dispara o webhook juridico.publicacao a cada publicação nova. Não custa créditos; a quantidade de monitores é limitada pelo plano.","tags":["Jurídico"],"x-bitbusca-escopo":"juridico","x-bitbusca-custo":"grátis (o plano limita a quantidade)","x-bitbusca-erros":["TOKEN_AUSENTE","TOKEN_INVALIDO","IP_NAO_PERMITIDO","CONTA_INDISPONIVEL","PLANO_DEV_NECESSARIO","ESCOPO_AUSENTE","RATE","RECURSO_FORA_DO_PLANO"],"responses":{"200":{"description":"Sucesso.","content":{"application/json":{"schema":{"type":["object","array"]},"example":{"monitor":{"id":"mon_exemplo","tipo":"OAB","valor":"123456/SP","ativo":true}}}}},"400":{"$ref":"#/components/responses/Invalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"402":{"$ref":"#/components/responses/SemCreditos"},"403":{"$ref":"#/components/responses/Proibido"},"404":{"$ref":"#/components/responses/NaoEncontrado"},"422":{"$ref":"#/components/responses/Invalido"},"429":{"$ref":"#/components/responses/Limite"},"503":{"$ref":"#/components/responses/Indisponivel"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"tipo":{"description":"O que monitorar (padrão: deduzido do alvo).","type":"string","enum":["OAB","NOME","PROCESSO"]},"alvo":{"description":"OAB (123456/SP), nome da parte ou número CNJ.","type":"string","minLength":3,"maxLength":150},"exato":{"description":"Nome exato (só tipo NOME).","type":"boolean"},"rotulo":{"description":"Apelido do monitor.","type":"string","maxLength":80}},"required":["alvo"]}}}}}},"/v1/juridico/monitores/{id}":{"delete":{"operationId":"excluir_monitor_djen","summary":"Excluir monitor do DJEN","description":"Exclui um monitor. Grátis.","tags":["Jurídico"],"x-bitbusca-escopo":"juridico","x-bitbusca-custo":"grátis","x-bitbusca-erros":["TOKEN_AUSENTE","TOKEN_INVALIDO","IP_NAO_PERMITIDO","CONTA_INDISPONIVEL","PLANO_DEV_NECESSARIO","ESCOPO_AUSENTE","RATE","NOT_FOUND"],"parameters":[{"name":"id","in":"path","required":true,"description":"Id do monitor.","schema":{"type":"string","minLength":1,"maxLength":60}}],"responses":{"200":{"description":"Sucesso.","content":{"application/json":{"schema":{"type":["object","array"]},"example":{"excluido":true}}}},"400":{"$ref":"#/components/responses/Invalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"402":{"$ref":"#/components/responses/SemCreditos"},"403":{"$ref":"#/components/responses/Proibido"},"404":{"$ref":"#/components/responses/NaoEncontrado"},"422":{"$ref":"#/components/responses/Invalido"},"429":{"$ref":"#/components/responses/Limite"},"503":{"$ref":"#/components/responses/Indisponivel"}}}},"/v1/licitacoes/editais":{"get":{"operationId":"buscar_editais","summary":"Buscar editais abertos","description":"Editais de licitação abertos (PNCP e outros portais) por palavras do objeto, UF, município, modalidade, valor e prazo. Custo: 1 crédito por página.","tags":["Licitações"],"x-bitbusca-escopo":"licitacoes","x-bitbusca-custo":"1 crédito por página","x-bitbusca-erros":["TOKEN_AUSENTE","TOKEN_INVALIDO","IP_NAO_PERMITIDO","CONTA_INDISPONIVEL","PLANO_DEV_NECESSARIO","ESCOPO_AUSENTE","RATE","NO_CREDITS"],"parameters":[{"name":"q","in":"query","required":false,"description":"Palavras do objeto (ex.: \"merenda escolar\").","schema":{"type":"string","maxLength":300}},{"name":"uf","in":"query","required":false,"description":"UFs separadas por vírgula (ex.: MS,SP).","schema":{"type":"string","maxLength":400}},{"name":"municipio","in":"query","required":false,"description":"Códigos IBGE de 7 dígitos separados por vírgula.","schema":{"type":"string","maxLength":400}},{"name":"modalidade","in":"query","required":false,"description":"Códigos de modalidade (PNCP) separados por vírgula.","schema":{"type":"string","maxLength":400}},{"name":"valorMin","in":"query","required":false,"description":"Valor estimado mínimo (R$).","schema":{"type":"number","minimum":0}},{"name":"valorMax","in":"query","required":false,"description":"Valor estimado máximo (R$).","schema":{"type":"number","minimum":0}},{"name":"encerraAte","in":"query","required":false,"description":"Propostas encerram até (AAAA-MM-DD).","schema":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"}},{"name":"publicadoDesde","in":"query","required":false,"description":"Publicados desde (AAAA-MM-DD).","schema":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"}},{"name":"ordem","in":"query","required":false,"description":"Ordenação.","schema":{"type":"string","enum":["encerramento","recentes","valor"]}},{"name":"cursor","in":"query","required":false,"description":"\"proximoCursor\" da resposta anterior.","schema":{"type":"string","maxLength":200}},{"name":"limite","in":"query","required":false,"description":"Itens por página (padrão 20).","schema":{"type":"integer","minimum":1,"maximum":50}}],"responses":{"200":{"description":"Sucesso.","content":{"application/json":{"schema":{"type":["object","array"]},"example":{"itens":[{"id":"987654","objeto":"Aquisição de material de escritório (exemplo)","orgao":"PREFEITURA EXEMPLO","uf":"MS","modalidade":"Pregão Eletrônico","valorEstimado":150000,"encerramento":"2026-11-10"}],"proximoCursor":null}}}},"400":{"$ref":"#/components/responses/Invalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"402":{"$ref":"#/components/responses/SemCreditos"},"403":{"$ref":"#/components/responses/Proibido"},"404":{"$ref":"#/components/responses/NaoEncontrado"},"422":{"$ref":"#/components/responses/Invalido"},"429":{"$ref":"#/components/responses/Limite"},"503":{"$ref":"#/components/responses/Indisponivel"}}}},"/v1/licitacoes/editais/{id}":{"get":{"operationId":"ler_edital","summary":"Detalhe do edital","description":"Itens, documentos, datas e órgão de um edital. Custo: grátis.","tags":["Licitações"],"x-bitbusca-escopo":"licitacoes","x-bitbusca-custo":"grátis","x-bitbusca-erros":["TOKEN_AUSENTE","TOKEN_INVALIDO","IP_NAO_PERMITIDO","CONTA_INDISPONIVEL","PLANO_DEV_NECESSARIO","ESCOPO_AUSENTE","RATE","NOT_FOUND"],"parameters":[{"name":"id","in":"path","required":true,"description":"Id do edital (campo \"id\" da busca).","schema":{"type":"string","minLength":1,"maxLength":60}}],"responses":{"200":{"description":"Sucesso.","content":{"application/json":{"schema":{"type":["object","array"]},"example":{"id":"987654","objeto":"Aquisição de material de escritório (exemplo)","itens":[{"descricao":"Caneta azul","quantidade":1000}],"documentos":[{"nome":"Edital.pdf","url":"https://exemplo.gov.br/edital.pdf"}]}}}},"400":{"$ref":"#/components/responses/Invalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"402":{"$ref":"#/components/responses/SemCreditos"},"403":{"$ref":"#/components/responses/Proibido"},"404":{"$ref":"#/components/responses/NaoEncontrado"},"422":{"$ref":"#/components/responses/Invalido"},"429":{"$ref":"#/components/responses/Limite"},"503":{"$ref":"#/components/responses/Indisponivel"}}}},"/v1/licitacoes/editais/{id}/analise":{"post":{"operationId":"analisar_edital","summary":"Análise do edital por IA","description":"Resumo do edital por IA: objeto, exigências de habilitação, prazos e riscos. Custo: 3 créditos.","tags":["Licitações"],"x-bitbusca-escopo":"licitacoes","x-bitbusca-custo":"3 créditos","x-bitbusca-erros":["TOKEN_AUSENTE","TOKEN_INVALIDO","IP_NAO_PERMITIDO","CONTA_INDISPONIVEL","PLANO_DEV_NECESSARIO","ESCOPO_AUSENTE","RATE","NOT_FOUND","NO_CREDITS"],"parameters":[{"name":"id","in":"path","required":true,"description":"Id do edital (campo \"id\" da busca).","schema":{"type":"string","minLength":1,"maxLength":60}}],"responses":{"200":{"description":"Sucesso.","content":{"application/json":{"schema":{"type":["object","array"]},"example":{"resumo":"Pregão para material de escritório (exemplo).","exigencias":["Certidão negativa federal"],"prazos":{"propostas":"2026-11-10"}}}}},"400":{"$ref":"#/components/responses/Invalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"402":{"$ref":"#/components/responses/SemCreditos"},"403":{"$ref":"#/components/responses/Proibido"},"404":{"$ref":"#/components/responses/NaoEncontrado"},"422":{"$ref":"#/components/responses/Invalido"},"429":{"$ref":"#/components/responses/Limite"},"503":{"$ref":"#/components/responses/Indisponivel"}}}},"/v1/licitacoes/alertas":{"get":{"operationId":"listar_alertas_licitacao","summary":"Listar alertas de licitação","description":"Alertas que disparam o webhook licitacoes.edital quando entra edital novo que bate o filtro. Grátis.","tags":["Licitações"],"x-bitbusca-escopo":"licitacoes","x-bitbusca-custo":"grátis","x-bitbusca-erros":["TOKEN_AUSENTE","TOKEN_INVALIDO","IP_NAO_PERMITIDO","CONTA_INDISPONIVEL","PLANO_DEV_NECESSARIO","ESCOPO_AUSENTE","RATE"],"responses":{"200":{"description":"Sucesso.","content":{"application/json":{"schema":{"type":["object","array"]},"example":{"itens":[{"id":"al_exemplo","nome":"Material de escritório MS","termos":"material de escritório","ufs":["MS"],"ativo":true}]}}}},"400":{"$ref":"#/components/responses/Invalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"402":{"$ref":"#/components/responses/SemCreditos"},"403":{"$ref":"#/components/responses/Proibido"},"404":{"$ref":"#/components/responses/NaoEncontrado"},"422":{"$ref":"#/components/responses/Invalido"},"429":{"$ref":"#/components/responses/Limite"},"503":{"$ref":"#/components/responses/Indisponivel"}}},"post":{"operationId":"criar_alerta_licitacao","summary":"Criar alerta de licitação","description":"Cria alerta por palavras-chave, UF, município, modalidade e valor; cada edital novo dispara o webhook licitacoes.edital. Não custa créditos; a quantidade é limitada pelo plano.","tags":["Licitações"],"x-bitbusca-escopo":"licitacoes","x-bitbusca-custo":"grátis (o plano limita a quantidade)","x-bitbusca-erros":["TOKEN_AUSENTE","TOKEN_INVALIDO","IP_NAO_PERMITIDO","CONTA_INDISPONIVEL","PLANO_DEV_NECESSARIO","ESCOPO_AUSENTE","RATE","RECURSO_FORA_DO_PLANO"],"responses":{"200":{"description":"Sucesso.","content":{"application/json":{"schema":{"type":["object","array"]},"example":{"alerta":{"id":"al_exemplo","nome":"Material de escritório MS","ativo":true}}}}},"400":{"$ref":"#/components/responses/Invalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"402":{"$ref":"#/components/responses/SemCreditos"},"403":{"$ref":"#/components/responses/Proibido"},"404":{"$ref":"#/components/responses/NaoEncontrado"},"422":{"$ref":"#/components/responses/Invalido"},"429":{"$ref":"#/components/responses/Limite"},"503":{"$ref":"#/components/responses/Indisponivel"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"nome":{"description":"Nome do alerta.","type":"string","maxLength":80},"termos":{"description":"Palavras-chave do objeto (ou informe ramos).","type":"string","maxLength":300},"ufs":{"description":"UFs (ex.: [\"MS\"]).","maxItems":27,"type":"array","items":{"type":"string","minLength":2,"maxLength":2}},"municipios":{"description":"Códigos IBGE.","maxItems":50,"type":"array","items":{"type":"string","pattern":"^\\d{7}$"}},"modalidades":{"description":"Códigos de modalidade.","maxItems":20,"type":"array","items":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"valorMin":{"description":"Valor mínimo (R$).","type":"number","minimum":0},"valorMax":{"description":"Valor máximo (R$).","type":"number","minimum":0},"meEpp":{"description":"Exclusivos ME/EPP: em algum item ou em todos.","type":"string","enum":["algum","todos"]}}}}}}}},"/v1/licitacoes/alertas/{id}":{"delete":{"operationId":"excluir_alerta_licitacao","summary":"Excluir alerta de licitação","description":"Exclui um alerta. Grátis.","tags":["Licitações"],"x-bitbusca-escopo":"licitacoes","x-bitbusca-custo":"grátis","x-bitbusca-erros":["TOKEN_AUSENTE","TOKEN_INVALIDO","IP_NAO_PERMITIDO","CONTA_INDISPONIVEL","PLANO_DEV_NECESSARIO","ESCOPO_AUSENTE","RATE","NOT_FOUND"],"parameters":[{"name":"id","in":"path","required":true,"description":"Id do alerta.","schema":{"type":"string","minLength":1,"maxLength":60}}],"responses":{"200":{"description":"Sucesso.","content":{"application/json":{"schema":{"type":["object","array"]},"example":{"excluido":true}}}},"400":{"$ref":"#/components/responses/Invalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"402":{"$ref":"#/components/responses/SemCreditos"},"403":{"$ref":"#/components/responses/Proibido"},"404":{"$ref":"#/components/responses/NaoEncontrado"},"422":{"$ref":"#/components/responses/Invalido"},"429":{"$ref":"#/components/responses/Limite"},"503":{"$ref":"#/components/responses/Indisponivel"}}}},"/v1/advogados/{oab}":{"get":{"operationId":"ficha_advogado","summary":"Ficha do advogado por OAB","description":"Ficha do advogado no cadastro nacional (situação, inscrições, endereço e contato profissional) pela OAB. Custo: 1 crédito; conta no teto diário de advogados.","tags":["Advogados"],"x-bitbusca-escopo":"advogados","x-bitbusca-custo":"1 crédito","x-bitbusca-erros":["TOKEN_AUSENTE","TOKEN_INVALIDO","IP_NAO_PERMITIDO","CONTA_INDISPONIVEL","PLANO_DEV_NECESSARIO","ESCOPO_AUSENTE","RATE","NOT_FOUND","COTA_DIARIA","NO_CREDITS","ENUMERACAO"],"parameters":[{"name":"oab","in":"path","required":true,"description":"UF + número da OAB, ex.: MS12345.","schema":{"type":"string","minLength":3,"maxLength":30}}],"responses":{"200":{"description":"Sucesso.","content":{"application/json":{"schema":{"type":["object","array"]},"example":{"nome":"FULANO DE TAL EXEMPLO","inscricoes":[{"uf":"SP","numero":"123456","tipo":"ADVOGADO","situacao":"REGULAR"}],"contato":{"telefone":"(11) 3000-0000","cidade":"SÃO PAULO"}}}}},"400":{"$ref":"#/components/responses/Invalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"402":{"$ref":"#/components/responses/SemCreditos"},"403":{"$ref":"#/components/responses/Proibido"},"404":{"$ref":"#/components/responses/NaoEncontrado"},"422":{"$ref":"#/components/responses/Invalido"},"429":{"$ref":"#/components/responses/Limite"},"503":{"$ref":"#/components/responses/Indisponivel"}}}},"/v1/advogados":{"get":{"operationId":"buscar_advogados","summary":"Buscar advogados por nome","description":"Busca advogados por nome (e UF), até 20 por página, sem contatos (contato só na ficha por OAB). Custo: 1 crédito por página; conta no teto diário.","tags":["Advogados"],"x-bitbusca-escopo":"advogados","x-bitbusca-custo":"1 crédito por página","x-bitbusca-erros":["TOKEN_AUSENTE","TOKEN_INVALIDO","IP_NAO_PERMITIDO","CONTA_INDISPONIVEL","PLANO_DEV_NECESSARIO","ESCOPO_AUSENTE","RATE","COTA_DIARIA","NO_CREDITS"],"parameters":[{"name":"nome","in":"query","required":true,"description":"Nome do advogado (com sobrenome acha melhor).","schema":{"type":"string","minLength":3,"maxLength":120}},{"name":"uf","in":"query","required":false,"description":"UF da inscrição.","schema":{"type":"string","minLength":2,"maxLength":2}},{"name":"pagina","in":"query","required":false,"description":"Página (começa em 0; 20 por página; máximo 24).","schema":{"type":"integer","minimum":0,"maximum":24}}],"responses":{"200":{"description":"Sucesso.","content":{"application/json":{"schema":{"type":["object","array"]},"example":{"itens":[{"nome":"FULANO DE TAL EXEMPLO","oab":"SP123456","situacao":"REGULAR"}],"pagina":1,"total":3}}}},"400":{"$ref":"#/components/responses/Invalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"402":{"$ref":"#/components/responses/SemCreditos"},"403":{"$ref":"#/components/responses/Proibido"},"404":{"$ref":"#/components/responses/NaoEncontrado"},"422":{"$ref":"#/components/responses/Invalido"},"429":{"$ref":"#/components/responses/Limite"},"503":{"$ref":"#/components/responses/Indisponivel"}}}},"/v1/pessoas/leads":{"post":{"operationId":"gerar_leads_pessoas","summary":"Gerar leads de pessoas físicas","description":"Contatos de pessoas físicas por recorte geográfico (obrigatório), um canal por vez (telefone OU e-mail), até 100 por chamada, sem CPF (id opaco lead_…). Custo: 1 crédito a cada 10 contatos entregues. Só planos Scale+. LGPD: finalidade legítima e opt-out.","tags":["Pessoas"],"x-bitbusca-escopo":"pessoas:leads","x-bitbusca-custo":"1 crédito a cada 10 contatos entregues","x-bitbusca-erros":["TOKEN_AUSENTE","TOKEN_INVALIDO","IP_NAO_PERMITIDO","CONTA_INDISPONIVEL","PLANO_DEV_NECESSARIO","ESCOPO_AUSENTE","RATE","COTA_DIARIA","NO_CREDITS","RECURSO_FORA_DO_PLANO"],"responses":{"200":{"description":"Sucesso.","content":{"application/json":{"schema":{"type":["object","array"]},"example":{"canal":"telefone","itens":[{"id":"lead_exemplo1","nome":"FULANO EXEMPLO","telefone":"(67) 99999-0000","cidade":"CAMPO GRANDE","uf":"MS"}],"entregues":1}}}},"400":{"$ref":"#/components/responses/Invalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"402":{"$ref":"#/components/responses/SemCreditos"},"403":{"$ref":"#/components/responses/Proibido"},"404":{"$ref":"#/components/responses/NaoEncontrado"},"422":{"$ref":"#/components/responses/Invalido"},"429":{"$ref":"#/components/responses/Limite"},"503":{"$ref":"#/components/responses/Indisponivel"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"canal":{"description":"Um canal por geração: telefone OU e-mail.","type":"string","enum":["telefone","email"]},"ufs":{"description":"UFs (recorte geográfico obrigatório: UF, cidade, bairro ou CEP).","maxItems":27,"type":"array","items":{"type":"string","minLength":2,"maxLength":2}},"cidades":{"description":"Cidades.","maxItems":20,"type":"array","items":{"type":"string","minLength":2,"maxLength":80}},"bairro":{"description":"Bairro.","type":"string","maxLength":80},"cepPrefixo":{"description":"Começo do CEP, 2 a 8 dígitos (ex.: 790).","type":"string","pattern":"^\\d{2,8}$"},"ddds":{"description":"DDDs (só canal telefone).","maxItems":30,"type":"array","items":{"type":"string","pattern":"^\\d{2}$"}},"idadeMin":{"description":"Idade mínima.","type":"integer","minimum":18,"maximum":110},"idadeMax":{"description":"Idade máxima.","type":"integer","minimum":18,"maximum":110},"quantidade":{"description":"Contatos desta chamada (até 100).","type":"integer","minimum":1,"maximum":100}},"required":["canal"]}}}}}},"/v1/pessoas/leads/contagem":{"post":{"operationId":"contar_leads_pessoas","summary":"Contar leads disponíveis","description":"Quantos contatos batem o filtro (mesmo corpo de /v1/pessoas/leads), sem entregar nenhum. Grátis.","tags":["Pessoas"],"x-bitbusca-escopo":"pessoas:leads","x-bitbusca-custo":"grátis","x-bitbusca-erros":["TOKEN_AUSENTE","TOKEN_INVALIDO","IP_NAO_PERMITIDO","CONTA_INDISPONIVEL","PLANO_DEV_NECESSARIO","ESCOPO_AUSENTE","RATE","RECURSO_FORA_DO_PLANO"],"responses":{"200":{"description":"Sucesso.","content":{"application/json":{"schema":{"type":["object","array"]},"example":{"canal":"telefone","total":4820}}}},"400":{"$ref":"#/components/responses/Invalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"402":{"$ref":"#/components/responses/SemCreditos"},"403":{"$ref":"#/components/responses/Proibido"},"404":{"$ref":"#/components/responses/NaoEncontrado"},"422":{"$ref":"#/components/responses/Invalido"},"429":{"$ref":"#/components/responses/Limite"},"503":{"$ref":"#/components/responses/Indisponivel"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"canal":{"description":"Um canal por geração: telefone OU e-mail.","type":"string","enum":["telefone","email"]},"ufs":{"description":"UFs (recorte geográfico obrigatório: UF, cidade, bairro ou CEP).","maxItems":27,"type":"array","items":{"type":"string","minLength":2,"maxLength":2}},"cidades":{"description":"Cidades.","maxItems":20,"type":"array","items":{"type":"string","minLength":2,"maxLength":80}},"bairro":{"description":"Bairro.","type":"string","maxLength":80},"cepPrefixo":{"description":"Começo do CEP, 2 a 8 dígitos (ex.: 790).","type":"string","pattern":"^\\d{2,8}$"},"ddds":{"description":"DDDs (só canal telefone).","maxItems":30,"type":"array","items":{"type":"string","pattern":"^\\d{2}$"}},"idadeMin":{"description":"Idade mínima.","type":"integer","minimum":18,"maximum":110},"idadeMax":{"description":"Idade máxima.","type":"integer","minimum":18,"maximum":110},"quantidade":{"description":"Contatos desta chamada (até 100).","type":"integer","minimum":1,"maximum":100}},"required":["canal"]}}}}}},"/v1/webhooks":{"get":{"operationId":"listar_webhooks","summary":"Listar webhooks","description":"Endpoints cadastrados para receber eventos assinados (HMAC-SHA256 em X-BitBusca-Assinatura). Grátis.","tags":["Webhooks"],"x-bitbusca-escopo":"webhooks","x-bitbusca-custo":"grátis","x-bitbusca-erros":["TOKEN_AUSENTE","TOKEN_INVALIDO","IP_NAO_PERMITIDO","CONTA_INDISPONIVEL","PLANO_DEV_NECESSARIO","ESCOPO_AUSENTE","RATE"],"responses":{"200":{"description":"Sucesso.","content":{"application/json":{"schema":{"type":["object","array"]},"example":{"itens":[{"id":"wh_exemplo","url":"https://exemplo.com.br/webhook","eventos":["juridico.publicacao"],"ativo":true}]}}}},"400":{"$ref":"#/components/responses/Invalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"402":{"$ref":"#/components/responses/SemCreditos"},"403":{"$ref":"#/components/responses/Proibido"},"404":{"$ref":"#/components/responses/NaoEncontrado"},"422":{"$ref":"#/components/responses/Invalido"},"429":{"$ref":"#/components/responses/Limite"},"503":{"$ref":"#/components/responses/Indisponivel"}}},"post":{"operationId":"criar_webhook","summary":"Criar webhook","description":"Cadastra URL HTTPS para eventos (juridico.publicacao, licitacoes.edital, empresas.nova, uso.limite…). Devolve o segredo UMA vez. Corpo do evento: { id, tipo, criadoEm, ambiente, dados }.","tags":["Webhooks"],"x-bitbusca-escopo":"webhooks","x-bitbusca-custo":"grátis (o plano limita a quantidade)","x-bitbusca-erros":["TOKEN_AUSENTE","TOKEN_INVALIDO","IP_NAO_PERMITIDO","CONTA_INDISPONIVEL","PLANO_DEV_NECESSARIO","ESCOPO_AUSENTE","RATE","RECURSO_FORA_DO_PLANO"],"responses":{"200":{"description":"Sucesso.","content":{"application/json":{"schema":{"type":["object","array"]},"example":{"webhook":{"id":"wh_exemplo","url":"https://exemplo.com.br/webhook","eventos":["juridico.publicacao"]},"segredo":"whsec_exemplo"}}}},"400":{"$ref":"#/components/responses/Invalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"402":{"$ref":"#/components/responses/SemCreditos"},"403":{"$ref":"#/components/responses/Proibido"},"404":{"$ref":"#/components/responses/NaoEncontrado"},"422":{"$ref":"#/components/responses/Invalido"},"429":{"$ref":"#/components/responses/Limite"},"503":{"$ref":"#/components/responses/Indisponivel"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"description":"URL HTTPS que recebe os eventos.","type":"string","minLength":8,"maxLength":2000},"eventos":{"description":"Eventos (ex.: [\"juridico.publicacao\",\"licitacoes.edital\"]); padrão: todos [\"*\"].","maxItems":20,"type":"array","items":{"type":"string","maxLength":40}},"descricao":{"description":"Descrição.","type":"string","maxLength":120}},"required":["url"]}}}}}},"/v1/webhooks/{id}":{"delete":{"operationId":"excluir_webhook","summary":"Excluir webhook","description":"Exclui um webhook. Grátis.","tags":["Webhooks"],"x-bitbusca-escopo":"webhooks","x-bitbusca-custo":"grátis","x-bitbusca-erros":["TOKEN_AUSENTE","TOKEN_INVALIDO","IP_NAO_PERMITIDO","CONTA_INDISPONIVEL","PLANO_DEV_NECESSARIO","ESCOPO_AUSENTE","RATE","NOT_FOUND"],"parameters":[{"name":"id","in":"path","required":true,"description":"Id do webhook.","schema":{"type":"string","minLength":1,"maxLength":60}}],"responses":{"200":{"description":"Sucesso.","content":{"application/json":{"schema":{"type":["object","array"]},"example":{"excluido":true}}}},"400":{"$ref":"#/components/responses/Invalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"402":{"$ref":"#/components/responses/SemCreditos"},"403":{"$ref":"#/components/responses/Proibido"},"404":{"$ref":"#/components/responses/NaoEncontrado"},"422":{"$ref":"#/components/responses/Invalido"},"429":{"$ref":"#/components/responses/Limite"},"503":{"$ref":"#/components/responses/Indisponivel"}}}},"/v1/webhooks/{id}/testar":{"post":{"operationId":"testar_webhook","summary":"Testar webhook","description":"Envia o evento teste.ping ao endpoint e devolve o status da entrega. Grátis.","tags":["Webhooks"],"x-bitbusca-escopo":"webhooks","x-bitbusca-custo":"grátis","x-bitbusca-erros":["TOKEN_AUSENTE","TOKEN_INVALIDO","IP_NAO_PERMITIDO","CONTA_INDISPONIVEL","PLANO_DEV_NECESSARIO","ESCOPO_AUSENTE","RATE","NOT_FOUND"],"parameters":[{"name":"id","in":"path","required":true,"description":"Id do webhook.","schema":{"type":"string","minLength":1,"maxLength":60}}],"responses":{"200":{"description":"Sucesso.","content":{"application/json":{"schema":{"type":["object","array"]},"example":{"entregue":true,"status":200,"ms":180}}}},"400":{"$ref":"#/components/responses/Invalido"},"401":{"$ref":"#/components/responses/NaoAutenticado"},"402":{"$ref":"#/components/responses/SemCreditos"},"403":{"$ref":"#/components/responses/Proibido"},"404":{"$ref":"#/components/responses/NaoEncontrado"},"422":{"$ref":"#/components/responses/Invalido"},"429":{"$ref":"#/components/responses/Limite"},"503":{"$ref":"#/components/responses/Indisponivel"}}}}}}