# pessoas

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /api/v2/pessoas/:
    get:
      summary: pessoas
      deprecated: false
      description: |
        API da consulta BÁSICA do CPF.

        ** Deve possuir acesso API: Sim (Básica)  **

        1. Inclui dados básicos do CPF
        2. Pode ser feito consultas únicas
        3. Parâmetros opcionais para consultas (celular, endereço) 
      tags:
        - API_BASICA
      parameters:
        - name: Content-Type
          in: header
          description: ''
          required: true
          example: application/json
          schema:
            type: string
        - name: x-api-key
          in: header
          description: ''
          required: true
          example: '{{x-api-key}}'
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                cpf:
                  type: string
                  description: Número do CPF
                endereco:
                  type: integer
                  description: 'Obrigatório: 1 sim / 0 ou ausente não'
                celular:
                  type: integer
                  description: 'Obrigatório: 1 sim / 0 ou ausente não'
              required:
                - cpf
              x-apidog-orders:
                - cpf
                - celular
                - endereco
            example:
              cpf: '17701100890'
              celular: 1
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  pf:
                    type: array
                    items:
                      type: object
                      properties:
                        cpf:
                          type: string
                        nome:
                          type: string
                        mae:
                          type: string
                        sexo:
                          type: string
                        dn:
                          type: string
                        obito:
                          type: string
                        idade:
                          type: string
                        score:
                          type: string
                        frisco:
                          type: string
                        frenda:
                          type: string
                        classe:
                          type: string
                        escolaridade:
                          type: string
                        email:
                          type: string
                        email2:
                          type: string
                        linkedin_pessoa:
                          type: string
                        ddd:
                          type: string
                        tel1:
                          type: string
                        tel2:
                          type: string
                        tel3:
                          type: string
                        cel1:
                          type: string
                        cel2:
                          type: string
                        cel3:
                          type: string
                        endereco:
                          type: string
                        numero:
                          type: string
                        compl:
                          type: string
                        cep:
                          type: string
                        bairro:
                          type: string
                        cidade:
                          type: string
                        uf:
                          type: string
                      x-apidog-orders:
                        - cpf
                        - nome
                        - mae
                        - sexo
                        - dn
                        - obito
                        - idade
                        - score
                        - frisco
                        - frenda
                        - classe
                        - escolaridade
                        - email
                        - email2
                        - linkedin_pessoa
                        - ddd
                        - tel1
                        - tel2
                        - tel3
                        - cel1
                        - cel2
                        - cel3
                        - endereco
                        - numero
                        - compl
                        - cep
                        - bairro
                        - cidade
                        - uf
                      required:
                        - cpf
                        - nome
                  empresas:
                    type: array
                    items:
                      type: object
                      properties:
                        cpf:
                          type: string
                        cnpj:
                          type: string
                        nm:
                          type: string
                        cargo:
                          type: string
                        entrada:
                          type: string
                        part:
                          type: string
                        email:
                          type: string
                        email2:
                          type: string
                        nrodoc:
                          type: string
                        tipo:
                          type: string
                        cel1:
                          type: string
                        cel2:
                          type: string
                        cnae:
                          type: string
                        cnae_desc:
                          type: string
                      x-apidog-orders:
                        - cpf
                        - cnpj
                        - nm
                        - cargo
                        - entrada
                        - part
                        - email
                        - email2
                        - nrodoc
                        - tipo
                        - cel1
                        - cel2
                        - cnae
                        - cnae_desc
                  status:
                    type: string
                  msgRetorno:
                    type: string
                  response:
                    type: string
                  code:
                    type: integer
                  credits:
                    type: integer
                required:
                  - pf
                  - credits
                  - code
                  - msgRetorno
                  - response
                  - status
                x-apidog-orders:
                  - pf
                  - empresas
                  - status
                  - msgRetorno
                  - response
                  - code
                  - credits
              example:
                pf:
                  - cpf: '17701100890'
                    nome: ROGERIO MIRANDA ZANON
                    mae: HELENA MIRANDA ZANON
                    sexo: M
                    dn: 21/08/1975
                    obito: ''
                    idade: '50'
                    score: '998'
                    frisco: ''
                    frenda: Maior 8000
                    classe: A
                    escolaridade: MEDIO COMPLETO
                    email: rzanon@allnet.com.br
                    email2: ''
                    linkedin_pessoa: >-
                      https://br.linkedin.com/in/rog%C3%A9rio-miranda-zanon-09b63446
                    ddd: '11'
                    tel1: '1136821775'
                    tel2: ''
                    tel3: ''
                    cel1: '11983592143'
                    cel2: ''
                    cel3: ''
                    endereco: RUA ACUCENA
                    numero: '1060'
                    compl: ''
                    cep: '06110160'
                    bairro: JARDIM DAS FLORES
                    cidade: OSASCO
                    uf: SP
                empresas:
                  - cpf: '17701100890'
                    cnpj: '44724205000195'
                    nm: ROGERIO MIRANDA ZANON 17701100890
                    cargo: TITULAR PESSOA FISICA RESIDENTE OU DOMICILIADO NO BRASIL
                    entrada: ''
                    part: '0'
                    email: ''
                    email2: ''
                    nrodoc: ''
                    tipo: '2'
                    cel1: ''
                    cel2: ''
                    cnae: '5819100'
                    cnae_desc: EDICAO DE CADASTROS, LISTAS E OUTROS PRODUTOS GRAFICOS
                  - cpf: '17701100890'
                    cnpj: '65698235000144'
                    nm: VIP-SYSTEMS TECNOLOGIA & INOVACAO LTDA
                    cargo: GERENTE DE DESENVOLVIMENTO DE SISTEMAS
                    entrada: ''
                    part: '0'
                    email: ''
                    email2: ''
                    nrodoc: ''
                    tipo: '1'
                    cel1: ''
                    cel2: ''
                    cnae: '6202300'
                    cnae_desc: >-
                      DESENVOLVIMENTO E LICENCIAMENTO DE PROGRAMAS DE COMPUTADOR
                      CUSTOMIZAVEIS
                status: OK
                msgRetorno: Consulta PF CPF
                response: Liberado
                code: 1
                credits: 100
          headers: {}
          x-apidog-name: Success
      security:
        - apikey-header-x-api-key: []
      x-apidog-folder: API_BASICA
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/826671/apis/api-14372750-run
components:
  schemas: {}
  securitySchemes:
    apikey-header-x-api-key:
      type: apiKey
      in: header
      name: x-api-key
servers: []
security:
  - apikey-header-x-api-key: []

```