Skip to main content
GET
Consultar identidade da entidade

Autorizações

Authorization
string
header
obrigatório

OAuth2 Authorization Code flow

Parâmetros de caminho

id
string
obrigatório

CPF, CNPJ ou identificador da empresa (cmp_*).

Resposta

200 - application/json

Consulta concluída. Verifique o status e a proveniência dos dados quando presentes.

object
enum<string>
obrigatório

Tipo do objeto retornado.

Opções disponíveis:
entity
id
string
obrigatório

Identificador canônico da entidade.

entityType
enum<string>
obrigatório

Tipo da entidade: company (empresa) ou person (pessoa).

Opções disponíveis:
company,
person
document
string
obrigatório

Documento da entidade: CPF, CNPJ ou identificador internacional.

name
string | null

Nome da entidade, quando disponível.

Razão social, disponível para empresas.

tradeName
string | null

Nome fantasia, disponível para empresas.

icon
object | null

Ícone ou logotipo da empresa, quando disponível.