Consultar a empresa
GET/companies
Retorna os dados da agência. Como cada agência tem apenas uma empresa, a resposta é um único objeto, não uma lista.
Por privacidade, birth_date nunca é retornado, e document só vem preenchido quando o
documento da agência é um CNPJ. Quando é um CPF, document é null.
Retorna 404 se a agência ainda não concluiu o cadastro da empresa.
Requisição
Respostas
- 200
- 304
- 401
- 404
- 429
- 500
Os dados da empresa.
Cabeçalhos da resposta
O limite de requisições por minuto que vale para a sua requisição: o do token (1.000) ou o da agência (3.000), o que tiver menos espaço sobrando.
Quantas requisições ainda restam na janela atual de um minuto, no limite informado em X-RateLimit-Limit.
Uma identificação do conteúdo da resposta. Envie-a em If-None-Match na próxima consulta: se nada mudou, a API responde 304, sem o conteúdo.
private, max-age=60: a resposta pode ser reutilizada por 60 segundos, mas não deve ser guardada em caches compartilhados (CDN, proxy).
O conteúdo não mudou desde a resposta a que o ETag enviado em If-None-Match se refere. A resposta não traz corpo: continue usando a cópia que você já tem.
Cabeçalhos da resposta
Uma identificação do conteúdo da resposta. Envie-a em If-None-Match na próxima consulta: se nada mudou, a API responde 304, sem o conteúdo.
private, max-age=60: a resposta pode ser reutilizada por 60 segundos, mas não deve ser guardada em caches compartilhados (CDN, proxy).
O token não foi enviado, é inválido ou foi revogado. Este é o único formato de erro que não segue o envelope padrão.
A agência ainda não cadastrou os dados da empresa.
Você passou do limite de requisições por minuto (do token ou da agência). Espere o número de segundos indicado em Retry-After e tente de novo; se o erro se repetir, aumente a pausa a cada tentativa. Este erro não usa o envelope padrão.
Cabeçalhos da resposta
Quantos segundos esperar antes de tentar novamente.
O momento em que a janela reabre, como um timestamp Unix (segundos desde 1970).
O limite de requisições por minuto que vale para a sua requisição: o do token (1.000) ou o da agência (3.000), o que tiver menos espaço sobrando.
Quantas requisições ainda restam na janela atual de um minuto, no limite informado em X-RateLimit-Limit.
Ocorreu um erro inesperado na Avoei. O problema é registrado; tente novamente em instantes.