Companies
List companies
Lists the companies of your account with review status and certificate summary.
GET
/openapi/v2/empresasRequires the
token, timestamp and sign signature headers, see Authentication.Returns only the companies of the integrator account that owns the application, newest first. Use it to recover the empresaId of companies already registered and to follow the review without opening the console. For enabled document types, address and review times see Query company. Shares the interface subscription of Register company and is not billed.
Query parameters
cnpj | string | CNPJ |
status | string | Status filter |
nome | string | Name |
pagina | int | Page |
tamanho | int | Page size |
* Required field
200
A page of companies. With no matches,
itens is an empty array.pagina | int | Page returned |
tamanho | int | Page size applied |
total | int | Total companies |
totalLimitado | bool | Total capped |
| array | Companies on the page |
statusCompany status
Same values for the filter and for itens[].status.
| Values | Meaning |
|---|---|
| Rascunho | Saved and not yet sent for review; camposPendentes lists what is missing |
| AguardandoAprovacao | Under platform review; cannot issue yet |
| Ativa | Approved; can issue once a valid certificate is linked |
| Rejeitada | Refused at review; motivoStatus carries the reason. Fix and resubmit in the console; if it had fields in camposPendentes, completing them with Register company (body with id) sends it back to manual review |
| Inativa | Disabled; does not issue until re-enabled in the console |
itens[].ambienteEmissaoEnvironment
| Values | Meaning |
|---|---|
| Homologacao | Homologation (testing); default for every newly registered company |
| Producao | Production; the switch is done by platform operations |
itens[].certificado.statusCertificate status
| Values | Meaning |
|---|---|
| Nenhum | No certificate linked |
| Valido | Certificate in force |
| ProximoVencimento | In force but expiring soon; still issues |
| Vencido | Expired; link a new certificate to issue again |
| Code | HTTP | |
|---|---|---|
| 10001001 | 400 | status outside the enumeration, invalid cnpj, or pagina / tamanho out of range. |
