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

# Localização por nome

> Localiza a pessoa pelo **nome completo, nome da mãe e data de nascimento** — os três obrigatórios — e devolve os dados cadastrais do CPF encontrado: CPF, nome, nome da mãe, data de nascimento, sexo, telefones, e-mails e endereços.

É a única consulta da API sem o campo `document`: a entrada é a pessoa, e o CPF vem na resposta. O output tem o mesmo formato de `dados-pessoais`.



## OpenAPI

````yaml /openapi/legado.json post /api/consultas/localizacao-por-nome
openapi: 3.0.0
info:
  title: Calculadoras Jusfy API
  description: >-
    Rotas sem versão (`/api/...`). Continuam funcionando, mas a versão atual

    da API é a v1 (`/api/v1`): para integrações novas, use a v1 e siga o [guia
    de
    migração](https://api.jusfy.dev/calculators/api/reference/fundamentos/migracao-do-legado).


    A política de versionamento e depreciação está na [política de
    versionamento](https://api.jusfy.dev/calculators/api/reference/fundamentos/migracao-do-legado#pol%C3%ADtica-de-versionamento).
  version: legacy
  contact: {}
servers:
  - url: https://api.jusfy.dev/calculators
security: []
tags:
  - name: Calculadoras
    description: >-
      Execução das calculadoras jurídicas e consulta dos índices de correção.
      Cada cálculo recebe um payload, retorna o resultado processado e exige API
      key no header `x-api-key`.
  - name: Consultas
    description: >-
      Consultas de dados (veículos, condutores e documentos). Cada consulta
      recebe o documento, retorna os dados encontrados e exige API key no header
      `x-api-key`. A maioria responde na mesma requisição; o **rastreamento
      veicular** e o **buscador processual** são assíncronos — devolvem `202`
      com um protocolo e entregam o resultado por webhook e/ou pelo `GET` do
      protocolo.
  - name: JusScore
    description: >-
      Consulta de processos judiciais por CPF/CNPJ, com score de risco
      consolidado e a lista detalhada dos processos. É assíncrona: o POST inicia
      a consulta e o GET devolve o resultado quando pronto. Exige API key no
      header `x-api-key`.
  - name: Consumo
    description: >-
      Consumo da própria API key: quantas chamadas cada produto recebeu num
      período, separando as cobradas das não cobradas. Não exige escopo; exige
      API key no header `x-api-key`.
  - name: Health
    description: >-
      Verificações de disponibilidade do serviço (liveness e readiness). Rotas
      abertas, sem autenticação.
paths:
  /api/consultas/localizacao-por-nome:
    post:
      tags:
        - Consultas
      summary: Localização por nome
      description: >-
        Localiza a pessoa pelo **nome completo, nome da mãe e data de
        nascimento** — os três obrigatórios — e devolve os dados cadastrais do
        CPF encontrado: CPF, nome, nome da mãe, data de nascimento, sexo,
        telefones, e-mails e endereços.


        É a única consulta da API sem o campo `document`: a entrada é a pessoa,
        e o CPF vem na resposta. O output tem o mesmo formato de
        `dados-pessoais`.
      operationId: QueriesController_localizacaoPorNome[0]
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NameSearchQueryDto'
      responses:
        '200':
          description: >-
            Dados cadastrais da pessoa encontrada, no formato de
            `dados-pessoais`. `document` é o CPF dela. Quando a base cadastral
            não tem o CPF, saem só os dados da busca (nome, mãe e nascimento),
            com `gender` `null` e as três listas vazias. Os textos vêm em CAIXA
            ALTA.
          content:
            application/json:
              schema:
                type: object
                example:
                  statusCode: 200
                  message: Consulta concluída com sucesso
                  timestamp: '2026-07-28T18:00:00.000Z'
                  path: /api/consultas/localizacao-por-nome
                  result:
                    document: '52998224725'
                    name: MARIA DE SOUZA
                    motherName: ANA DE SOUZA
                    birthDate: '1990-02-01'
                    gender: F
                    phones:
                      - areaCode: '11'
                        number: '999999999'
                        formatted: (11) 99999-9999
                        type: MOBILE
                    emails:
                      - maria.souza@email.com
                    addresses:
                      - street: RUA DAS FLORES, 100
                        neighborhood: CENTRO
                        city: SAO PAULO
                        state: SP
                        zipCode: 01234-567
                        formatted: >-
                          RUA DAS FLORES, 100, CENTRO, SAO PAULO - SP, CEP
                          01234-567
        '400':
          description: >-
            Entrada inválida. `message` é a **lista** de erros de validação
            desta API (campo + motivo), diferente dos demais erros, em que é uma
            string.
          content:
            application/json:
              schema:
                example:
                  statusCode: 400
                  code: invalid_request
                  message:
                    - birthDate deve estar no formato AAAA-MM-DD
                  requestId: 9f1c2b7e-4d3a-4f8b-a6e2-1c0d9e8f7a65
                  timestamp: '2026-07-28T18:00:00.000Z'
                  path: /api/consultas/localizacao-por-nome
        '401':
          description: >-
            API key ausente ou que não pertence a nenhum cliente (`code:
            invalid_api_key`). A `message` diz qual dos dois.
          content:
            application/json:
              examples:
                missing:
                  summary: Key ausente
                  value:
                    statusCode: 401
                    message: Missing API key
                    code: invalid_api_key
                    requestId: 9f1c2b7e-4d3a-4f8b-a6e2-1c0d9e8f7a65
                    timestamp: '2026-10-14T18:00:00.000Z'
                    path: /api/consultas/{consulta}
                invalid:
                  summary: Key inválida
                  value:
                    statusCode: 401
                    message: Invalid API key
                    code: invalid_api_key
                    requestId: 9f1c2b7e-4d3a-4f8b-a6e2-1c0d9e8f7a65
                    timestamp: '2026-10-14T18:00:00.000Z'
                    path: /api/consultas/{consulta}
        '403':
          description: >-
            Acesso negado. Dois motivos, distinguidos pelo `code`: o cliente não
            está ativo (`inactive_client`), ou a API key não tem o escopo deste
            produto (`insufficient_scope`, com o escopo na `message`). A
            liberação de produtos é feita pela equipe Jusfy.
          content:
            application/json:
              examples:
                inactive_client:
                  summary: Cliente não ativo
                  value:
                    statusCode: 403
                    message: Client is not active
                    code: inactive_client
                    requestId: 9f1c2b7e-4d3a-4f8b-a6e2-1c0d9e8f7a65
                    timestamp: '2026-10-14T18:00:00.000Z'
                    path: /api/consultas/{consulta}
                insufficient_scope:
                  summary: Sem o escopo do produto
                  value:
                    statusCode: 403
                    message: 'Missing scope: <escopo>'
                    code: insufficient_scope
                    requestId: 9f1c2b7e-4d3a-4f8b-a6e2-1c0d9e8f7a65
                    timestamp: '2026-10-14T18:00:00.000Z'
                    path: /api/consultas/{consulta}
        '404':
          description: >-
            Nenhuma pessoa identificada com os dados informados. A mesma
            resposta vale para ninguém encontrado, mais de uma pessoa possível e
            documento protegido: a mensagem única é proposital, para não revelar
            se existe alguém com aqueles dados. A consulta foi executada e conta
            como consumo.
          content:
            application/json:
              schema:
                example:
                  statusCode: 404
                  code: no_data_found
                  message: Nenhuma pessoa encontrada para os dados informados.
                  requestId: 9f1c2b7e-4d3a-4f8b-a6e2-1c0d9e8f7a65
                  timestamp: '2026-07-28T18:00:00.000Z'
                  path: /api/consultas/localizacao-por-nome
        '422':
          description: >-
            Dados recusados pelo backend antes da busca — por exemplo, data de
            nascimento futura ou anterior a 1900, ou nome que só fica completo
            com preposições (`Maria da`). Não conta como consumo.
          content:
            application/json:
              schema:
                example:
                  statusCode: 422
                  code: payload_rejected
                  message: 'Data de nascimento não pode ser futura (property: birthDate)'
                  requestId: 9f1c2b7e-4d3a-4f8b-a6e2-1c0d9e8f7a65
                  timestamp: '2026-07-28T18:00:00.000Z'
                  path: /api/consultas/localizacao-por-nome
        '429':
          description: >-
            Limite de requisições por minuto do cliente neste produto excedido.
            `Retry-After` diz em quantos segundos a janela vira. Toda resposta
            traz `X-RateLimit-Limit`, `X-RateLimit-Remaining` e
            `X-RateLimit-Reset`.
          content:
            application/json:
              schema:
                example:
                  statusCode: 429
                  code: rate_limit_exceeded
                  message: >-
                    Rate limit exceeded for consultas.cnh:execute: 60 requests
                    per minute. Retry in 42s.
                  requestId: 9f1c2b7e-4d3a-4f8b-a6e2-1c0d9e8f7a65
                  timestamp: '2026-06-22T18:00:00.000Z'
                  path: /api/consultas/cnh
        '502':
          description: >-
            Erro no provedor da consulta. `message` identifica o provedor que
            falhou quando essa informação está disponível. Diferente do `503`,
            não há garantia de que repetir a consulta resolva.
          content:
            application/json:
              schema:
                example:
                  statusCode: 502
                  code: upstream_error
                  message: Erro ao consultar os dados pessoais da pessoa encontrada.
                  requestId: 9f1c2b7e-4d3a-4f8b-a6e2-1c0d9e8f7a65
                  timestamp: '2026-07-28T18:00:00.000Z'
                  path: /api/consultas/localizacao-por-nome
        '503':
          description: >-
            Base de busca por nome temporariamente indisponível. A consulta
            **não** foi executada — pode ser repetida.
          content:
            application/json:
              schema:
                example:
                  statusCode: 503
                  code: upstream_unavailable
                  message: >-
                    Não foi possível realizar a consulta por nome agora. Tente
                    novamente em instantes.
                  requestId: 9f1c2b7e-4d3a-4f8b-a6e2-1c0d9e8f7a65
                  timestamp: '2026-07-28T18:00:00.000Z'
                  path: /api/consultas/localizacao-por-nome
        '504':
          description: Tempo limite ao falar com o provedor da consulta.
          content:
            application/json:
              schema:
                example:
                  statusCode: 504
                  code: upstream_timeout
                  message: Query provider timed out
                  requestId: 9f1c2b7e-4d3a-4f8b-a6e2-1c0d9e8f7a65
                  timestamp: '2026-07-28T18:00:00.000Z'
                  path: /api/consultas/localizacao-por-nome
      security:
        - api-key: []
components:
  schemas:
    NameSearchQueryDto:
      type: object
      properties:
        name:
          type: string
          description: >-
            Nome completo da pessoa procurada, com acentos ou sem. Espaços
            repetidos são ignorados.
          example: Maria de Souza
          maxLength: 150
        motherName:
          type: string
          description: Nome completo da mãe, nas mesmas regras de `name`.
          example: Ana de Souza
          maxLength: 150
        birthDate:
          type: string
          description: Data de nascimento no formato `AAAA-MM-DD`.
          example: '1990-02-01'
          format: date
      required:
        - name
        - motherName
        - birthDate
  securitySchemes:
    api-key:
      type: apiKey
      in: header
      name: x-api-key

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.