# Bigdata

## Disclaimer

Essa API atua em conformidade com as regras da[ Lei Geral de Proteção de Dados (LGPD. Lei 13.709/2018)](https://pt.wikipedia.org/wiki/Lei_Geral_de_Prote%C3%A7%C3%A3o_de_Dados_Pessoais) já que todos os dados disponíveis nos resultados dos documentos consultados são coletados através de técnicas de [Webscraping ](https://pt.wikipedia.org/wiki/Coleta_de_dados_web)a bases e APIs públicas de mídias sociais e portais governamentais que qualquer outra pessoa teria acesso, se assim o quisesse.

{% hint style="success" %}
Este serviço **possui dados somente de empresas e pessoas do Brasil**. No momento não temos a disponibilidade de consultas de pessoas ou empresas de diferente nacionalidade.
{% endhint %}

## Dados desatualizados

É possível que o serviço retorne dados desatualizados, ou até mesmo nenhum dado da pessoa pesquisada (seja ela física ou jurídica). Quando nenhum dado for retornado, ou seja, o documento não constar em nossa base, você não será tarifado(a).

O intuito do serviço é disponibilizar uma ferramenta para que você possa validar e/ou atualizar a sua base de dados para conseguir realizar contato direto com a pessoa pesquisada.

## Webhooks

Diferentemente da primeira versão da API que retornava os dados da consulta diretamente no *body* da resposta do serviço, esta versão retorna os dados do documento pesquisado a seu endpoint encodados em JSON via método POST.

Para registrar seus endpoints acesse o menu **Minha conta > Configurações > Webhooks**

![Tela de configurações de endpoints para Webhooks](/files/-MfDhONXWm76SCqDEcDq)

{% hint style="danger" %}
**TIMEOUT - 10 segundos**\
Este é o tempo de espera máxima que nossos servidores usam para ter uma resposta (positiva ou negativa) do seu endpoint cadastrado nos webhooks. Passado esse tempo, o pacote de dados será descartado, sem possibilidade de reenvio.
{% endhint %}

### Pessoa física (CPF)

Modelo de objeto JSON enviados a seu webhook quando o documento pesquisado trata-se de uma pessoa física (CPF) com dados disponíveis em nossas bases de dados.

```javascript
{
  "id": 123,
  "customId": "fire0001",
  "campaignId": 190,
  "ip": "127.127.1.1",
  "cost": 0.25,
  "statusCode": 1,
  "statusName": "NEW",
  "statusDate": "2021-09-13T17:00:56-0300",
  "person": {
    "document": "02203304405",
    "documentSituation": "REGULAR",
    "fullname": "JOÃO BEZERRA DA SILVA",
    "birthday": "1927-02-23",
    "sex": "masc",
    "mother": "EMILIA DA SILVA",
    "dead": true,
    "income": "1000",
    "score": "ALTISSIMO",
    "occupation": "MUSICO e INSTRUMENTISTA",
    "mobiles": [
      {
        "area": "85",
        "number": "944556677",
        "checked": true,
        "whatsapp": true,
        "ranking": 1
      }
    ],
    "landlines": [
      {
        "area": "85",
        "number": "22445566",
        "checked": true,
        "whatsapp": false,
        "ranking": 1
      }
    ],
    "emails": [
      {
        "email":"silva_bez@gmail.com",
        "checked":false,
        "ranking":1
      }
    ],
    "addresses": [
      {
        "direction": "R FUNCHAL 418 29 A",
        "number": "418",
        "plus": "29 A",
        "district": "VL OLIMPIA",
        "city": "SAO PAULO",
        "state": "SP",
        "postalcode": "04551060",
        "type": "residencial",
        "ranking": 1
      }
    ],
    "vehicles": [
      {
        "plate": "AAA6677",
        "model": "VW/SANTANA GLS",
        "manufactureYear": 1988,
        "modelYear": 1988,
        "renavan": "444555666",
        "chassis": "9BWZZZ32ZJP00112233",
        "licensingDate": "1993-07-05T00:00:00-0300",
        "ranking": 1
      }
    ],
    "parents": [
      {
        "fullname":"EMILIA DA SILVA",
        "document":"02288877766",
        "type":"MAE"
      }
    ],
    "businesses": [
      {
        "fullname": "PADARIA BEZERRA LTDA",
        "document": "334445550000109",
        "capital": 220000,
        "share": 100,
        "status": "ATIVA",
        "fundationDate": "1966-07-20T00:00:00-0300"
      }
    ]
  }
}
```

> Acesse a seção [Consultar queries](/apis-v2/bigdata/consultar-queries.md) para ter informações detalhadas dos códigos e significados de cada um dos parâmetros.

### Pessoa jurídica (CNPJ)

Modelo de objeto JSON enviados a seu webhook quando o documento pesquisado trata-se de uma pessoa jurídica (CNPJ) com dados disponíveis em nossas bases de dados.

```javascript
{
  "id": 124,
  "customId": "fire0002",
  "campaignId": 190,
  "ip": "127.127.1.1",
  "cost": 0.25,
  "statusCode": 1,
  "statusName": "NEW",
  "statusDate": "2021-09-13T17:00:56-0300",
  "company": {
    "document": "00111222000100",
    "documentSituation": "ATIVA",
    "fiscalName": "EMPRESA EXEMPLO LTDA ME",
    "fantasyName": "EMPRESA EXEMPLO",
    "birthday": "2001-02-25",
    "type": "ME",
    "occupation": "PROMOÇÃO DE VENDAS",
    "business": [
      {
        "code": "73190",
        "type": "SERVICO",
        "segment": "7319002",
        "description": "PROMOÇÃO DE VENDAS"
      }
    ],
    "mobiles": [
      {
        "area": "11",
        "number": "944556677",
        "checked": true,
        "whatsapp": true,
        "ranking": 1
      }
    ],
    "landlines": [
      {
        "area": "11",
        "number": "22445566",
        "checked": true,
        "whatsapp": false,
        "ranking": 1
      }
    ],
    "emails": [
      {
        "email": "exemplo@empresa.com.br",
        "checked": false,
        "ranking": 1
      }
    ],
    "addresses": [
      {
        "type": "comercial",
        "direction": "AV PAULISTA 1001",
        "number": "1001",
        "plus": "CONJUNTO 10",
        "district": "BELA VISTA",
        "city": "SAO PAULO",
        "state": "SP",
        "postalcode": "01310300",
        "ranking": 1
      }
    ],
    "vehicles": [
      {
        "plate": "AAA6677",
        "model": "PEUGEOT/206 SOLEIL",
        "manufactureYear": 2007,
        "modelYear": 2008,
        "renavan": "777888999",
        "chassis": "AA00BBB22C3333333",
        "licensingDate": "2009-07-05T00:00:00-0300",
        "ranking": 1
      }
    ],
    "associates": [
      {
        "fullname": "JOÃO SILVA",
        "document": "11122233344",
        "capital": 100000,
        "share": 100
      }
    ]
  }
}
```

> Acesse a seção [Consultar queries](/apis-v2/bigdata/consultar-queries.md) para ter informações detalhadas dos códigos e significados de cada um dos parâmetros.

### Documento inválido

Estrutura dada tanto para documento de pessoa física (CPF) ou jurídica (CNPJ) quando inválido ou inexistente em nossas bases.

```javascript
{
  "id": 123,
  "customId": "fire0001",
  "campaignId": 190,
  "document": "02203304405",
  "statusCode": 3,
  "statusName": "INVALID",
  "statusDate": "2021-09-20T16:47:41-0300"
}
```

> Acesse a seção [Consultar queries](/apis-v2/bigdata/consultar-queries.md) para ter informações detalhadas dos parâmetros que serão enviados de acordo com o tipo de documento consultado


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.smsfire.com.br/apis-v2/bigdata.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.