Relacionamentos e QSA/UBO

Relacionamentos Pessoais

O serviço de Relacionamentos Pessoais retorna entidades ligadas ao indivíduo, como família, household, colegas e outros vínculos não profissionais.

Falar com o comercial Ver o catálogo

Quando usar

Descrição

O serviço de Relacionamentos Pessoais fornece uma lista de entidades relacionadas ao indivíduo consultado em um escopo pessoal, que inclui a família, o household, colegas de classe (pessoas que fizeram o mesmo curso na mesma faculdade na mesma época) e outros vínculos de cunho não profissional.

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-pessoais

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
`PersonalRelationships[].RelatedEntityTaxIdNumber`	texto
`PersonalRelationships[].RelatedEntityTaxIdType`	texto
`PersonalRelationships[].RelatedEntityTaxIdCountry`	texto
`PersonalRelationships[].RelatedEntityName`	texto
`PersonalRelationships[].RelationshipType`	texto
`PersonalRelationships[].RelationshipLevel`	texto
`PersonalRelationships[].RelationshipStartDate`	data
`PersonalRelationships[].RelationshipEndDate`	data
`PersonalRelationships[].CreationDate`	data
`PersonalRelationships[].LastUpdateDate`	data
`TotalRelationships`	número
`TotalRelatives`	número
`TotalNeighbors`	número
`TotalSpouses`	número
`TotalCoworkers`	número
`TotalHousehold`	número
`TotalPartners`	número
`TotalCollegeClass`	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 Pessoais",
  "query_slug": "relacionamentos-pessoais",
  "data": {
    "PersonalRelationships": [
      {
        "RelatedEntityTaxIdNumber": "texto",
        "RelatedEntityTaxIdType": "texto",
        "RelatedEntityTaxIdCountry": "texto",
        "RelatedEntityName": "texto",
        "RelationshipType": "texto",
        "RelationshipLevel": "texto",
        "RelationshipStartDate": "2026-01-01",
        "RelationshipEndDate": "2026-01-01",
        "CreationDate": "2026-01-01",
        "LastUpdateDate": "2026-01-01"
      }
    ],
    "TotalRelationships": 0,
    "TotalRelatives": 0,
    "TotalNeighbors": 0,
    "TotalSpouses": 0,
    "TotalCoworkers": 0,
    "TotalHousehold": 0,
    "TotalPartners": 0,
    "TotalCollegeClass": 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