GET /v1/status · cnpj.ia.br

Créditos

chamada · 0 créditos

Respostas

200 OK

Estado atual.

Header	Tipo	Descrição
`X-Request-Id`	`string`	Identificador da requisição para suporte.
`X-Client-Request-Id`	`string`	Eco do X-Request-Id enviado pelo cliente quando casa ^[A-Za-z0-9_-]{8,64}$. Ausente se o cliente não enviou ou o valor é inválido. Nunca usado como identificador interno.
`X-RateLimit-Limit`	`integer`	Requisições por minuto do plano (por conta).
`X-RateLimit-Remaining`	`integer`	Requisições restantes no minuto corrente.
`Access-Control-Allow-Origin`	`string`	Só em GET /v1/status e GET /v1/demo, quando a resposta é produzida pela própria operação. Ausente no 429 do limite por IP, no 404 da allowlist e nas falhas anteriores à operação (por exemplo, ao consultar o estado da base); presente em erros ocorridos dentro da operação.
`Cache-Control`	`string`	Cache público de 60 segundos.

{
  "api_version": "1.0.0",
  "data_as_of": "2026-09-01",
  "maintenance": false,
  "retry_after_seconds": null
}

429 Excesso de requisições

Limite por IP (60/min). Header Retry-After. Sem CORS nesta resposta.

Header	Tipo	Descrição
`X-Request-Id`	`string`	Identificador da requisição para suporte.
`X-Client-Request-Id`	`string`	Eco do X-Request-Id enviado pelo cliente quando casa ^[A-Za-z0-9_-]{8,64}$. Ausente se o cliente não enviou ou o valor é inválido. Nunca usado como identificador interno.
`Retry-After`	`integer`	Só em 429 e 503: segundos até tentar de novo.
`X-RateLimit-Limit`	`integer`	Requisições por minuto do plano (por conta).
`X-RateLimit-Remaining`	`integer`	Requisições restantes no minuto corrente.

{
  "error": {
    "code": "rate_limited",
    "message": "Limite de requisições excedido. Tente novamente em instantes.",
    "request_id": "req_01J8ZK3Q9X",
    "retryable": true,
    "docs_url": "https://cnpj.ia.br/docs/erros-e-retentativas#rate_limited"
  }
}

500 Erro interno

Erro não previsto. retryable: true; esta operação não consome créditos.

Header	Tipo	Descrição
`X-Request-Id`	`string`	Identificador da requisição para suporte.
`X-Client-Request-Id`	`string`	Eco do X-Request-Id enviado pelo cliente quando casa ^[A-Za-z0-9_-]{8,64}$. Ausente se o cliente não enviou ou o valor é inválido. Nunca usado como identificador interno.
`X-RateLimit-Limit`	`integer`	Requisições por minuto do plano (por conta).
`X-RateLimit-Remaining`	`integer`	Requisições restantes no minuto corrente.

{
  "error": {
    "code": "internal_error",
    "message": "Erro interno. Tente novamente; se persistir, fale com o suporte.",
    "request_id": "req_01J8ZK3Q9X",
    "retryable": true,
    "docs_url": "https://cnpj.ia.br/docs/erros-e-retentativas#internal_error"
  }
}

504 Tempo esgotado

Timeout de consulta. retryable: true; nada é cobrado.

Header	Tipo	Descrição
`X-Request-Id`	`string`	Identificador da requisição para suporte.
`X-Client-Request-Id`	`string`	Eco do X-Request-Id enviado pelo cliente quando casa ^[A-Za-z0-9_-]{8,64}$. Ausente se o cliente não enviou ou o valor é inválido. Nunca usado como identificador interno.
`X-RateLimit-Limit`	`integer`	Requisições por minuto do plano (por conta).
`X-RateLimit-Remaining`	`integer`	Requisições restantes no minuto corrente.

{
  "error": {
    "code": "upstream_timeout",
    "message": "A operação demorou mais que o esperado. Tente novamente.",
    "request_id": "req_01J8ZK3Q9X",
    "retryable": true,
    "docs_url": "https://cnpj.ia.br/docs/erros-e-retentativas#upstream_timeout"
  }
}

Exemplo

curl -s "https://api.cnpj.ia.br/v1/status"