Documentação de módulo

Consulta por Nome

Veja abaixo a estrutura de resposta JSON retornada por este módulo. Os campos podem variar conforme a disponibilidade e atualizações do serviço.

RESPOSTA JSON / EXEMPLO
{
  "tipo": "nome",
  "nome": "xxxxxx xxxxxx",
  "data": {
    "hasNext": true,
    "total": 382,
    "items": [
      {
        "rg": "xxxxxxxxx",
        "name": "XXXXXXX XXXXXX",
        "birthday": "xxxx-xx-xx",
        "age": "xx",
        "zodiac": "XXXXXXXX",
        "document": "xxxxxxxxxxx",
        "degreeEducation": "XXXXX XXXXX XXXXXXXXX",
        "nationality": "XXXXXXXXX",
        "motherName": "XXXXX XXXXXXX XXXXXX XXXXXX",
        "fatherName": "XXXXXX XXXXXX XX XXXX",
        "cbo": "xxxxxx",
        "cboName": "XXXXXXXX XX XXXXXXXXXX",
        "genderType": "Male",
        "isTeenAger": false,
        "isDataProtection": false,
        "situationOfBadCheck": "NothingRegistered",
        "totalAddress": 5,
        "totalEmails": 0,
        "totalBusinessAssociate": 0,
        "totalVehicle": 1,
        "totalPhone": 6,
        "totalInformationCommercial": 8,
        "totalParent": 0,
        "totalNeighbor": 0,
        "totalProperty": 0,
        "totalAlert": 0,
        "totalRestrictionBank": 0,
        "totalRestrictionShopkeeper": 0,
        "totalCheckPreDated": 0,
        "totalOthersContact": 0,
        "bcoProfession": "xxxxxx/XXXXXXXX XX XXXXXXXXXX",
        "mainPhone": {
          "isMain": true,
          "isWhatsApp": false,
          "number": "xxxxxxxxxxx",
          "statusLine": false,
          "city": "XXX XXXXXXXXX",
          "regionAbreviation": "XX",
          "document": "xxxxxxxxxxx"
        }
      },
      {
        "name": "XXXXXXX XXXXXXXXX XXX XXXXXX",
        "birthday": "xxxx-xx-xx",
        "age": "xx",
        "zodiac": "XXXXXX",
        "document": "xxxxxxxxxxx",
        "degreeEducation": "XXXXX XXXXX XXXXXXXXX",
        "nationality": "XXXXXXXXX",
        "motherName": "XXXXX XXXX XXXXXXXX XXX XXXXXX",
        "fatherName": "XXXXXXXX XXXX XXX XXXXXX",
        "cbo": "xxxxxx",
        "cboName": "XXXXXXXX XX XXXXXXXXXX",
        "genderType": "Male",
        "isTeenAger": false,
        "isDataProtection": false,
        "situationOfBadCheck": "NothingRegistered",
        "totalAddress": 4,
        "totalEmails": 1,
        "totalBusinessAssociate": 0,
        "totalVehicle": 0,
        "totalPhone": 3,
        "totalInformationCommercial": 6,
        "totalParent": 0,
        "totalNeighbor": 0,
        "totalProperty": 0,
        "totalAlert": 0,
        "totalRestrictionBank": 0,
        "totalRestrictionShopkeeper": 0,
        "totalCheckPreDated": 0,
        "totalOthersContact": 2,
        "bcoProfession": "xxxxxx/XXXXXXXX XX XXXXXXXXXX",
        "mainPhone": {
          "isMain": true,
          "isWhatsApp": false,
          "number": "xxxxxxxxxxx",
          "statusLine": false,
          "address": "XX XXXXXX XX XXXXXXX",
          "addressNumber": "x",
          "complement": "XX x X x",
          "neighborhood": "XX XXX XXXXXXX XXXXXX XX XXXXXX",
          "zipCode": "xxxxxxxx",
          "city": "XXX XXXXX",
          "regionAbreviation": "XX",
          "document": "xxxxxxxxxxx"
        }
      },
      "... (mais xxx registros)"
    ]
  },
  "tempo_ms": 4943.1
}