> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sherlocker.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Introdução

> Sherlocker: Plataforma de Inteligência Investigativa

Plataforma de inteligência investigativa que conecta dados de pessoas, empresas, patrimônio, processos judiciais e dezenas de outras fontes em uma API unificada.

## Tipos de entidade

Os dados do Sherlocker são organizados em **3 categorias**. Cada categoria agrupa entidades do mesmo domínio:

```mermaid theme={null}
graph LR
    CAD["👤 Cadastral"]
    PAT["🏠 Patrimonial"]
    JUR["⚖️ Jurídico"]

    CAD --> PAT
    CAD --> JUR

    style CAD fill:#6C63FF33,stroke:#6C63FF,color:#ccc
    style PAT fill:#4CAF5033,stroke:#4CAF50,color:#ccc
    style JUR fill:#FF980033,stroke:#FF9800,color:#ccc
```

| Categoria       | Entidades                                                            | Identificadores        |
| --------------- | -------------------------------------------------------------------- | ---------------------- |
| **Cadastral**   | Pessoa, Empresa, Telefone, Email, Endereço, Dívida, Benefício Social | CPF, CNPJ              |
| **Patrimonial** | Propriedade Urbana, Propriedade Rural, Veículo, Aeronave, Patente    | CPF, CNPJ, Placa, NIRF |
| **Jurídico**    | Processo                                                             | CPF, CNPJ, Número CNJ  |

## Entidades

Cada entidade representa um tipo de registro com sua própria estrutura. Clique para ver a tipagem completa:

### Cadastrais

<CardGroup cols={3}>
  <Card title="Pessoa" icon="user" href="/entidades/pessoa">
    Identidade, contatos, familia
  </Card>

  <Card title="Empresa" icon="building" href="/entidades/empresa">
    Cadastro, socios, funcionarios
  </Card>

  <Card title="Telefone" icon="phone" href="/entidades/telefone">
    DDD, operadora, estado
  </Card>

  <Card title="Email" icon="envelope" href="/entidades/email">
    Domínio, corporativo
  </Card>

  <Card title="Endereço" icon="location-dot" href="/entidades/endereco">
    Logradouro, cidade, CEP
  </Card>

  <Card title="Dívida" icon="file-invoice-dollar" href="/entidades/divida">
    Dívida Ativa, FGTS
  </Card>

  <Card title="Benefício" icon="hand-holding-dollar" href="/entidades/beneficio">
    Auxílio Brasil, BPC
  </Card>
</CardGroup>

### Patrimoniais

<CardGroup cols={3}>
  <Card title="Propriedade Urbana" icon="house" href="/entidades/propriedade-urbana">
    IPTU, área, valor venal
  </Card>

  <Card title="Propriedade Rural" icon="tractor" href="/entidades/propriedade-rural">
    SNCR, CAFIR, IBAMA
  </Card>

  <Card title="Veículo" icon="car" href="/entidades/veiculo">
    Placa, marca, modelo
  </Card>

  <Card title="Aeronave" icon="plane" href="/entidades/aeronave">
    Aviões e drones
  </Card>

  <Card title="Propriedade Intelectual" icon="lightbulb" href="/entidades/patente">
    Propriedade intelectual
  </Card>
</CardGroup>

### Juridicas

<CardGroup cols={2}>
  <Card title="Processo" icon="gavel" href="/entidades/processo">
    Número CNJ, tribunal, partes
  </Card>

  <Card title="Documento Público" icon="file-lines" href="/entidades/documento">
    Diário Oficial, publicações
  </Card>
</CardGroup>

## Perfis agregados

Os **perfis** são endpoints que combinam múltiplas entidades de uma categoria em uma única chamada. Em vez de consultar veículos, imóveis e patentes separadamente, use o perfil patrimonial para obter tudo de uma vez:

<CardGroup cols={2}>
  <Card title="Perfil Cadastral" icon="users" href="/areas/contatos">
    `GET /perfil/cadastral/cpf/{cpf}` — identidade + contatos + vinculos + dividas + beneficios + dominios
  </Card>

  <Card title="Perfil Patrimonial" icon="landmark" href="/areas/patrimonio">
    `GET /perfil/patrimonial/cpf/{cpf}` — todos os bens
  </Card>

  <Card title="Perfil Juridico" icon="scale-balanced" href="/areas/juridico">
    `GET /perfil/juridico/cpf/{cpf}` — processos + regularidade
  </Card>
</CardGroup>

Todos os perfis também aceitam CNPJ para consultas de empresas.

## Como as entidades se conectam

A **Pessoa** (CPF) e a **Empresa** (CNPJ) são as entidades centrais — todas as outras se vinculam a elas:

```mermaid theme={null}
graph LR
    P["👤 Pessoa"] --> E["🏢 Empresa"]
    E --> P
    P --> IU["🏠 Imovel"]
    P --> V["🚗 Veiculo"]
    P --> A["✈️ Aeronave"]
    P --> PR["⚖️ Processo"]
    P --> D["💳 Divida"]
    P --> RD["🌐 Registro"]
    E --> IU
    E --> V
    E --> PR
    E --> D

    style P fill:#6C63FF33,stroke:#6C63FF,color:#ccc
    style E fill:#FF6B6B33,stroke:#FF6B6B,color:#ccc
    style IU fill:#4CAF5033,stroke:#4CAF50,color:#ccc
    style V fill:#4CAF5033,stroke:#4CAF50,color:#ccc
    style A fill:#4CAF5033,stroke:#4CAF50,color:#ccc
    style PR fill:#FF980033,stroke:#FF9800,color:#ccc
    style D fill:#FF6B6B33,stroke:#FF6B6B,color:#ccc
    style RD fill:#00BCD433,stroke:#00BCD4,color:#ccc
```

### Buscas reversas

| Dado inicial | Resultado       | Rota                               |
| ------------ | --------------- | ---------------------------------- |
| Telefone     | CPFs associados | `GET /pessoas/telefone/{telefone}` |
| Email        | CPFs associados | `GET /emails/email/{email}`        |
| Placa        | Proprietário    | `GET /veiculos/placa/{placa}`      |
| CPF do socio | Empresas        | `GET /empresas/cpf/{cpf}`          |

## Casos de uso

<CardGroup cols={2}>
  <Card title="Background Check" icon="shield-check" href="/casos-de-uso/background-check">
    Verificação de antecedentes cruzando 7 dimensões
  </Card>

  <Card title="Enriquecimento de Leads" icon="bullseye-arrow" href="/casos-de-uso/enriquecimento-leads">
    Telefone ou email para perfil completo
  </Card>

  <Card title="Due Diligence" icon="building-magnifying-glass" href="/casos-de-uso/due-diligence">
    Investigação completa antes de fechar negócio
  </Card>

  <Card title="Levantamento Patrimonial" icon="landmark" href="/casos-de-uso/levantamento-patrimonial">
    Localizar bens para penhora e execução judicial
  </Card>

  <Card title="Localização de Partes" icon="magnifying-glass-location" href="/casos-de-uso/localizacao-partes">
    Encontrar endereço e telefone para citação judicial
  </Card>

  <Card title="Scoring de Renda" icon="chart-pyramid" href="/casos-de-uso/segmentacao-patrimonial">
    Classificar contatos por faixa de renda
  </Card>
</CardGroup>

## Começando

### Base URL

```
https://221b-api.sherlocker.com.br/api/v1
```

Consulte [Autenticação](/authentication) para configurar seu token.

### Importar no Postman

<Steps>
  <Step title="Importar no Postman">
    Abra o Postman, clique **Import**, cole a URL abaixo:

    ```
    https://221b-api.sherlocker.com.br/api/v1/postman/collection.json
    ```

    Ou veja o guia completo em [Testando com Postman](/guias/postman).
  </Step>

  <Step title="Configurar token">
    Collection Sherlocker API, aba Variables, preencha `token`.
  </Step>
</Steps>

A collection está organizada em 4 pastas: Perfis Agregados, Cadastro, Patrimônio e Jurídico.