Autenticação

Header

x-api-key: ck_Zx8QmT4pV9wX1cR6nB3sL5aY0dE7hK2jG9fN4uQ8rW1

A chave começa com ck_ — veja como obtê-la em Crie sua chave. Guarde-a como segredo: quem tem a chave chama a API em nome da sua conta.

Escopos por produto

Cada chave tem uma lista de escopos, um por produto (cada calculadora, cada consulta, o JusScore), e só acessa as rotas dos produtos liberados para ela. Fora da lista, a resposta é 403 com o escopo que faltou na message.

403 insufficient_scope

{
  "statusCode": 403,
  "message": "Missing scope: consultas.cnh:execute",
  "code": "insufficient_scope",
  "requestId": "9f1c2b7e-4d3a-4f8b-a6e2-1c0d9e8f7a65",
  "timestamp": "2026-10-31T14:02:11.000Z",
  "path": "/api/v1/consultas/cnh"
}

Os produtos de cada chave são liberados pelo time Jusfy. Produto novo não entra sozinho nas chaves que já existem: peça a liberação quando quiser usá-lo.

A consulta do próprio consumo (GET /api/v1/consumo) não exige escopo: qualquer chave de conta ativa a acessa.

Quem pode usar

Situação	Resposta
Chave válida, conta ativa, produto na lista	Liberada
Chave ausente ou que não existe	`401` `invalid_api_key`
Conta inativa ou ainda pendente	`403` `inactive_client`
Produto fora dos escopos da chave	`403` `insufficient_scope`

O catálogo completo de erros está em Erros e limites.

Comece aqui

Fundamentos

Produtos

Referência

Escopos por produto

Quem pode usar

​Escopos por produto

​Quem pode usar

Escopos por produto

Quem pode usar