Relacionamentos Econômicos
O serviço de Relacionamentos Econômicos retorna entidades relacionadas ao indivíduo em um contexto econômico, como participação societária e vínculos empregatícios.
Quando usar
Descrição
O serviço de Relacionamentos Econômicos fornece a lista de entidades relacionadas com o indivíduo consultado em um escopo econômico, abrangendo tipos de relacionamento como participação societária em empresas, relacionamentos de emprego (cujo detalhamento pode ser consultado no serviço de Dados Profissionais), entre outros.
Requisição
Autenticação por chave de API (cabeçalho Authorization: Bearer), criada no painel com esta consulta no escopo.
POST /api/v1/{tenant}/pessoas/relacionamentos-economicos
| Campo | Obrigatório | Descrição |
|---|---|---|
document |
sim | CPF da pessoa, com ou sem máscara. |
{
"document": "000.000.000-00"
}
Campos de retorno
Campos dentro de data. [] indica lista.
| Campo | Tipo |
|---|---|
BusinessRelationships[].RelatedEntityTaxIdNumber |
texto |
BusinessRelationships[].RelatedEntityTaxIdType |
texto |
BusinessRelationships[].RelatedEntityTaxIdCountry |
texto |
BusinessRelationships[].RelatedEntityName |
texto |
BusinessRelationships[].RelationshipName |
texto |
BusinessRelationships[].RelationshipType |
texto |
BusinessRelationships[].RelationshipSubtype |
texto |
BusinessRelationships[].RelationshipLevel |
texto |
BusinessRelationships[].RelationshipStartDate |
data |
BusinessRelationships[].RelationshipEndDate |
data |
BusinessRelationships[].IsCurrentlyActive |
booleano |
BusinessRelationships[].CreationDate |
data |
BusinessRelationships[].LastUpdateDate |
data |
TotalRelationships |
número |
TotalOwnerships |
número |
TotalEmployments |
número |
TotalPartners |
número |
TotalClients |
número |
TotalSuppliers |
número |
Exemplo de resposta
Estrutura real da resposta, com valores fictícios.
{
"execution_id": "00000000-0000-0000-0000-000000000000",
"status": "success",
"message": "Consulta realizada com sucesso",
"query_name": "Relacionamentos Econômicos",
"query_slug": "relacionamentos-economicos",
"data": {
"BusinessRelationships": [
{
"RelatedEntityTaxIdNumber": "texto",
"RelatedEntityTaxIdType": "texto",
"RelatedEntityTaxIdCountry": "texto",
"RelatedEntityName": "texto",
"RelationshipName": "texto",
"RelationshipType": "texto",
"RelationshipSubtype": "texto",
"RelationshipLevel": "texto",
"RelationshipStartDate": "2026-01-01",
"RelationshipEndDate": "2026-01-01",
"IsCurrentlyActive": false,
"CreationDate": "2026-01-01",
"LastUpdateDate": "2026-01-01",
"AdditionalDetails": {
}
}
],
"TotalRelationships": 0,
"TotalOwnerships": 0,
"TotalEmployments": 0,
"TotalPartners": 0,
"TotalClients": 0,
"TotalSuppliers": 0
},
"consulted_at": "2026-01-01T12:00:00Z",
"query_cost": "0.100"
}
Cobrança e respostas
- O valor é cobrado por consulta bem-sucedida.
- 200 — consulta processada (veja status no corpo da resposta)
- 401 — token ausente, inválido, inativo ou expirado
- 403 — serviço fora do escopo da chave, IP não autorizado ou limite de consumo excedido
- 422 — campo obrigatório ausente/inválido ou payload acima do limite do serviço
- 429 — limite de requisições por minuto da chave excedido
- 504 — tempo máximo de execução do serviço excedido