Autenticação

Todas as operações autenticadas da API pública exigem a API Key da conta.

URL base

https://api.buscaprocessos.app.br

Use exclusivamente este host. Hosts diferentes podem retornar HTTP 404 com código INVALID_API_HOST.

Headers aceitos

A implementação em lib/public-api.ts aceita, nesta ordem:

x-api-key: <sua_api_key>
Authorization: Bearer <sua_api_key>

Formato recomendado:

x-api-key: bp_live_SUA_CHAVE
Accept: application/json

Ambos os formatos são válidos. Prefira x-api-key na documentação e nos exemplos de integração.

Prefixo da chave

Chaves geradas pelo produto usam o prefixo:

bp_live_

seguido de 40 caracteres hexadecimais.

Exemplo cURL

curl --request GET \
  --url 'https://api.buscaprocessos.app.br/v1/processos?cpf_cnpj=00000000000' \
  --header "x-api-key: ${BUSCAPROCESSOS_API_KEY}" \
  --header 'Accept: application/json'

Exemplo com Bearer

curl --request GET \
  --url 'https://api.buscaprocessos.app.br/v1/processos?cpf_cnpj=00000000000' \
  --header "Authorization: Bearer ${BUSCAPROCESSOS_API_KEY}" \
  --header 'Accept: application/json'

Variável de ambiente

BUSCAPROCESSOS_API_KEY=bp_live_sua_chave_aqui

Pré-condições de uso

Antes de autenticar com sucesso, a conta precisa:

Estar com e-mail confirmado (emailVerifiedAt preenchido).
Possuir plano com status ACTIVE.
Possuir API Key válida em CompanyPlan.apiKey.
Ter saldo disponível (exceto em poucos endpoints que permitem saldo zero).
Não estar sob restrição de antifraude ativa.

Respostas de erro

HTTP	Código	Mensagem típica
401	`API_KEY_REQUIRED`	Envie a chave em `x-api-key` ou `Authorization: Bearer`.
401	`INVALID_API_KEY`	A API key informada é inválida.
403	`ACCOUNT_INACTIVE`	A conta vinculada à API key não está ativa.
403	`EMAIL_VERIFICATION_REQUIRED`	Confirme o e-mail da conta para liberar o uso da API.
403	`INSUFFICIENT_CREDITS`	Créditos insuficientes para processar a consulta.
404	`INVALID_API_HOST`	Use o host `api.buscaprocessos.app.br`.

Envelope:

{
  "error": {
    "code": "API_KEY_REQUIRED",
    "message": "Envie a chave em `x-api-key` ou `Authorization: Bearer`."
  }
}

Headers de resposta úteis

A API pode expor:

X-BuscaProcessos-Credits-Remaining
X-BuscaProcessos-Request-Id
X-BuscaProcessos-Search-Log-Id

O corpo de sucesso também pode trazer meta.requestId, meta.searchLogId e meta.creditsRemaining.

CORS

Headers de autenticação permitidos no CORS da API pública:

Content-Type, X-API-Key, Authorization

Mesmo com CORS aberto, a chave não deve ser usada em frontend público.

Onde obter a chave

Escolha o pacote em Planos da API
Conclua a contratação em Contratar API
Acesse o painel da API ou Entrar
Abra API Keys

Veja também: API Keys · Primeiros passos.