Pular para o conteúdo
notemnotemDocumentação

Referência da API › Empresas

Consultar empresa

Devolve os dados cadastrais de uma empresa.

GET/api/v1/empresas/{id}

Use para conferir o cadastro, o endereço e se a empresa está ativa. Empresa de outra organização responde 404.

Parâmetros

idtextono caminhoobrigatório
Empresa da organização da chave (de outra organização → 404). UUID (RFC 9562); fora do padrão → 400 REQUISICAO_INVALIDA com campo id. · UUID

Respostas

200 Empresa

Campos da resposta
idtexto
UUID
id_externotexto ou null
até 100 caracteres
cnpjtexto
CNPJ de 14 posições, numérico ou alfanumérico (12 posições 0-9/A-Z + 2 dígitos verificadores). Na entrada, máscara e minúsculas são aceitas e normalizadas; nas respostas vem sempre com 14 caracteres maiúsculos, sem máscara. · até 18 caracteres
razao_socialtexto
nome_fantasiatexto ou null
inscricao_municipaltexto ou null
emailtexto ou null
telefonetexto ou null
enderecoobjeto
endereco.ceptexto ou null
endereco.logradourotexto ou null
endereco.numerotexto ou null
endereco.complementotexto ou null
endereco.bairrotexto ou null
endereco.codigo_municipiotexto
Formato: ^\d{7}$
endereco.municipiotexto ou null
endereco.uftexto ou null
ativabooleano
criada_emtexto
data e hora ISO 8601
atualizada_emtexto
data e hora ISO 8601

404 Erro no formato padrão

Limites

Valem também os limites gerais da chave. Veja Limites de uso.