Documentação de módulo

CPF Alternativo

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": "cpf",
  "cpf": "xxxxxxxxxxx",
  "data": {
    "dadosPessoais": {
      "nome": "XXXXXX XXXXXXX XXXX",
      "documento": "xxxxxxxxxxx",
      "dataNascimento": "xx/xx/xxxx",
      "aniversario": "xx/xx/xx",
      "idade": "xx",
      "signo": "XXXXX",
      "genero": "X",
      "tipoGenero": "Xxxx",
      "nomeMae": "XXXXX XXXXXXX",
      "nomePai": "XXXX XXXXXXX XXXX",
      "filiacao": "XXXXX XXXXXXX",
      "uf": "XX",
      "pais": "XXXXXX",
      "cidadeNascimento": "XXXXXXXXXX",
      "siglaCidade": "XXX",
      "situacaoReceita": "XXXXXXX",
      "restricaoInformacao": "* XXXX XXXXX *"
    },
    "enderecos": {
      "hasNext": true,
      "total": 7,
      "items": [
        "XXX XXXXX XXXXX XX XXXXX XXXXXX, XX, XXXXX, XXXXXXXXXX, XX, xxxxxxxx",
        "XXX XXXXX XX XXXXX, XXXXX, XXXXXXXXXX, XX, xxxxxxxx",
        "... (mais x endereços)"
      ]
    },
    "telefones": {
      "hasNext": true,
      "total": 8,
      "items": [
        {
          "isWhatsApp": true,
          "operator": "XXXX",
          "number": "xxxxxxxxxxx",
          "statusLine": true,
          "chargeType": "XXX XXXX",
          "actual": 24,
          "level": 5
        },
        {
          "isWhatsApp": false,
          "operator": "XXXXXXX",
          "number": "xxxxxxxxxx",
          "statusLine": true,
          "actual": 23,
          "level": 5
        },
        "... (mais x telefones)"
      ]
    },
    "emails": {
      "hasNext": true,
      "total": 4,
      "items": [
        {
          "email": "xxxxxxxxxxxx@xxxxx.xxx.xx"
        },
        {
          "email": "xxxxxxxx@xxxxxxx.xxx"
        },
        "... (mais x e-mails)"
      ]
    },
    "outrosContatos": {
      "hasNext": true,
      "total": 2,
      "items": [
        {
          "companyStatus": "XXXXXX",
          "owner": "XXXXXXXXX XXXX XXXXXXXX XXXX XXX",
          "nature": "XXXXXXXXX XXXXXXXXXX XXXXXXX",
          "document": "xxxxxxxxxxxxxx",
          "openDate": "xxxx-xx-xxT00:00:00",
          "genderType": "Male",
          "contactInfoList": [
            {
              "id": 0,
              "address": "XX XXXXXXXX XX XXXXXXXX, xx, XX X, XXXXXX, XXXXXXXXXX, XX, xxxxxxxx",
              "phones": [
                {
                  "isMain": false,
                  "isWhatsApp": false,
                  "number": "xxxxxxxxxx",
                  "operator": "XX",
                  "owner": "XXXXXXXXX XXXX XXXXXXXX XXXX XXX",
                  "statusLine": false
                }
              ]
            }
          ]
        },
        {
          "owner": "XXXXXXXX XXXXXX",
          "document": "xxxxxxxxxxx",
          "voterRegistration": "xxxxxxxxxxxx",
          "motherName": "XXXXXX XXXXXX",
          "zodiac": "XXXX",
          "name": "XXXXXXXX XXXXXX",
          "genderType": "Male",
          "birthday": "xxxx-xx-xx",
          "age": "xx",
          "contactInfoList": [
            {
              "id": 0,
              "address": "XX XX XXXXXX XXXXXXXXX, XXX, XXXXX XXX XXXXXXXXXX, XX, xxxxxxxx",
              "phones": [
                {
                  "isMain": false,
                  "isWhatsApp": true,
                  "number": "xxxxxxxxxxx",
                  "operator": "XXXX",
                  "owner": "XXXXXXXX XXXXXX",
                  "statusLine": true
                }
              ]
            }
          ]
        }
      ]
    },
    "parentes": {
      "hasNext": true,
      "total": 5,
      "items": [
        {
          "name": "XXXXXX XXXXXXX XXXX",
          "birthday": "xxxx-xx-xxT00:00:00",
          "document": "xxxxxxxxxxx",
          "zodiac": "XXXX",
          "parentage": "XXXXX(X)",
          "parentageForm": "XXXXXXXXXXX",
          "voterRegistration": "xxxxxxxxxxxx",
          "genderType": "Female",
          "motherName": "XXXXX XXXXXXX",
          "fatherName": "XXXX XXXXXXX XXXX",
          "totalPhone": 7,
          "totalAddress": 6,
          "contactInfoList": [
            {
              "id": 0,
              "address": "XXX XX XXXXXX, x, XXXXXX XXXXXX, XXXXXXXXXX, XX, xxxxxxxx",
              "phones": [
                {
                  "isMain": false,
                  "isWhatsApp": true,
                  "number": "xxxxxxxxxxx",
                  "operator": "XXXXX",
                  "owner": "XXXXXX XXXXXXX XXXX",
                  "statusLine": true
                },
                {
                  "isMain": false,
                  "isWhatsApp": false,
                  "number": "xxxxxxxxxx",
                  "operator": "XX",
                  "owner": "XXXXXX XXXXXXX XXXX",
                  "statusLine": false,
                  "dateInstallation": "xxxx-xx-xxT00:00:00"
                }
              ]
            },
            {
              "id": 0,
              "address": "XXX XX XXXXXX, xxx, XXXXXX XXXXXXXXX, XXXXXXXXXX, XX, xxxxxxxx",
              "phones": [
                {
                  "isMain": false,
                  "isWhatsApp": true,
                  "number": "xxxxxxxxxxx",
                  "operator": "XXXXX",
                  "owner": "XXXXXX XXXXXXX XXXX",
                  "statusLine": true,
                  "dateInstallation": "xxxx-xx-xxT00:00:00"
                },
                {
                  "isMain": false,
                  "isWhatsApp": false,
                  "number": "xxxxxxxxxx",
                  "operator": "XXXXX",
                  "owner": "XXXXXX XXXXXXX XXXX",
                  "statusLine": true,
                  "dateInstallation": "xxxx-xx-xxT00:00:00"
                }
              ]
            },
            "... (mais x endereços/telefones)"
          ]
        },
        {
          "name": "XXXXXXXXXX XXXXXXX XXXX XX XXXXX",
          "birthday": "xxxx-xx-xxT00:00:00",
          "document": "xxxxxxxxxxx",
          "zodiac": "XXXXXX",
          "parentage": "XXXXX(X)",
          "parentageForm": "XXXXXXXXXXX",
          "voterRegistration": "xxxxxxxxxxxx",
          "genderType": "Female",
          "motherName": "XXXXXXXXXX XXXXXXX XXXX",
          "fatherName": "XXXX XXXXXXX XXXX",
          "totalPhone": 8,
          "totalAddress": 7,
          "contactInfoList": [
            {
              "id": 0,
              "address": "XXX X XXXXXX XXXXXXXXXXX, XX X, XXXXXXXXXXX, XXXXXXXXXX, XX, xxxxxxxx",
              "phones": [
                {
                  "isMain": false,
                  "isWhatsApp": true,
                  "number": "xxxxxxxxxxx",
                  "operator": "XXXX ",
                  "owner": "XXXXXXXXXX XXXXXXX XXXX XX XXXXX",
                  "statusLine": true
                },
                {
                  "isMain": false,
                  "isWhatsApp": true,
                  "number": "xxxxxxxxxxx",
                  "operator": "XXXX ",
                  "owner": "XXXXXXXXXX XXXXXXX XXXX XX XXXXX",
                  "statusLine": true
                }
              ]
            },
            {
              "id": 0,
              "address": "XXX XXX XXXXX X xxx, XXXXXXXXXXX, XXXXXXXXXX, XX, xxxxxxxx",
              "phones": [
                {
                  "isMain": false,
                  "isWhatsApp": false,
                  "number": "xxxxxxxxxx",
                  "operator": "XXXXXXX",
                  "owner": "XXXXXXXXXX XXXXXXX XXXX XX XXXXX",
                  "statusLine": true
                }
              ]
            },
            "... (mais x endereços/telefones)"
          ]
        },
        "... (mais x parentes)"
      ]
    },
    "vizinhos": {
      "hasNext": true,
      "total": 49,
      "items": [
        {
          "personAge": "xx",
          "name": "XXXXX XXX XXXXXX XXXXXXXX",
          "zipCode": "xxxxxxxx",
          "birthday": "xxxx-xx-xxT00:00:00",
          "document": "xxxxxxxxxxx",
          "zodiac": "XXXXX",
          "voterRegistration": "xxxxxxxxxxxx",
          "genderType": "Female",
          "motherName": "XXXXX XXXX XXX XXXXXX",
          "documentType": "CPF",
          "situationOfBadCheck": "NothingRegistered",
          "activityArea": [],
          "totalPhone": 3,
          "totalAddress": 3
        },
        {
          "personAge": "xx",
          "name": "XXXXX XXXXXXX",
          "zipCode": "xxxxxxxx",
          "birthday": "xxxx-xx-xxT00:00:00",
          "document": "xxxxxxxxxxx",
          "zodiac": "XXXXX",
          "voterRegistration": "xxxxxxxxxxxx",
          "genderType": "Female",
          "motherName": "XXXXXX XXXXXXX",
          "documentType": "CPF",
          "situationOfBadCheck": "NothingRegistered",
          "activityArea": [],
          "totalPhone": 1,
          "totalAddress": 1
        },
        "... (mais xx vizinhos)"
      ]
    },
    "empresasSocio": {
      "hasNext": false,
      "total": 1,
      "items": [
        {
          "name": "XXXXXX XXXXXXX XXXX",
          "cpf": "xxxxxxxxxxx",
          "document": "xxxxxxxxxxxxxx",
          "documentType": "CNPJ",
          "companyName": "XXXXX XX XXXXXXXXXX XXXXXXXX XX XXXXXXXXX XX XXXXXXXXXXX XXXX",
          "fantasyName": "XXXXX XXXXXXXXX XX XXXXXXXXXXX",
          "business": "XXXXX-XXXXXXXXXXXXX",
          "participation": "0",
          "openDate": "xxxx-xx-xxT00:00:00",
          "inputDate": "xxxx-xx-xxT00:00:00"
        }
      ]
    },
    "infoComercial": {
      "hasNext": true,
      "total": 2,
      "items": [
        {
          "companyStatus": "XXXXX",
          "owner": "X XXXXXXXXX XX XXXXXXXXX XXXXXXXXX XXXX",
          "nature": "XXXXXXXXX XXXXXXXXXX XXXXXXX",
          "document": "xxxxxxxxxxxxxx",
          "openDate": "xxxx-xx-xxT00:00:00",
          "referringYear": "xxxx"
        },
        {
          "companyStatus": "XXXXX",
          "owner": "XXXX XX XXXX",
          "nature": "XXXXXXXXX XXXXXXXXXX XXXXXXX",
          "document": "xxxxxxxxxxxxxx",
          "openDate": "xxxx-xx-xxT00:00:00",
          "referringYear": "xxxx"
        },
        "... (mais x registros)"
      ]
    },
    "historicoCredito": {
      "consultationTelephoneOwner": {
        "phone": [
          {
            "number": "xxxxxxxxxxx",
            "address": "X XXXXXXXXXX-XX xxx",
            "neighborhood": "XXX XXXXX",
            "zipCode": "xxxxxxxx",
            "city": "XXXXXXXXXX",
            "uf": "XX"
          },
          {
            "number": "xxxxxxxxxx",
            "address": "XXX XXXXX XXXXX XX XXXXX XXXXXX-XX",
            "neighborhood": "XXXXX",
            "zipCode": "xxxxxxxx",
            "city": "XXXXXXXXXX",
            "uf": "XX"
          },
          "... (mais x telefones)"
        ]
      },
      "consultationTelephoneReference": {
        "phone": [
          {
            "number": "xxxxxxxxxxx",
            "address": "X XXXXXXXXXX XX xxx",
            "neighborhood": "XXX XXXXX",
            "zipCode": "xxxxxxxx",
            "city": "XXXXXXXXXX",
            "uf": "XX",
            "owner": "XXXXXX XXXXXXX XXXX"
          },
          {
            "number": "xxxxxxxxxx",
            "address": "XX XXXXXXXX XX XXXXXXXX xx XX X",
            "neighborhood": "XXXXXX",
            "zipCode": "xxxxxxxx",
            "city": "XXXXXXXXXX",
            "uf": "XX",
            "owner": "XXXXXXXXX XXXX XXXXXXXX XXXX XXX"
          },
          "... (mais x telefones)"
        ]
      },
      "rentpf": [],
      "creditoHistorico": {
        "informationRestriction": "* XXXX XXXXX *",
        "name": "XXXXXX XXXXXXX XXXX",
        "revenueStatus": "XXXXXXX",
        "country": "XXXXXX",
        "uf": "XX",
        "cityBirth": "XXXXXXXXXX",
        "acronymCity": "XXX",
        "spouseDocument": "",
        "spouseName": "",
        "gender": "X",
        "statusCivil": "",
        "document": "xxxxxxxxxxx",
        "affiliation": "XXXXX XXXXXXX",
        "motherName": "XXXXX XXXXXXX",
        "fatherName": "XXXX XXXXXXX XXXX",
        "rg": "",
        "birthday": "xx/xx/xx",
        "birthdayDate": "xx/xx/xxxx",
        "age": "xx",
        "foundingDate": "",
        "zodiac": "XXXXX",
        "genderType": "Xxxx",
        "restrictionBank": {
          "quantity": "0",
          "restriction": [
            {
              "message": "XXXX XXXXXX XXXXXXXXX XXXXXXXXXX XXXX XXXX XXX/XXXX"
            }
          ]
        },
        "restrictionShopkeeper": {
          "quantity": "0",
          "restriction": [
            {
              "message": "XXXX XXXXXX XXXXXXXXX XXXXXXXX XXXX XXXX XXX/XXXX"
            }
          ]
        },
        "checkPreDated": {
          "quantity": "0",
          "check": [
            {
              "emission": "",
              "bank": "",
              "numberDoc": "",
              "dateDue": "",
              "amount": "",
              "client": ""
            }
          ]
        },
        "alerts": {
          "quantity": "0",
          "alert": {
            "message": "XXXX XXXXXX XXXXXXX XXXX XXXX XXX/XXXX"
          }
        }
      }
    }
  },
  "tempo_ms": 3171.5
}